Auth_OpenID_PAPE_Response
extends Auth_OpenID_Extension
in package
A Provider Authentication Policy response, sent from a provider to a relying party
Table of Contents
- $ns_alias : mixed
- $ns_uri : mixed
- ns_uri: The namespace to which to add the arguments for this extension
- $auth_policies : mixed
- $auth_time : mixed
- $nist_auth_level : mixed
- __construct() : mixed
- addPolicyURI() : mixed
- Add a authentication policy to this response
- fromSuccessResponse() : Auth_OpenID_PAPE_Response
- Create an Auth_OpenID_PAPE_Response object from a successful OpenID library response.
- getExtensionArgs() : null
- Get the string arguments that should be added to an OpenID message for this extension.
- parseExtensionArgs() : null|bool
- Parse the provider authentication policy arguments into the internal state of this object
- 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
$auth_policies
private
mixed
$auth_policies
= []
$auth_time
private
mixed
$auth_time
= 0
$nist_auth_level
private
mixed
$nist_auth_level
= 0
Methods
__construct()
public
__construct([mixed $auth_policies = null ][, mixed $auth_time = null ][, mixed $nist_auth_level = null ]) : mixed
Parameters
- $auth_policies : mixed = null
- $auth_time : mixed = null
- $nist_auth_level : mixed = null
Return values
mixed —addPolicyURI()
Add a authentication policy to this response
public
addPolicyURI(mixed $policy_uri) : mixed
This method is intended to be used by the provider to add a policy that the provider conformed to when authenticating the user.
Parameters
- $policy_uri : mixed
Return values
mixed —fromSuccessResponse()
Create an Auth_OpenID_PAPE_Response object from a successful OpenID library response.
public
static fromSuccessResponse(Auth_OpenID_SuccessResponse $success_response) : Auth_OpenID_PAPE_Response
Parameters
- $success_response : Auth_OpenID_SuccessResponse
-
A SuccessResponse from Auth_OpenID_Consumer::complete()
Return values
Auth_OpenID_PAPE_Response —A provider authentication policy response from the data that was supplied with the id_res response.
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()
Parse the provider authentication policy arguments into the internal state of this object
public
parseExtensionArgs(array<string|int, mixed> $args[, bool $strict = false ]) : null|bool
Parameters
- $args : array<string|int, mixed>
-
unqualified provider authentication policy arguments
- $strict : bool = false
-
Whether to return false when bad data is encountered
Return values
null|bool —The data is parsed into the internal fields of this object.
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