Auth_OpenID_AX_Message Class Reference

Inheritance diagram for Auth_OpenID_AX_Message:

Collaboration diagram for Auth_OpenID_AX_Message:

Public Member Functions
	_checkMode ($ax_args)
	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 ()
	Return a set of attribute exchange arguments containing the basic information that must be in every attribute exchange message.
Public Member Functions inherited from Auth_OpenID_Extension
	getExtensionArgs ()
	Get the string arguments that should be added to an OpenID message for this extension.
	toMessage ($message)
	Add the arguments from this extension to the provided message.

Data Fields
	$ns_alias = 'ax'
	ns_alias: The preferred namespace alias for attribute exchange messages
	$mode = null
	mode: The type of this attribute exchange message.
	$ns_uri = Auth_OpenID_AX_NS_URI
Data Fields inherited from Auth_OpenID_Extension
	$ns_uri = null
	ns_uri: The namespace to which to add the arguments for this extension
	$ns_alias = null

Detailed Description

Definition at line 83 of file AX.php.

Member Function Documentation

Auth_OpenID_AX_Message::_checkMode

(

$ax_args

)

Return Auth_OpenID_AX_Error if the mode in the attribute exchange arguments does not match what is expected for this class; true otherwise.

private

Definition at line 105 of file AX.php.

    {
        $mode = Auth_OpenID::arrayGet($ax_args, 'mode');
        if ($mode != $this->mode) {
            return new Auth_OpenID_AX_Error(
                            sprintf(
                                    "Expected mode '%s'; got '%s'",
                                    $this->mode, $mode));
        }

        return true;

Auth_OpenID_AX_Message::_newArgs

(

)

Return a set of attribute exchange arguments containing the basic information that must be in every attribute exchange message.

private

Definition at line 125 of file AX.php.

Referenced by Auth_OpenID_AX_StoreResponse\getExtensionArgs().

    {
        return array('mode' => $this->mode);

Here is the caller graph for this function:

Field Documentation

Auth_OpenID_AX_Message::$mode = null

mode: The type of this attribute exchange message.

This must be overridden in subclasses.

Definition at line 94 of file AX.php.

Auth_OpenID_AX_Message::$ns_alias = 'ax'

ns_alias: The preferred namespace alias for attribute exchange messages

Definition at line 88 of file AX.php.

Auth_OpenID_AX_Message::$ns_uri = Auth_OpenID_AX_NS_URI

Definition at line 96 of file AX.php.

---

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

• Services/OpenId/lib/Auth/OpenID/AX.php