SReg.php File Reference

Go to the source code of this file.

Classes
class	Auth_OpenID_SRegBase
class	Auth_OpenID_SRegRequest
class	Auth_OpenID_SRegResponse
Enumerations
enum	Auth_OpenID_SREG_NS_URI_1_0
enum	Auth_OpenID_SREG_NS_URI_1_1
enum	Auth_OpenID_SREG_NS_URI
Functions
	Auth_OpenID_checkFieldName ($field_name)
	Auth_OpenID_supportsSReg (&$endpoint)
Variables
global	$Auth_OpenID_sreg_data_fields

---

Enumeration Type Documentation

enum Auth_OpenID_SREG_NS_URI

Definition at line 86 of file SReg.php.

enum Auth_OpenID_SREG_NS_URI_1_0

Definition at line 77 of file SReg.php.

enum Auth_OpenID_SREG_NS_URI_1_1

Definition at line 81 of file SReg.php.

---

Function Documentation

Auth_OpenID_checkFieldName

(

$

field_name

)

Check to see that the given value is a valid simple registration data field name. Return true if so, false if not.

Definition at line 65 of file SReg.php.

Auth_OpenID_supportsSReg

(

&$

endpoint

)

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

Definition at line 97 of file SReg.php.

---

Variable Documentation

$Auth_OpenID_sreg_data_fields

Initial value:

 array(
                                      'fullname' => 'Full Name',
                                      'nickname' => 'Nickname',
                                      'dob' => 'Date of Birth',
                                      'email' => 'E-mail Address',
                                      'gender' => 'Gender',
                                      'postcode' => 'Postal Code',
                                      'country' => 'Country',
                                      'language' => 'Language',
                                      'timezone' => 'Time Zone')

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.

1. The relying party creates a request object and adds it to the Auth_OpenID_AuthRequest object before making the checkid request to the OpenID provider:

$sreg_req = Auth_OpenID_SRegRequest.build(array('email')); $auth_request->addExtension($sreg_req);

2. The OpenID provider extracts the simple registration request from the OpenID request using Auth_OpenID_SRegRequest::fromOpenIDRequest, gets the user's approval and data, creates an Auth_OpenID_SRegResponse object and adds it to the id_res response:

$sreg_req = Auth_OpenID_SRegRequest.fromOpenIDRequest( $checkid_request); // [ get the user's approval and data, informing the user that // the fields in sreg_response were requested ] $sreg_resp = Auth_OpenID_SRegResponse.extractResponse( $sreg_req, $user_data); $sreg_resp->toMessage($openid_response->fields);

3. The relying party uses Auth_OpenID_SRegResponse::fromSuccessResponse to extract the data from the OpenID response:

$sreg_resp = Auth_OpenID_SRegResponse.fromSuccessResponse( $success_response); Import message and extension internals.

Definition at line 45 of file SReg.php.