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

Class: Auth_OpenID_SuccessResponse

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

Class Auth_OpenID_SuccessResponse

Class Overview

A response with a status of Auth_OpenID_SUCCESS. Indicates that

this request is a successful acknowledgement from the OpenID server that the supplied URL is, indeed controlled by the requesting agent. This has three relevant attributes:

claimed_id - The identity URL that has been authenticated

signed_args - The arguments in the server's response that were signed and verified.

status - Auth_OpenID_SUCCESS.

Located in /zp-extensions/federated_logon/Auth/OpenID/Consumer.php [line 2026]

Auth_OpenID_ConsumerResponse
   |
   --Auth_OpenID_SuccessResponse

Properties

Methods

[ Top ]
Inherited Properties, Constants, and Methods
Inherited Properties Inherited Methods Inherited Constants

Inherited From Auth_OpenID_ConsumerResponse

Auth_OpenID_ConsumerResponse::getDisplayIdentifier()
Return the display identifier for this response.
Auth_OpenID_ConsumerResponse::setEndpoint()

[ Top ]
Property Summary
mixed   $status  

[ Top ]
Method Summary
void   extensionResponse()   Extract signed extension data from the server's response.
string   getReturnTo()   Get the openid.return_to argument from this response.
void   getSigned()  
void   getSignedNS()  
void   isOpenID1()  
void   isSigned()  

[ Top ]
Properties
mixed   $status = Auth_OpenID_SUCCESS [line 2027]

Redefinition of:
Auth_OpenID_ConsumerResponse::$status

[ Top ]
Methods
extensionResponse  [line 2050]

  void extensionResponse( $namespace_uri, $require_signed, string $prefix  )

Extract signed extension data from the server's response.

Parameters:
string   $prefix:  The extension namespace from which to extract the extension data.
   $namespace_uri: 
   $require_signed: 


[ Top ]
getReturnTo  [line 2111]

  string getReturnTo( )

Get the openid.return_to argument from this response.

This is useful for verifying that this request was initiated by this consumer.


API Tags:
Return:  The return_to URL supplied to the server on the initial request, or null if the response did not contain an 'openid.return_to' argument.


[ Top ]
getSigned  [line 2072]

  void getSigned( $ns_uri, $ns_key, [ $default = null]  )

Parameters:
   $ns_uri: 
   $ns_key: 
   $default: 


[ Top ]
getSignedNS  [line 2083]

  void getSignedNS( $ns_uri  )

Parameters:
   $ns_uri: 


[ Top ]
isOpenID1  [line 2059]

  void isOpenID1( )



[ Top ]
isSigned  [line 2064]

  void isSigned( $ns_uri, $ns_key  )

Parameters:
   $ns_uri: 
   $ns_key: 


[ Top ]

Documentation generated on Tue, 20 Dec 2011 16:07:06 +0100 by phpDocumentor 1.4.3