Auth_OpenID_PAPE_Request
extends Auth_OpenID_Extension
in package
A Provider Authentication Policy request, sent from a relying party to a provider
preferred_auth_policies: The authentication policies that the relying party prefers
max_auth_age: The maximum time, in seconds, that the relying party wants to allow to have elapsed before the user must re-authenticate
Table of Contents
- $ns_alias : mixed
- $ns_uri : mixed
- ns_uri: The namespace to which to add the arguments for this extension
- $max_auth_age : mixed
- $preferred_auth_policies : mixed
- __construct() : mixed
- addPolicyURI() : mixed
- Add an acceptable authentication policy URI to this request
- fromOpenIDRequest() : Auth_OpenID_PAPE_Request|null
- Instantiate a Request object from the arguments in a checkid_* OpenID message
- getExtensionArgs() : null
- Get the string arguments that should be added to an OpenID message for this extension.
- parseExtensionArgs() : mixed
- Set the state of this request to be that expressed in these PAPE arguments
- preferredTypes() : array<string|int, mixed>
- Given a list of authentication policy URIs that a provider supports, this method returns the subsequence of those types that are preferred by the relying party.
- toMessage() : null
- Add the arguments from this extension to the provided message.
Properties
$ns_alias
public
mixed
$ns_alias
= 'pape'
$ns_uri
ns_uri: The namespace to which to add the arguments for this extension
public
mixed
$ns_uri
= \Auth_OpenID_PAPE_NS_URI
$max_auth_age
private
mixed
$max_auth_age
= 0
$preferred_auth_policies
private
mixed
$preferred_auth_policies
= []
Methods
__construct()
public
__construct([mixed $preferred_auth_policies = null ][, mixed $max_auth_age = null ]) : mixed
Parameters
- $preferred_auth_policies : mixed = null
- $max_auth_age : mixed = null
Return values
mixed —addPolicyURI()
Add an acceptable authentication policy URI to this request
public
addPolicyURI(string $policy_uri) : mixed
This method is intended to be used by the relying party to add acceptable authentication types to the request.
policy_uri: The identifier for the preferred type of authentication.
Parameters
- $policy_uri : string
Return values
mixed —fromOpenIDRequest()
Instantiate a Request object from the arguments in a checkid_* OpenID message
public
static fromOpenIDRequest(Auth_OpenID_Request $request) : Auth_OpenID_PAPE_Request|null
Parameters
- $request : Auth_OpenID_Request
Return values
Auth_OpenID_PAPE_Request|null —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 —parseExtensionArgs()
Set the state of this request to be that expressed in these PAPE arguments
public
parseExtensionArgs(mixed $args) : mixed
Parameters
- $args : mixed
Return values
mixed —preferredTypes()
Given a list of authentication policy URIs that a provider supports, this method returns the subsequence of those types that are preferred by the relying party.
public
preferredTypes(mixed $supported_types) : array<string|int, mixed>
Parameters
- $supported_types : mixed
Return values
array<string|int, mixed> —The sub-sequence of the supported types that are preferred by the relying party. This list will be ordered in the order that the types appear in the supported_types sequence, and may be empty if the provider does not prefer any of the supported authentication types.
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