Docs For Class OpenID_Extension

Description

Implementation of the Simple Registration Extension version 1.0. See http://openid.net/specs/openid-simple-registration-extension-1_0.html for more information on this extension.

Example usage:

$sreg = new OpenID_Extension_SREG10(OpenID_Extension::REQUEST);
$sreg->set('required', 'email');
$sreg->set('optional', 'nickname,gender,dob');
// Add to an existing instance of OpenID_Auth_Request
$authRequest->addExtension($sreg);

author: Bill Shupp <hostmaster@shupp.org>
copyright: 2009 Bill Shupp
link: http://pearopenid.googlecode.com
usedby: SREG11.php
usedby: OpenID_Extension_SREG11
license: FreeBSD
uses: OpenID_Extension

Located in /OpenID/Extension/SREG10.php (line 44)

OpenID_Extension
   |
   --OpenID_Extension_SREG10

Direct descendents

Class	Description
OpenID_Extension_SREG11	Implementation of the Simple Registration Extension, version 1.1 Draft 1.

Variable Summary

string $alias

array $requestKeys

array $responseKeys

bool $useNamespaceAlias

Variables

string $alias = 'sreg' (line 58)

The alias to use.

access: protected

Redefinition of:

OpenID_Extension::$alias: Namespace text, "sreg" or "ax" for example

array $requestKeys = array(
'required',
'optional',
'policy_url'
) (line 65)

Supported keys in a request

access: protected

Redefinition of:

OpenID_Extension::$requestKeys: Keys appropriate for a request. Leave empty to allow any keys.

array $responseKeys = array(
'nickname',
'email',
'fullname',
'dob',
'gender',
'postcode',
'country',
'language',
'timezone'
) (line 76)

Supported keys in a response

access: protected

Redefinition of:

OpenID_Extension::$responseKeys: Keys appropriate for a response. Leave empty to allow any keys.

bool $useNamespaceAlias = false (line 51)

Disables NS use, since this extension was done before OpenID 2.0

access: protected

Redefinition of:

OpenID_Extension::$useNamespaceAlias: Whether or not to use namespace alias assignments (for SREG 1.0 mostly)

Redefined in descendants as:

OpenID_Extension_SREG11::$useNamespaceAlias : Enables namespaces. The only differnce I can see in the specs.

Inherited Variables

Inherited from OpenID_Extension

OpenID_Extension::$namespace
OpenID_Extension::$reserved
OpenID_Extension::$type
OpenID_Extension::$values

Methods

Inherited Methods

Inherited From OpenID_Extension

OpenID_Extension::__construct()
OpenID_Extension::fromMessageResponse()
OpenID_Extension::get()
OpenID_Extension::getNamespace()
OpenID_Extension::set()
OpenID_Extension::toMessage()

Class Constants

Inherited Constants

Inherited from OpenID_Extension

OpenID_Extension::REQUEST
OpenID_Extension::RESPONSE

Class OpenID_Extension_SREG10

Inherited Variables

Inherited Methods

Inherited Constants