Docs For Class OpenID

Description

OpenID_Extension

Base class for creating OpenID message extensions.

author: Bill Shupp <hostmaster@shupp.org>
copyright: 2009 Bill Shupp
link: http://pearopenid.googlecode.com
abstract:
usedby: SREG10.php
usedby: UI.php
usedby: AX.php
usedby: OpenID_Extension_AX
license: FreeBSD
usedby: OpenID_Extension_SREG10
usedby: OpenID_Extension_UI

Located in /OpenID/Extension.php (line 32)

Direct descendents

Class	Description
OpenID_Extension_AX	Support for the AX extension
OpenID_Extension_SREG10	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.
OpenID_Extension_UI	Provides support for the UI extension

Class Constant Summary

REQUEST = 'request'

RESPONSE = 'response'

Variable Summary

static array $reserved

string $alias

string $namespace

array $requestKeys

array $responseKeys

string $type

bool $useNamespaceAlias

array $values

Method Summary

void __construct (string $type)

array fromMessageResponse (OpenID_Message $message)

mixed get (string $key)

string getNamespace ()

void set (string $key, string $value)

void toMessage (OpenID_Message $message)

Variables

static array $reserved = array(
'assoc_handle',
'assoc_type',
'claimed_id',
'contact',
'delegate',
'dh_consumer_public',
'dh_gen',
'dh_modulus',
'error',
'identity',
'invalidate_handle',
'mode',
'ns',
'op_endpoint',
'openid',
'realm',
'reference',
'response_nonce',
'return_to',
'server',
'session_type',
'sig',
'signed',
'trust_root ',
) (line 40)

var: Array of reserved message keys
access: protected

string $alias = null (line 94)

Namespace text, "sreg" or "ax" for example

access: protected

Redefined in descendants as:

OpenID_Extension_AX::$alias : Alias string to use
OpenID_Extension_SREG10::$alias : The alias to use.
OpenID_Extension_UI::$alias : Alias to use

string $namespace = null (line 87)

Namespace URI

see: OpenID_Extension::getNamespace()
access: protected

Redefined in descendants as:

OpenID_Extension_AX::$namespace : URL for the openid.ns.ax parameter
OpenID_Extension_SREG11::$namespace : Sets the URI of the spec for alias assignment
OpenID_Extension_UI::$namespace : URI of the UI namespace

array $requestKeys = array() (line 101)

Keys appropriate for a request. Leave empty to allow any keys.

access: protected

Redefined in descendants as:

OpenID_Extension_SREG10::$requestKeys : Supported keys in a request

array $responseKeys = array() (line 108)

Keys appropriate for a response. Leave empty to allow any keys.

access: protected

Redefined in descendants as:

OpenID_Extension_SREG10::$responseKeys : Supported keys in a response

string $type = self::REQUEST (line 79)

Type of message - 'request' or 'response'

access: protected

bool $useNamespaceAlias = true (line 72)

Whether or not to use namespace alias assignments (for SREG 1.0 mostly)

access: protected

Redefined in descendants as:

OpenID_Extension_SREG10::$useNamespaceAlias : Disables NS use, since this extension was done before OpenID 2.0
OpenID_Extension_SREG11::$useNamespaceAlias : Enables namespaces. The only differnce I can see in the specs.

array $values = array() (line 115)

values

access: protected

Methods

Constructor __construct (line 125)

Sets the message type, request or response

throws: OpenID_Extension_Exception on invalid type argument
access: public

void __construct (string $type)

string $type: type response or type request

fromMessageResponse (line 214)

Extracts extension contents from an OpenID_Message

return: An array of the extension's key/value pairs
access: public

array fromMessageResponse (OpenID_Message $message)

OpenID_Message $message: OpenID_Message to extract the extension contents from

get (line 162)

Gets a key's value

return: Key's value
access: public

mixed get (string $key)

string $key: Key

getNamespace (line 259)

Gets the namespace of this extension

see: OpenID_Extension::$namespace
access: public

string getNamespace ()

set (line 142)

Sets a key value pair

throws: OpenID_Extension_Exception on invalid key argument
access: public

void set (string $key, string $value)

string $key: Key
string $value: Value

Redefined in descendants as:

OpenID_Extension_AX::set() : Adds some validation checking when setting a key, then calls the parent set()
OpenID_Extension_UI::set() : Adds mode checking to set()

toMessage (line 178)

Adds the extension contents to an OpenID_Message

throws: OpenID_Extension_Exception on error
access: public

void toMessage (OpenID_Message $message)

OpenID_Message $message: Message to add the extension contents to

Class Constants

REQUEST = 'request' (line 34)

RESPONSE = 'response' (line 35)

Class OpenID_Extension