[ class tree: core ] [ index: core ] [ all elements ]

Class: Auth_OpenID_PAPE_Request

Source Location: /zp-extensions/federated_logon/Auth/OpenID/PAPE.php

Class Auth_OpenID_PAPE_Request

Class Overview

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

Located in /zp-extensions/federated_logon/Auth/OpenID/PAPE.php [line 35]

Auth_OpenID_Extension
   |
   --Auth_OpenID_PAPE_Request

Properties

Methods

[ Top ]
Property Summary
mixed   $ns_alias  
mixed   $ns_uri  

[ Top ]
Method Summary
static void   fromOpenIDRequest()   Instantiate a Request object from the arguments in a checkid_*
Auth_OpenID_PAPE_Request   Auth_OpenID_PAPE_Request()  
void   addPolicyURI()   Add an acceptable authentication policy URI to this request
void   getExtensionArgs()  
void   parseExtensionArgs()   Set the state of this request to be that expressed in these PAPE arguments
array   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.

[ Top ]
Properties
mixed   $ns_alias = 'pape' [line 37]

[ Top ]
mixed   $ns_uri = Auth_OpenID_PAPE_NS_URI [line 38]

[ Top ]
Methods
static method fromOpenIDRequest  [line 85]

  static void fromOpenIDRequest( $request  )

Instantiate a Request object from the arguments in a checkid_*

OpenID message

Parameters:
   $request: 


[ Top ]
Constructor Auth_OpenID_PAPE_Request  [line 40]

  Auth_OpenID_PAPE_Request Auth_OpenID_PAPE_Request( [ $preferred_auth_policies = null], [ $max_auth_age = null]  )

Parameters:
   $preferred_auth_policies: 
   $max_auth_age: 


[ Top ]
addPolicyURI  [line 60]

  void 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.

Parameters:
   $policy_uri: 


[ Top ]
getExtensionArgs  [line 67]

  void getExtensionArgs( )



[ Top ]
parseExtensionArgs  [line 104]

  void parseExtensionArgs( args: $args  )

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

Parameters:
args:   $args:  The PAPE arguments without a namespace


[ Top ]
preferredTypes  [line 142]

  array preferredTypes( supported_types: $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:   $supported_types:  A sequence of authentication policy type URIs that are supported by a provider

API Tags:
Return:  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.


[ Top ]

Documentation generated on Sat, 07 Jun 2014 18:03:41 +0200 by phpDocumentor 1.4.3