Auth_OpenID_SRegResponse Class Reference
Detailed Description
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.Definition at line 417 of file SReg.php.
Public Member Functions | |
| Auth_OpenID_SRegResponse ($data=null, $sreg_ns_uri=Auth_OpenID_SREG_NS_URI) | |
| extractResponse ($request, $data) | |
| fromSuccessResponse (&$success_response, $signed_only=true) | |
| getExtensionArgs () | |
| get ($field_name, $default=null) | |
| contents () | |
Public Attributes | |
| $ns_alias = 'sreg' | |
Member Function Documentation
| Auth_OpenID_SRegResponse.Auth_OpenID_SRegResponse | ( | $ | data = null, |
|
| $ | sreg_ns_uri = Auth_OpenID_SREG_NS_URI | |||
| ) |
| Auth_OpenID_SRegResponse.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'.
| Auth_OpenID_SRegResponse.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.
| Auth_OpenID_SRegResponse.getExtensionArgs | ( | ) |
Get the string arguments that should be added to an OpenID message for this extension.
Reimplemented from Auth_OpenID_Extension.
| Auth_OpenID_SRegResponse.get | ( | $ | field_name, | |
| $ | default = null | |||
| ) |
Member Data Documentation
| Auth_OpenID_SRegResponse.$ns_alias = 'sreg' |
The documentation for this class was generated from the following file:
- core/openid/Auth/OpenID/SReg.php
