Inheritance diagram for Auth_OpenID_PAPE_Request:

Public Member Functions
	Auth_OpenID_PAPE_Request ($preferred_auth_policies=null, $max_auth_age=null)

	addPolicyURI ($policy_uri)

	getExtensionArgs ()

	parseExtensionArgs ($args)

	preferredTypes ($supported_types)

Public Member Functions inherited from Auth_OpenID_Extension
	getExtensionArgs ()

	toMessage ($message, $request=null)

Static Public Member Functions
static	fromOpenIDRequest ($request)

Public Attributes
	$ns_alias = 'pape'

	$ns_uri = Auth_OpenID_PAPE_NS_URI

Public Attributes inherited from Auth_OpenID_Extension
	$ns_uri = null

	$ns_alias = null

Detailed Description

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

Definition at line 30 of file PAPE.php.

Member Function Documentation

◆ addPolicyURI()

Auth_OpenID_PAPE_Request::addPolicyURI ( $policy_uri )

Add an acceptable authentication policy URI to this request

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.

Definition at line 55 of file PAPE.php.

Referenced by Auth_OpenID_PAPE_Request(), and Auth_OpenID_PAPE_Response\Auth_OpenID_PAPE_Response().

◆ Auth_OpenID_PAPE_Request()

Auth_OpenID_PAPE_Request::Auth_OpenID_PAPE_Request	(	$preferred_auth_policies = `null`,
		$max_auth_age = `null`
	)

Definition at line 35 of file PAPE.php.

References $ns_alias, $ns_uri, addPolicyURI(), and Auth_OpenID_PAPE_NS_URI.

Referenced by fromOpenIDRequest().

◆ fromOpenIDRequest()

static Auth_OpenID_PAPE_Request::fromOpenIDRequest ( $request )

static

Instantiate a Request object from the arguments in a checkid_* OpenID message

Definition at line 80 of file PAPE.php.

References $result, Auth_OpenID\arrayGet(), Auth_OpenID_PAPE_NS_URI, Auth_OpenID_PAPE_Request(), Auth_OpenID\intval(), parseExtensionArgs(), and preferredTypes().

◆ getExtensionArgs()

Auth_OpenID_PAPE_Request::getExtensionArgs ( )

Definition at line 62 of file PAPE.php.

◆ parseExtensionArgs()

Auth_OpenID_PAPE_Request::parseExtensionArgs ( $args )

Set the state of this request to be that expressed in these PAPE arguments

Parameters

args	The PAPE arguments without a namespace

Definition at line 99 of file PAPE.php.

Referenced by Auth_OpenID_PAPE_Response\Auth_OpenID_PAPE_Response(), and fromOpenIDRequest().

◆ preferredTypes()

Auth_OpenID_PAPE_Request::preferredTypes ( $supported_types )

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.

Parameters

supported_types A sequence of authentication policy type URIs that are supported by a provider

Returns: array 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.

Definition at line 137 of file PAPE.php.

Referenced by fromOpenIDRequest().

Member Data Documentation

◆ $ns_alias

Auth_OpenID_PAPE_Request::$ns_alias = 'pape'

Definition at line 32 of file PAPE.php.

Referenced by Auth_OpenID_PAPE_Request().

◆ $ns_uri

Auth_OpenID_PAPE_Request::$ns_uri = Auth_OpenID_PAPE_NS_URI

Definition at line 33 of file PAPE.php.