[ Index ]

PHP Cross Reference of Joomla 1.5.26 DE

title

Body

[close]

/libraries/openid/Auth/OpenID/ -> AX.php (summary)

Implements the OpenID attribute exchange specification, version 1.0 as of svn revision 370 from openid.net svn.

File Size: 1026 lines (31 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 9 classes

Auth_OpenID_AX:: (2 methods):
  isError()
  Auth_OpenID_AX_checkAlias()

Auth_OpenID_AX_Error:: (1 method):
  Auth_OpenID_AX_Error()

Auth_OpenID_AX_Message:: (2 methods):
  _checkMode()
  _newArgs()

Auth_OpenID_AX_AttrInfo:: (4 methods):
  Auth_OpenID_AX_AttrInfo()
  make()
  wantsUnlimitedValues()
  Auth_OpenID_AX_toTypeURIs()

Auth_OpenID_AX_FetchRequest:: (9 methods):
  Auth_OpenID_AX_FetchRequest()
  add()
  getExtensionArgs()
  getRequiredAttrs()
  fromOpenIDRequest()
  parseExtensionArgs()
  iterAttrs()
  iterTypes()
  contains()

Auth_OpenID_AX_KeyValueMessage:: (8 methods):
  Auth_OpenID_AX_KeyValueMessage()
  addValue()
  setValues()
  _getExtensionKVArgs()
  parseExtensionArgs()
  getSingle()
  get()
  count()

Auth_OpenID_AX_FetchResponse:: (4 methods):
  Auth_OpenID_AX_FetchResponse()
  getExtensionArgs()
  parseExtensionArgs()
  fromSuccessResponse()

Auth_OpenID_AX_StoreRequest:: (1 method):
  getExtensionArgs()

Auth_OpenID_AX_StoreResponse:: (4 methods):
  make()
  Auth_OpenID_AX_StoreResponse()
  succeeded()
  getExtensionArgs()


Class: Auth_OpenID_AX  - X-Ref

AX utility class.

isError($thing)   X-Ref

param: mixed $thing Any object which may be an
return: bool true if $thing is an Auth_OpenID_AX_Error; false

Auth_OpenID_AX_checkAlias($alias)   X-Ref
Check an alias for invalid characters; raise AXError if any are
found.  Return None if the alias is valid.


Class: Auth_OpenID_AX_Error  - X-Ref

Results from data that does not meet the attribute exchange 1.0
specification

Auth_OpenID_AX_Error($message=null)   X-Ref
No description

Class: Auth_OpenID_AX_Message  - X-Ref

Abstract class containing common code for attribute exchange
messages.

_checkMode($ax_args)   X-Ref
Return Auth_OpenID_AX_Error if the mode in the attribute
exchange arguments does not match what is expected for this
class; true otherwise.


_newArgs()   X-Ref
Return a set of attribute exchange arguments containing the
basic information that must be in every attribute exchange
message.


Class: Auth_OpenID_AX_AttrInfo  - X-Ref

Represents a single attribute in an attribute exchange
request. This should be added to an AXRequest object in order to
request the attribute.

Auth_OpenID_AX_AttrInfo($type_uri, $count, $required,$alias)   X-Ref
Construct an attribute information object.  Do not call this
directly; call make(...) instead.

param: string $type_uri The type URI for this attribute.
param: int $count The number of values of this type to request.
param: bool $required Whether the attribute will be marked as
param: string $alias The name that should be given to this

make($type_uri, $count=1, $required=false,$alias=null)   X-Ref
Construct an attribute information object.  For parameter
details, see the constructor.


wantsUnlimitedValues()   X-Ref
When processing a request for this attribute, the OP should
call this method to determine whether all available attribute
values were requested.  If self.count == UNLIMITED_VALUES, this
returns True.  Otherwise this returns False, in which case
self.count is an integer.


Auth_OpenID_AX_toTypeURIs(&$namespace_map, $alias_list_s)   X-Ref
Given a namespace mapping and a string containing a comma-separated
list of namespace aliases, return a list of type URIs that
correspond to those aliases.

param: $namespace_map The mapping from namespace URI to alias
param: $alias_list_s The string containing the comma-separated
return: $seq The list of namespace URIs that corresponds to the

Class: Auth_OpenID_AX_FetchRequest  - X-Ref

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_AX_FetchRequest($update_url=null)   X-Ref
No description

add($attribute)   X-Ref
Add an attribute to this attribute exchange request.

param: attribute: The attribute that is being requested
return: true on success, false when the requested attribute is

getExtensionArgs()   X-Ref
Get the serialized form of this attribute fetch request.

returns: Auth_OpenID_AX_FetchRequest The fetch request message parameters

getRequiredAttrs()   X-Ref
Get the type URIs for all attributes that have been marked as
required.

return: A list of the type URIs for attributes that have been

fromOpenIDRequest($request)   X-Ref
Extract a FetchRequest from an OpenID message

returns: mixed An Auth_OpenID_AX_Error or the
param: request: The OpenID request containing the attribute

parseExtensionArgs($ax_args)   X-Ref
Given attribute exchange arguments, populate this FetchRequest.

return: $result Auth_OpenID_AX_Error if the data to be parsed

iterAttrs()   X-Ref
Iterate over the AttrInfo objects that are contained in this
fetch_request.


iterTypes()   X-Ref
No description

contains($type_uri)   X-Ref
Is the given type URI present in this fetch_request?


Class: Auth_OpenID_AX_KeyValueMessage  - X-Ref

An abstract class that implements a message that has attribute keys
and values. It contains the common code between fetch_response and
store_request.

Auth_OpenID_AX_KeyValueMessage()   X-Ref
No description

addValue($type_uri, $value)   X-Ref
Add a single value for the given attribute type to the
message. If there are already values specified for this type,
this value will be sent in addition to the values already
specified.

param: type_uri: The URI for the attribute
param: value: The value to add to the response to the relying
return: null

setValues($type_uri, &$values)   X-Ref
Set the values for the given attribute type. This replaces any
values that have already been set for this attribute.

param: type_uri: The URI for the attribute
param: values: A list of values to send for this attribute.

_getExtensionKVArgs(&$aliases)   X-Ref
Get the extension arguments for the key/value pairs contained
in this message.

param: aliases: An alias mapping. Set to None if you don't care

parseExtensionArgs($ax_args)   X-Ref
Parse attribute exchange key/value arguments into this object.

param: ax_args: The attribute exchange fetch_response
return: Auth_OpenID_AX_Error or true

getSingle($type_uri, $default=null)   X-Ref
Get a single value for an attribute. If no value was sent for
this attribute, use the supplied default. If there is more than
one value for this attribute, this method will fail.

param: type_uri: The URI for the attribute
param: default: The value to return if the attribute was not
return: $value Auth_OpenID_AX_Error on failure or the value of

get($type_uri)   X-Ref
Get the list of values for this attribute in the
fetch_response.

XXX: what to do if the values are not present? default
parameter? this is funny because it's always supposed to return
a list, so the default may break that, though it's provided by
the user's code, so it might be okay. If no default is
supplied, should the return be None or []?

param: type_uri: The URI of the attribute
return: $values The list of values for this attribute in the

count($type_uri)   X-Ref
Get the number of responses for a particular attribute in this
fetch_response message.

returns: int The number of values sent for this attribute.  If
param: type_uri: The URI of the attribute

Class: Auth_OpenID_AX_FetchResponse  - X-Ref

A fetch_response attribute exchange message.

Auth_OpenID_AX_FetchResponse($update_url=null)   X-Ref
No description

getExtensionArgs($request=null)   X-Ref
Serialize this object into arguments in the attribute exchange
namespace

return: $args The dictionary of unqualified attribute exchange

parseExtensionArgs($ax_args)   X-Ref

return: $result Auth_OpenID_AX_Error on failure or true on

fromSuccessResponse($success_response, $signed=true)   X-Ref
Construct a FetchResponse object from an OpenID library
SuccessResponse object.

param: success_response: A successful id_res response object
param: signed: Whether non-signed args should be processsed. If
return: $response A FetchResponse containing the data from the

Class: Auth_OpenID_AX_StoreRequest  - X-Ref

A store request attribute exchange message representation.

getExtensionArgs($aliases=null)   X-Ref

param: array $aliases The namespace aliases to use when making

Class: Auth_OpenID_AX_StoreResponse  - X-Ref

An indication that the store request was processed along with this
OpenID transaction.  Use make(), NOT the constructor, to create
response objects.

make($succeeded=true, $error_message=null)   X-Ref
Returns Auth_OpenID_AX_Error on error or an
Auth_OpenID_AX_StoreResponse object on success.


Auth_OpenID_AX_StoreResponse($succeeded=true, $error_message=null)   X-Ref
No description

succeeded()   X-Ref
Was this response a success response?


getExtensionArgs()   X-Ref
No description



Generated: Wed Mar 28 15:54:07 2012 Cross-referenced by PHPXref 0.7.1