Class Auth_OpenID_AX_FetchRequest

An attribute exchange 'fetch_request' message. This message is sent by a relying party when it wishes to obtain attributes about the subject of an OpenID authentication request.

Auth_OpenID_Extension

Extended by

Auth_OpenID_AX_Message

Extended by

Auth_OpenID_AX_FetchRequest

Package: OpenID
Located at zp-extensions/federated_logon/Auth/OpenID/AX.php

Methods summary
`public`	# `Auth_OpenID_AX_FetchRequest( $update_url = null )`
`public true`	# `add( attribute: $attribute )` Add an attribute to this attribute exchange request. Add an attribute to this attribute exchange request. Parameters `$attribute` attribute that is being requested Returns true on success, false when the requested attribute is already present in this fetch request.
`public Auth_OpenID_AX_FetchRequest`	# `getExtensionArgs( )` Get the serialized form of this attribute fetch request. Get the serialized form of this attribute fetch request. Returns `Auth_OpenID_AX_FetchRequest` The fetch request message parameters Overrides `Auth_OpenID_Extension::getExtensionArgs()`
`public A`	# `getRequiredAttrs( )` Get the type URIs for all attributes that have been marked as required. 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.
`public static`	# `fromOpenIDRequest( request: $request )` Extract a FetchRequest from an OpenID message Extract a FetchRequest from an OpenID message Parameters `$request` 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
`public`	# `parseExtensionArgs( $ax_args )` Given attribute exchange arguments, populate this FetchRequest. 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.
`public`	# `iterAttrs( )` Iterate over the AttrInfo objects that are contained in this fetch_request. Iterate over the AttrInfo objects that are contained in this fetch_request.
`public`	# `iterTypes( )`
`public`	# `contains( $type_uri )` Is the given type URI present in this fetch_request? Is the given type URI present in this fetch_request?

Methods inherited from Auth_OpenID_AX_Message
`_checkMode(), _newArgs()`

Methods inherited from Auth_OpenID_Extension
`toMessage()`

Properties summary
`public string`	`$mode` mode: The type of this attribute exchange message. This must be overridden in subclasses. mode: The type of this attribute exchange message. This must be overridden in subclasses.	# `'fetch_request'`

Properties inherited from Auth_OpenID_AX_Message
`$ns_alias, $ns_uri`