Support Joomla!

Packages

Package: OpenID

License

Content on this site is copyright © 2005 - 2008 Open Source Matters Inc and can be used in accordance with the Joomla! Electronic Documentation License. Some parts of this website may be subject to other licenses.

Class Auth_OpenID_AX_FetchRequest

Description
Description | Variables (details) | Methods (details)

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.

Located in /openid/Auth/OpenID/AX.php (line 271) 

Class Auth_OpenID_Extension

Class Auth_OpenID_AX_Message
   
   Class Auth_OpenID_AX_FetchRequest
Variable Summary
Description | Variables (details) | Methods (details)
Variable mixed $mode
Method Summary
Description | Variables (details) | Methods (details)
Constructor Auth_OpenID_AX_FetchRequest Auth_OpenID_AX_FetchRequest ([ $update_url = null])
Method true add (attribute: $attribute)
Method void contains ( $type_uri)
Method mixed &fromOpenIDRequest (request: $request)
Method Auth_OpenID_AX_FetchRequest getExtensionArgs ()
Method A getRequiredAttrs ()
Method void iterAttrs ()
Method void iterTypes ()
Method $result parseExtensionArgs ( $ax_args)
Variables
Description | Variables (details) | Methods (details)
mixed $mode = 'fetch_request' (line 273)
Redefinition of:
Auth_OpenID_AX_Message::$mode
mode: The type of this attribute exchange message. This must be overridden in subclasses.

Inherited Variables

Inherited from Auth_OpenID_AX_Message

Variable Auth_OpenID_AX_Message::$ns_alias
 Variable Auth_OpenID_AX_Message::$ns_uri
Methods
Description | Variables (details) Methods (details)
Constructor Auth_OpenID_AX_FetchRequest (line 275)
Auth_OpenID_AX_FetchRequest Auth_OpenID_AX_FetchRequest ([ $update_url = null])
  • $update_url
add (line 298)

Add an attribute to this attribute exchange request.

  • return: on success, false when the requested attribute is already present in this fetch request.
true add (attribute: $attribute)
  • attribute: $attribute: The attribute that is being requested
contains (line 531)

Is the given type URI present in this fetch_request?

void contains ( $type_uri)
  • $type_uri
fromOpenIDRequest (line 392)

Extract a FetchRequest from an OpenID message

  • return: An Auth_OpenID_AX_Error or the Auth_OpenID_AX_FetchRequest extracted from the request message if successful
mixed &fromOpenIDRequest (request: $request)
  • request: $request: The OpenID request containing the attribute fetch request
getExtensionArgs (line 316)

Get the serialized form of this attribute fetch request.

  • return: The fetch request message parameters
Auth_OpenID_AX_FetchRequest getExtensionArgs ()
Redefinition of:
Auth_OpenID_Extension::getExtensionArgs()
Get the string arguments that should be added to an OpenID message for this extension.
getRequiredAttrs (line 370)

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

  • return: list of the type URIs for attributes that have been marked as required.
A getRequiredAttrs ()
iterAttrs (line 518)

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

void iterAttrs ()
iterTypes (line 523)
void iterTypes ()
parseExtensionArgs (line 435)

Given attribute exchange arguments, populate this FetchRequest.

  • return: 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.
$result parseExtensionArgs ( $ax_args)
  • $ax_args

Inherited Methods

Inherited From Auth_OpenID_Extension

Auth_OpenID_Extension::getExtensionArgs()
Auth_OpenID_Extension::toMessage()
Documentation generated on Sat, 14 Nov 2009 11:10:55 +0000 by phpDocumentor 1.3.1