Auth_OpenID_SRegRequest Class Reference
Detailed Description
An object to hold the state of a simple registration request.required: A list of the required fields in this simple registration request
optional: A list of the optional fields in this simple registration request
Definition at line 169 of file SReg.php.
Public Member Functions | |
| build ($required=null, $optional=null, $policy_url=null, $sreg_ns_uri=Auth_OpenID_SREG_NS_URI, $cls='Auth_OpenID_SRegRequest') | |
| fromOpenIDRequest ($request, $cls='Auth_OpenID_SRegRequest') | |
| parseExtensionArgs ($args, $strict=false) | |
| allRequestedFields () | |
| wereFieldsRequested () | |
| contains ($field_name) | |
| requestField ($field_name, $required=false, $strict=false) | |
| requestFields ($field_names, $required=false, $strict=false) | |
| getExtensionArgs () | |
Public Attributes | |
| $ns_alias = 'sreg' | |
Member Function Documentation
| Auth_OpenID_SRegRequest.build | ( | $ | required = null, |
|
| $ | optional = null, |
|||
| $ | policy_url = null, |
|||
| $ | sreg_ns_uri = Auth_OpenID_SREG_NS_URI, |
|||
| $ | cls = 'Auth_OpenID_SRegRequest' | |||
| ) |
| Auth_OpenID_SRegRequest.fromOpenIDRequest | ( | $ | request, | |
| $ | cls = 'Auth_OpenID_SRegRequest' | |||
| ) |
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
| Auth_OpenID_SRegRequest.parseExtensionArgs | ( | $ | args, | |
| $ | strict = false | |||
| ) |
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)
| Auth_OpenID_SRegRequest.allRequestedFields | ( | ) |
| Auth_OpenID_SRegRequest.wereFieldsRequested | ( | ) |
| Auth_OpenID_SRegRequest.contains | ( | $ | field_name | ) |
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
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
| Auth_OpenID_SRegRequest.getExtensionArgs | ( | ) |
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.
Reimplemented from Auth_OpenID_Extension.
Member Data Documentation
| Auth_OpenID_SRegRequest.$ns_alias = 'sreg' |
The documentation for this class was generated from the following file:
- core/openid/Auth/OpenID/SReg.php
