Auth_OpenID_AX_StoreResponse
extends Auth_OpenID_AX_Message
in package
An indication that the store request was processed along with this OpenID transaction. Use make(), NOT the constructor, to create response objects.
Table of Contents
- $FAILURE_MODE : mixed
- $mode : mixed
- mode: The type of this attribute exchange message. This must be overridden in subclasses.
- $ns_alias : mixed
- $ns_uri : mixed
- ns_uri: The namespace to which to add the arguments for this extension
- $SUCCESS_MODE : mixed
- $error_message : string
- __construct() : mixed
- _checkMode() : Auth_OpenID_AX_Error|bool
- 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() : mixed
- Return a set of attribute exchange arguments containing the basic information that must be in every attribute exchange message.
- getExtensionArgs() : null
- Get the string arguments that should be added to an OpenID message for this extension.
- make() : Auth_OpenID_AX_Error|Auth_OpenID_AX_StoreResponse
- succeeded() : mixed
- Was this response a success response?
- toMessage() : null
- Add the arguments from this extension to the provided message.
Properties
$FAILURE_MODE
public
mixed
$FAILURE_MODE
= 'store_response_failure'
$mode
mode: The type of this attribute exchange message. This must be overridden in subclasses.
public
mixed
$mode
= \null
$ns_alias
public
mixed
$ns_alias
= \null
$ns_uri
ns_uri: The namespace to which to add the arguments for this extension
public
mixed
$ns_uri
= \null
$SUCCESS_MODE
public
mixed
$SUCCESS_MODE
= 'store_response_success'
$error_message
private
string
$error_message
= ''
Methods
__construct()
public
__construct([mixed $succeeded = true ][, mixed $error_message = null ]) : mixed
Parameters
- $succeeded : mixed = true
- $error_message : mixed = null
Return values
mixed —_checkMode()
Return Auth_OpenID_AX_Error if the mode in the attribute exchange arguments does not match what is expected for this class; true otherwise.
public
_checkMode(array<string|int, mixed> $ax_args) : Auth_OpenID_AX_Error|bool
Parameters
- $ax_args : array<string|int, mixed>
Tags
Return values
Auth_OpenID_AX_Error|bool —_newArgs()
Return a set of attribute exchange arguments containing the basic information that must be in every attribute exchange message.
public
_newArgs() : mixed
Tags
Return values
mixed —getExtensionArgs()
Get the string arguments that should be added to an OpenID message for this extension.
public
getExtensionArgs([Auth_OpenID_Request|null $request = null ]) : null
Parameters
- $request : Auth_OpenID_Request|null = null
Return values
null —make()
public
make([bool $succeeded = true ][, string $error_message = null ]) : Auth_OpenID_AX_Error|Auth_OpenID_AX_StoreResponse
Parameters
- $succeeded : bool = true
- $error_message : string = null
Return values
Auth_OpenID_AX_Error|Auth_OpenID_AX_StoreResponse —succeeded()
Was this response a success response?
public
succeeded() : mixed
Return values
mixed —toMessage()
Add the arguments from this extension to the provided message.
public
toMessage(Auth_OpenID_Message $message[, Auth_OpenID_Request $request = null ]) : null
Returns the message with the extension arguments added.
Parameters
- $message : Auth_OpenID_Message
- $request : Auth_OpenID_Request = null