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

Class: Auth_OpenID_PAPE_Response

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

Class Auth_OpenID_PAPE_Response

Class Overview

A Provider Authentication Policy response, sent from a provider to

a relying party

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

Auth_OpenID_Extension
   |
   --Auth_OpenID_PAPE_Response

Properties

Methods

[ Top ]
Property Summary
mixed   $ns_alias  
mixed   $ns_uri  

[ Top ]
Method Summary
static void   fromSuccessResponse()   Create an Auth_OpenID_PAPE_Response object from a successful OpenID library response.
Auth_OpenID_PAPE_Response   Auth_OpenID_PAPE_Response()  
void   addPolicyURI()   Add a authentication policy to this response
void   getExtensionArgs()  
null   parseExtensionArgs()   Parse the provider authentication policy arguments into the internal state of this object

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

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

[ Top ]
Methods
static method fromSuccessResponse  [line 204]

  static void fromSuccessResponse( success_response $success_response  )

Create an Auth_OpenID_PAPE_Response object from a successful OpenID library response.

Parameters:
success_response   $success_response:  A SuccessResponse from Auth_OpenID_Consumer::complete()


[ Top ]
Constructor Auth_OpenID_PAPE_Response  [line 164]

  Auth_OpenID_PAPE_Response Auth_OpenID_PAPE_Response( [ $auth_policies = null], [ $auth_time = null], [ $nist_auth_level = null]  )

Parameters:
   $auth_policies: 
   $auth_time: 
   $nist_auth_level: 


[ Top ]
addPolicyURI  [line 187]

  void addPolicyURI( policy_uri: $policy_uri  )

Add a authentication policy to this response

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:   $policy_uri:  The identifier for the preferred type of authentication.


[ Top ]
getExtensionArgs  [line 273]

  void getExtensionArgs( )



[ Top ]
parseExtensionArgs  [line 237]

  null parseExtensionArgs( args: $args, [strict: $strict = false]  )

Parse the provider authentication policy arguments into the internal state of this object

Parameters:
args:   $args:  unqualified provider authentication policy arguments
strict:   $strict:  Whether to return false when bad data is encountered

API Tags:
Return:  The data is parsed into the internal fields of this object.


[ Top ]

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