Auth_OpenID_AX_FetchRequest Class Reference

Inheritance diagram for Auth_OpenID_AX_FetchRequest:

[legend]

Collaboration diagram for Auth_OpenID_AX_FetchRequest:

[legend]

List of all members.

---

Detailed Description

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.

Definition at line 267 of file AX.php.

Public Member Functions
	Auth_OpenID_AX_FetchRequest ($update_url=null)
	add ($attribute)
	getExtensionArgs ()
	getRequiredAttrs ()
&	fromOpenIDRequest ($request)
	parseExtensionArgs ($ax_args)
	iterAttrs ()
	iterTypes ()
	contains ($type_uri)
Public Attributes
	$mode = 'fetch_request'

---

Member Function Documentation

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.

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.getExtensionArgs

(

)

Get the serialized form of this attribute fetch request.

Returns:

Auth_OpenID_AX_FetchRequest The fetch request message parameters

Reimplemented from Auth_OpenID_Extension.

Definition at line 312 of file AX.php.

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.

& Auth_OpenID_AX_FetchRequest.fromOpenIDRequest

(

$

request

)

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.

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.

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.

Auth_OpenID_AX_FetchRequest.iterTypes

(

)

Definition at line 519 of file AX.php.

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.

---

Member Data Documentation

Auth_OpenID_AX_FetchRequest.$mode = 'fetch_request'

mode: The type of this attribute exchange message. This must be overridden in subclasses.

Reimplemented from Auth_OpenID_AX_Message.

Definition at line 269 of file AX.php.

---

The documentation for this class was generated from the following file:

• core/openid/Auth/OpenID/AX.php