Auth_OpenID_AX_Message
extends Auth_OpenID_Extension
in package
Abstract class containing common code for attribute exchange messages.
Table of Contents
- $mode : mixed
- mode: The type of this attribute exchange message. This must be overridden in subclasses.
- $ns_alias : mixed
- ns_alias: The preferred namespace alias for attribute exchange messages
- $ns_uri : mixed
- ns_uri: The namespace to which to add the arguments for this extension
- _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.
- toMessage() : null
- Add the arguments from this extension to the provided message.
Properties
$mode
mode: The type of this attribute exchange message. This must be overridden in subclasses.
public
mixed
$mode
= \null
$ns_alias
ns_alias: The preferred namespace alias for attribute exchange messages
public
mixed
$ns_alias
= 'ax'
$ns_uri
ns_uri: The namespace to which to add the arguments for this extension
public
mixed
$ns_uri
= \Auth_OpenID_AX_NS_URI
Methods
_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 —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