Inheritance diagram for Auth_OpenID_AX_FetchRequest:

Public Member Functions
	Auth_OpenID_AX_FetchRequest ($update_url=null)

	add ($attribute)

	getExtensionArgs ()

	getRequiredAttrs ()

	parseExtensionArgs ($ax_args)

	iterAttrs ()

	iterTypes ()

	contains ($type_uri)

Public Member Functions inherited from Auth_OpenID_AX_Message
	_checkMode ($ax_args)

	_newArgs ()

Public Member Functions inherited from Auth_OpenID_Extension
	getExtensionArgs ()

	toMessage ($message, $request=null)

Static Public Member Functions
static	fromOpenIDRequest ($request)

Public Attributes
	$mode = 'fetch_request'

Public Attributes inherited from Auth_OpenID_AX_Message
	$ns_alias = 'ax'

	$mode = null

	$ns_uri = Auth_OpenID_AX_NS_URI

Public Attributes inherited from Auth_OpenID_Extension
	$ns_uri = null

	$ns_alias = null

Detailed Description

Definition at line 267 of file AX.php.

Member Function Documentation

◆ add()

Auth_OpenID_AX_FetchRequest::add ( $attribute )

Add an attribute to this attribute exchange request.

Parameters

attribute The attribute that is being requested

Returns: true on success, false when the requested attribute is already present in this fetch request.

Definition at line 294 of file AX.php.

◆ Auth_OpenID_AX_FetchRequest()

Auth_OpenID_AX_FetchRequest::Auth_OpenID_AX_FetchRequest ( $update_url = null )

requested_attributes: The attributes that have been requested thus far, indexed by the type URI.

update_url: A URL that will accept responses for this attribute exchange request, even in the absence of the user who made this request.

Definition at line 271 of file AX.php.

References $result, Auth_OpenID\arrayGet(), Auth_OpenID_AX_toTypeURIs(), Auth_OpenID_AX_UNLIMITED_VALUES, Auth_OpenID_OPENID_NS, Auth_OpenID\intval(), Auth_OpenID_AX\isError(), Auth_OpenID_AX_AttrInfo\make(), and Auth_OpenID_TrustRoot\match().

◆ contains()

Auth_OpenID_AX_FetchRequest::contains ( $type_uri )

Is the given type URI present in this fetch_request?

Definition at line 527 of file AX.php.

◆ fromOpenIDRequest()

static Auth_OpenID_AX_FetchRequest::fromOpenIDRequest ( $request )

static

Extract a FetchRequest from an OpenID message

Parameters

request The OpenID request containing the attribute fetch request

Returns: mixed An Auth_OpenID_AX_Error or the Auth_OpenID_AX_FetchRequest extracted from the request message if successful

Definition at line 388 of file AX.php.

◆ getExtensionArgs()

Auth_OpenID_AX_FetchRequest::getExtensionArgs ( )

Get the serialized form of this attribute fetch request.

Returns: Auth_OpenID_AX_FetchRequest The fetch request message parameters

Definition at line 312 of file AX.php.

◆ getRequiredAttrs()

Auth_OpenID_AX_FetchRequest::getRequiredAttrs ( )

Get the type URIs for all attributes that have been marked as required.

Returns: A list of the type URIs for attributes that have been marked as required.

Definition at line 366 of file AX.php.

◆ iterAttrs()

Auth_OpenID_AX_FetchRequest::iterAttrs ( )

Iterate over the AttrInfo objects that are contained in this fetch_request.

Definition at line 514 of file AX.php.

◆ iterTypes()

Auth_OpenID_AX_FetchRequest::iterTypes ( )

Definition at line 519 of file AX.php.

◆ parseExtensionArgs()

Auth_OpenID_AX_FetchRequest::parseExtensionArgs ( $ax_args )

Given attribute exchange arguments, populate this FetchRequest.

Returns: $result Auth_OpenID_AX_Error if the data to be parsed does not follow the attribute exchange specification. At least when 'if_available' or 'required' is not specified for a particular attribute type. Returns true otherwise.

Definition at line 431 of file AX.php.

Member Data Documentation

◆ $mode

Auth_OpenID_AX_FetchRequest::$mode = 'fetch_request'

Definition at line 269 of file AX.php.

Public Member Functions

Static Public Member Functions

Public Attributes