Class Auth_OpenID_SRegRequest
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
-
Auth_OpenID_Extension
-
Auth_OpenID_SRegBase
-
Auth_OpenID_SRegRequest
Methods summary
public static
|
#
build( $required = null, $optional = null, $policy_url = null, $sreg_ns_uri = Auth_OpenID_SREG_NS_URI, $cls = 'Auth_OpenID_SRegRequest' )
Initialize an empty simple registration request.
Initialize an empty simple registration request.
|
public static
|
#
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
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
|
public
|
#
parseExtensionArgs( $args, $strict = false )
Parse the unqualified simple registration request parameters
and add them to this object.
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)
|
public
|
#
allRequestedFields( )
A list of all of the simple registration fields that were
requested, whether they were required or optional.
A list of all of the simple registration fields that were
requested, whether they were required or optional.
|
public
|
#
wereFieldsRequested( )
Have any simple registration fields been requested?
Have any simple registration fields been requested?
|
public
|
#
contains( $field_name )
Was this field in the request?
Was this field in the request?
|
public
|
#
requestField( $field_name, $required = false, $strict = false )
Request the specified field from the OpenID user
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
|
public
|
#
requestFields( $field_names, $required = false, $strict = false )
Add the given list of fields to the request
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
|
public
|
#
getExtensionArgs( )
Get a dictionary of unqualified simple registration arguments
representing this request.
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.
Overrides
|