[ class tree: OpenID ] [ index: OpenID ] [ all elements ]

Class: Auth_OpenID_AX_FetchRequest

Source Location: /zp-extensions/federated_logon/Auth/OpenID/AX.php

Class Auth_OpenID_AX_FetchRequest

Class Overview

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 /zp-extensions/federated_logon/Auth/OpenID/AX.php [line 268]

Auth_OpenID_Extension
   |
   --Auth_OpenID_AX_Message
      |
      --Auth_OpenID_AX_FetchRequest

Properties

Methods

[ Top ]
Inherited Properties, Constants, and Methods
Inherited Properties Inherited Methods Inherited Constants

Inherited From Auth_OpenID_AX_Message

Auth_OpenID_AX_Message::$ns_alias
Auth_OpenID_AX_Message::$ns_uri

Inherited From Auth_OpenID_Extension

Auth_OpenID_Extension::getExtensionArgs()
Get the string arguments that should be added to an OpenID message for this extension.
Auth_OpenID_Extension::toMessage()
Add the arguments from this extension to the provided message.

[ Top ]
Property Summary
mixed   $mode  

[ Top ]
Method Summary
static mixed   fromOpenIDRequest()   Extract a FetchRequest from an OpenID message
Auth_OpenID_AX_FetchRequest   Auth_OpenID_AX_FetchRequest()  
true   add()   Add an attribute to this attribute exchange request.
void   contains()   Is the given type URI present in this fetch_request?
Auth_OpenID_AX_FetchRequest   getExtensionArgs()   Get the serialized form of this attribute fetch request.
A   getRequiredAttrs()   Get the type URIs for all attributes that have been marked as required.
void   iterAttrs()   Iterate over the AttrInfo objects that are contained in this fetch_request.
void   iterTypes()  
$result   parseExtensionArgs()   Given attribute exchange arguments, populate this FetchRequest.

[ Top ]
Properties
mixed   $mode = 'fetch_request' [line 270]

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

[ Top ]
Methods
static method fromOpenIDRequest  [line 389]

  static mixed fromOpenIDRequest( request: $request  )

Extract a FetchRequest from an OpenID message

Parameters:
request:   $request:  The OpenID request containing the attribute fetch request

API Tags:
Return:  An Auth_OpenID_AX_Error or the Auth_OpenID_AX_FetchRequest extracted from the request message if successful


[ Top ]
Constructor Auth_OpenID_AX_FetchRequest  [line 272]

  Auth_OpenID_AX_FetchRequest Auth_OpenID_AX_FetchRequest( [ $update_url = null]  )

Parameters:
   $update_url: 


[ Top ]
add  [line 295]

  true add( attribute: $attribute  )

Add an attribute to this attribute exchange request.

Parameters:
attribute:   $attribute:  The attribute that is being requested

API Tags:
Return:  on success, false when the requested attribute is already present in this fetch request.


[ Top ]
contains  [line 528]

  void contains( $type_uri  )

Is the given type URI present in this fetch_request?

Parameters:
   $type_uri: 


[ Top ]
getExtensionArgs  [line 313]

  Auth_OpenID_AX_FetchRequest getExtensionArgs( )

Get the serialized form of this attribute fetch request.


API Tags:
Return:  The fetch request message parameters


Redefinition of:
Auth_OpenID_Extension::getExtensionArgs()
Get the string arguments that should be added to an OpenID message for this extension.

[ Top ]
getRequiredAttrs  [line 367]

  A getRequiredAttrs( )

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


API Tags:
Return:  list of the type URIs for attributes that have been marked as required.


[ Top ]
iterAttrs  [line 515]

  void iterAttrs( )

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



[ Top ]
iterTypes  [line 520]

  void iterTypes( )



[ Top ]
parseExtensionArgs  [line 432]

  $result parseExtensionArgs( $ax_args  )

Given attribute exchange arguments, populate this FetchRequest.

Parameters:
   $ax_args: 

API Tags:
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.


[ Top ]

Documentation generated on Sat, 05 Jan 2013 15:50:59 +0100 by phpDocumentor 1.4.3