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

Class: Auth_OpenID_SRegResponse

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

Class Auth_OpenID_SRegResponse

Class Overview

Represents the data returned in a simple registration response inside of an OpenID C{id_res} response. This object will be created by the OpenID server, added to the C{id_res} response object, and then extracted from the C{id_res} message by the Consumer.

Located in /zp-extensions/federated_logon/Auth/OpenID/SReg.php [line 417]

Auth_OpenID_Extension
   |
   --Auth_OpenID_SRegBase
      |
      --Auth_OpenID_SRegResponse

Properties

Methods

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

Inherited From Auth_OpenID_Extension

Auth_OpenID_Extension::$ns_uri

Inherited From Auth_OpenID_Extension

Auth_OpenID_Extension::getExtensionArgs()
Get the string arguments that should be added to an OpenID message for this extension.
Auth_OpenID_Extension::toMessage()
Add the arguments from this extension to the provided message.

[ Top ]
Property Summary
mixed   $ns_alias  

[ Top ]
Method Summary
static void   extractResponse()   Take a C{L{SRegRequest}} and a dictionary of simple registration values and create a C{L{SRegResponse}} object containing that data.
static void   fromSuccessResponse()   Create a C{L{SRegResponse}} object from a successful OpenID
Auth_OpenID_SRegResponse   Auth_OpenID_SRegResponse()  
void   contents()  
void   get()  
void   getExtensionArgs()  

[ Top ]
Properties
mixed   $ns_alias = 'sreg' [line 419]

Redefinition of:
Auth_OpenID_Extension::$ns_alias

[ Top ]
Methods
static method extractResponse  [line 445]

  static void extractResponse( $request, $data  )

Take a C{L{SRegRequest}} and a dictionary of simple registration values and create a C{L{SRegResponse}} object containing that data.

request: The simple registration request object

data: The simple registration data for this response, as a dictionary from unqualified simple registration field name to string (unicode) value. For instance, the nickname should be stored under the key 'nickname'.

Parameters:
   $request: 
   $data: 


[ Top ]
static method fromSuccessResponse  [line 474]

  static void fromSuccessResponse( $success_response, [ $signed_only = true]  )

Create a C{L{SRegResponse}} object from a successful OpenID

library response (C{L{openid.consumer.consumer.SuccessResponse}}) response message

success_response: A SuccessResponse from consumer.complete()

signed_only: Whether to process only data that was signed in the id_res message from the server.

Returns a simple registration response containing the data that was supplied with the C{id_res} response.

Parameters:
   $success_response: 
   $signed_only: 


[ Top ]
Constructor Auth_OpenID_SRegResponse  [line 421]

  Auth_OpenID_SRegResponse Auth_OpenID_SRegResponse( [ $data = null], [ $sreg_ns_uri = Auth_OpenID_SREG_NS_URI]  )

Parameters:
   $data: 
   $sreg_ns_uri: 


[ Top ]
contents  [line 515]

  void contents( )



[ Top ]
get  [line 506]

  void get( $field_name, [ $default = null]  )

Parameters:
   $field_name: 
   $default: 


[ Top ]
getExtensionArgs  [line 500]

  void getExtensionArgs( )



Redefinition of:
Auth_OpenID_Extension::getExtensionArgs()
Get the string arguments that should be added to an OpenID message for this extension.

[ Top ]

Documentation generated on Sat, 05 Jan 2013 15:51:26 +0100 by phpDocumentor 1.4.3