| [ Index ] |
PHP Cross Reference of Joomla 1.5.26 DE |
[Source view] [Print] [Project Stats]
Simple registration request and response parsing and object representation. This module contains objects representing simple registration requests and responses that can be used with both OpenID relying parties and OpenID providers.
| File Size: | 524 lines (16 kb) |
| Included or required: | 1 time |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
Auth_OpenID_SRegBase:: (1 method):
_getSRegNS()
Auth_OpenID_SRegRequest:: (9 methods):
build()
fromOpenIDRequest()
parseExtensionArgs()
allRequestedFields()
wereFieldsRequested()
contains()
requestField()
requestFields()
getExtensionArgs()
Auth_OpenID_SRegResponse:: (6 methods):
Auth_OpenID_SRegResponse()
extractResponse()
fromSuccessResponse()
getExtensionArgs()
get()
contents()
Class: Auth_OpenID_SRegBase - X-Ref
A base class for classes dealing with Simple Registration protocol| _getSRegNS(&$message) X-Ref |
| Extract the simple registration namespace URI from the given OpenID message. Handles OpenID 1 and 2, as well as both sreg namespace URIs found in the wild, as well as missing namespace definitions (for OpenID 1) $message: The OpenID message from which to parse simple registration fields. This may be a request or response message. Returns the sreg namespace URI for the supplied message. The message may be modified to define a simple registration namespace. |
Class: Auth_OpenID_SRegRequest - X-Ref
An object to hold the state of a simple registration request.| build($required=null, $optional=null,$policy_url=null,$sreg_ns_uri=Auth_OpenID_SREG_NS_URI,$cls='Auth_OpenID_SRegRequest') X-Ref |
| Initialize an empty simple registration request. |
| fromOpenIDRequest($request, $cls='Auth_OpenID_SRegRequest') X-Ref |
| Create a simple registration request that contains the fields that were requested in the OpenID request with the given arguments $request: The OpenID authentication request from which to extract an sreg request. $cls: name of class to use when creating sreg request object. Used for testing. Returns the newly created simple registration request |
| parseExtensionArgs($args, $strict=false) X-Ref |
| Parse the unqualified simple registration request parameters and add them to this object. This method is essentially the inverse of getExtensionArgs. This method restores the serialized simple registration request fields. If you are extracting arguments from a standard OpenID checkid_* request, you probably want to use fromOpenIDRequest, which will extract the sreg namespace and arguments from the OpenID request. This method is intended for cases where the OpenID server needs more control over how the arguments are parsed than that method provides. $args == $message->getArgs($ns_uri); $request->parseExtensionArgs($args); $args: The unqualified simple registration arguments strict: Whether requests with fields that are not defined in the simple registration specification should be tolerated (and ignored) |
| allRequestedFields() X-Ref |
| A list of all of the simple registration fields that were requested, whether they were required or optional. |
| wereFieldsRequested() X-Ref |
| Have any simple registration fields been requested? |
| contains($field_name) X-Ref |
| Was this field in the request? |
| requestField($field_name,$required=false, $strict=false) X-Ref |
| Request the specified field from the OpenID user $field_name: the unqualified simple registration field name required: whether the given field should be presented to the user as being a required to successfully complete the request strict: whether to raise an exception when a field is added to a request more than once |
| requestFields($field_names, $required=false, $strict=false) X-Ref |
| Add the given list of fields to the request field_names: The simple registration data fields to request required: Whether these values should be presented to the user as required strict: whether to raise an exception when a field is added to a request more than once |
| getExtensionArgs() X-Ref |
| Get a dictionary of unqualified simple registration arguments representing this request. This method is essentially the inverse of C{L{parseExtensionArgs}}. This method serializes the simple registration request fields. |
Class: Auth_OpenID_SRegResponse - X-Ref
Represents the data returned in a simple registration response| Auth_OpenID_SRegResponse($data=null,$sreg_ns_uri=Auth_OpenID_SREG_NS_URI) X-Ref |
| No description |
| extractResponse($request, $data) X-Ref |
| 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'. |
| fromSuccessResponse(&$success_response, $signed_only=true) X-Ref |
| 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. |
| getExtensionArgs() X-Ref |
| No description |
| get($field_name, $default=null) X-Ref |
| No description |
| contents() X-Ref |
| No description |
| Auth_OpenID_checkFieldName($field_name) X-Ref |
| Check to see that the given value is a valid simple registration data field name. Return true if so, false if not. |
| Auth_OpenID_supportsSReg(&$endpoint) X-Ref |
| Does the given endpoint advertise support for simple registration? $endpoint: The endpoint object as returned by OpenID discovery. returns whether an sreg type was advertised by the endpoint |
| Generated: Wed Mar 28 15:54:07 2012 | Cross-referenced by PHPXref 0.7.1 |