PHP Class Auth_OpenID_SRegRequest

required: A list of the required fields in this simple registration request optional: A list of the optional fields in this simple registration request

Inheritance: extends Auth_OpenID_SRegBase

Show file Open project: openid/php-openid Class Usage Examples

Public Properties

Property	Type	Description
$ns_alias

Public Methods

Method	Description
allRequestedFields ( )	A list of all of the simple registration fields that were requested, whether they were required or optional.
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.
contains ( $field_name )	Was this field in the request?
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
getExtensionArgs ( )	Get a dictionary of unqualified simple registration arguments representing this request.
parseExtensionArgs ( $args, $strict = false )	Parse the unqualified simple registration request parameters and add them to this object.
requestField ( $field_name, $required = false, $strict = false )	Request the specified field from the OpenID user
requestFields ( $field_names, $required = false, $strict = false )	Add the given list of fields to the request
wereFieldsRequested ( )	Have any simple registration fields been requested?

Method Details

allRequestedFields() public method

A list of all of the simple registration fields that were requested, whether they were required or optional.

public allRequestedFields ( )

build() static public method

Initialize an empty simple registration request.

static public build ( $required = null, $optional = null, $policy_url = null, $sreg_ns_uri = Auth_OpenID_SREG_NS_URI, $cls = 'Auth_OpenID_SRegRequest' )

contains() public method

Was this field in the request?

public contains ( $field_name )

fromOpenIDRequest() static public method

$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

static public fromOpenIDRequest ( $request, $cls = 'Auth_OpenID_SRegRequest' )

getExtensionArgs() public method

This method is essentially the inverse of C{L{parseExtensionArgs}}. This method serializes the simple registration request fields.

public getExtensionArgs ( )

parseExtensionArgs() public method

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 parseExtensionArgs ( $args, $strict = false )

requestField() public method

$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 requestField ( $field_name, $required = false, $strict = false )

requestFields() public method

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 requestFields ( $field_names, $required = false, $strict = false )

wereFieldsRequested() public method

Have any simple registration fields been requested?

public wereFieldsRequested ( )

Property Details

$ns_alias public property

public $ns_alias