Inheritance diagram for Auth_OpenID_AX_StoreResponse:

Collaboration diagram for Auth_OpenID_AX_StoreResponse:

Public Member Functions
	make ($succeeded=true, $error_message=null)
	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)
	succeeded ()
	Was this response a success response?
	getExtensionArgs ()
	Get the string arguments that should be added to an OpenID message for this extension.
Public Member Functions inherited from 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.
	_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
	toMessage ($message)
	Add the arguments from this extension to the provided message.

Data Fields
	$SUCCESS_MODE = 'store_response_success'
	$FAILURE_MODE = 'store_response_failure'
Data Fields inherited from Auth_OpenID_AX_Message
	$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 974 of file AX.php.

Member Function Documentation

Auth_OpenID_AX_StoreResponse::Auth_OpenID_AX_StoreResponse	(	$succeeded = `true`,
		$error_message = `null`
	)

Definition at line 992 of file AX.php.

References $FAILURE_MODE, and $SUCCESS_MODE.

    {
        if ($succeeded) {
            $this->mode = $this->SUCCESS_MODE;
        } else {
            $this->mode = $this->FAILURE_MODE;
        }
        $this->error_message = $error_message;

Auth_OpenID_AX_StoreResponse::getExtensionArgs ( )

Get the string arguments that should be added to an OpenID message for this extension.

Reimplemented from Auth_OpenID_Extension.

Definition at line 1011 of file AX.php.

References Auth_OpenID_AX_Message\_newArgs(), and succeeded().

    {
        $ax_args = $this->_newArgs();
        if ((!$this->succeeded()) && $this->error_message) {
            $ax_args['error'] = $this->error_message;
        }
        return $ax_args;

Here is the call graph for this function:

Auth_OpenID_AX_StoreResponse::make	(	$succeeded = `true`,
		$error_message = `null`
	)

Returns Auth_OpenID_AX_Error on error or an Auth_OpenID_AX_StoreResponse object on success.

Definition at line 982 of file AX.php.

    {
        if (($succeeded) && ($error_message !== null)) {
            return new Auth_OpenID_AX_Error('An error message may only be '.
                                    'included in a failing fetch response');
        }
        return new Auth_OpenID_AX_StoreResponse($succeeded, $error_message);