Auth_OpenID_SRegBase
extends Auth_OpenID_Extension
in package
A base class for classes dealing with Simple Registration protocol messages.
Table of Contents
- $ns_alias : mixed
- $ns_uri : mixed
- ns_uri: The namespace to which to add the arguments for this extension
- _getSRegNS() : mixed|null|string
- Extract the simple registration namespace URI from the given OpenID message. Handles OpenID 1 and 2, as well as both sreg namespace URIs found in the wild, as well as missing namespace definitions (for OpenID 1)
- 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
$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
Methods
_getSRegNS()
Extract the simple registration namespace URI from the given OpenID message. Handles OpenID 1 and 2, as well as both sreg namespace URIs found in the wild, as well as missing namespace definitions (for OpenID 1)
public
static _getSRegNS(Auth_OpenID_Message $message) : mixed|null|string
$message: The OpenID message from which to parse simple registration fields. This may be a request or response message.
Returns the sreg namespace URI for the supplied message. The message may be modified to define a simple registration namespace.
Parameters
- $message : Auth_OpenID_Message
Tags
Return values
mixed|null|string —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