Auth_OpenID_PAPE_Request Class Reference

Inheritance diagram for Auth_OpenID_PAPE_Request:

[legend]

Collaboration diagram for Auth_OpenID_PAPE_Request:

[legend]

List of all members.

---

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.

Public Member Functions
	Auth_OpenID_PAPE_Request ($preferred_auth_policies=null, $max_auth_age=null)
	addPolicyURI ($policy_uri)
	getExtensionArgs ()
	fromOpenIDRequest ($request)
	parseExtensionArgs ($args)
	preferredTypes ($supported_types)
Public Attributes
	$ns_alias = 'pape'
	$ns_uri = Auth_OpenID_PAPE_NS_URI

---

Member Function Documentation

Auth_OpenID_PAPE_Request.Auth_OpenID_PAPE_Request	(	$	preferred_auth_policies = null,
		$	max_auth_age = null
	)

Definition at line 35 of file PAPE.php.

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.

Auth_OpenID_PAPE_Request.getExtensionArgs

(

)

Get the string arguments that should be added to an OpenID message for this extension.

Reimplemented from Auth_OpenID_Extension.

Definition at line 62 of file PAPE.php.

Auth_OpenID_PAPE_Request.fromOpenIDRequest

(

$

request

)

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

Definition at line 80 of file PAPE.php.

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.

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.

---

Member Data Documentation

Auth_OpenID_PAPE_Request.$ns_alias = 'pape'

Reimplemented from Auth_OpenID_Extension.

Definition at line 32 of file PAPE.php.

Auth_OpenID_PAPE_Request.$ns_uri = Auth_OpenID_PAPE_NS_URI

ns_uri: The namespace to which to add the arguments for this extension

Reimplemented from Auth_OpenID_Extension.

Definition at line 33 of file PAPE.php.

---

The documentation for this class was generated from the following file:

• core/openid/Auth/OpenID/PAPE.php