Class: OpenID_Extension

Source Location: /OpenID-0.4.0/OpenID/Extension.php

Class Overview

OpenID_Extension

Author(s):

Bill Shupp <hostmaster at shupp.org>

Copyright:

2009 Bill Shupp

Variables

Methods

Child classes:

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_AX: Support for the AX extension

OpenID_Extension_OAuth: Provides support for the OAuth extension

OpenID_Extension_UI: Provides support for the UI extension

Inherited Variables

Inherited Methods

Class Details

[line 32]
OpenID_Extension

Base class for creating OpenID message extensions.

Author: Bill Shupp <hostmaster@shupp.org>
Copyright: 2009 Bill Shupp
Link: http://github.com/shupp/openid
Abstract:
Usedby: AX.php
Usedby: UI.php
Usedby: OAuth.php
Usedby: SREG10.php
Usedby: OpenID_Extension_AX
License: FreeBSD
Usedby: OpenID_Extension_SREG10
Usedby: OpenID_Extension_OAuth
Usedby: OpenID_Extension_UI

[ Top ]

Class Variables

$alias = null

[line 94]

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

Access: protected

Type:

string

[ Top ]

$namespace = null

[line 87]

Namespace URI

See: OpenID_Extension::getNamespace()
Access: protected

Type:

string

[ Top ]

$requestKeys = array()

[line 101]

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

Access: protected

Type:

array

[ Top ]

$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

Type:

array

[ Top ]

$responseKeys = array()

[line 108]

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

Access: protected

Type:

array

[ Top ]

$type = self::REQUEST

[line 79]

Type of message - 'request' or 'response'

Access: protected

Type:

string

[ Top ]

$useNamespaceAlias = true

[line 72]

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

Access: protected

Type:

bool

[ Top ]

$values = array()

[line 115]

values

Access: protected

Type:

array

[ Top ]

Method Detail

__construct (Constructor) [line 126]

void __construct(
string
$type, [OpenID_Message
$message = null])

Sets the message type, request or response

Throws: OpenID_Extension_Exception on invalid type argument
Access: public

Parameters:

string	`$type`	—	Type response or type request
OpenID_Message	`$message`	—	Optional message to get values from

[ Top ]

fromMessageResponse [line 227]

array fromMessageResponse(
OpenID_Message
$message)

Extracts extension contents from an OpenID_Message

Return: An array of the extension's key/value pairs
Access: public

Parameters:

OpenID_Message $message — OpenID_Message to extract the extension contents from

[ Top ]

get [line 173]

mixed get(
string
$key)

Gets a key's value

Return: Key's value
Access: public

Parameters:

string $key — Key

[ Top ]

getNamespace [line 272]

string getNamespace(
)

Gets the namespace of this extension

See: OpenID_Extension::$namespace
Access: public

[ Top ]

set [line 150]

void set(
string
$key, string
$value)

Sets a key value pair

Throws: OpenID_Extension_Exception on invalid key argument
Access: public

Overridden in child classes 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()

Parameters:

string	`$key`	—	Key
string	`$value`	—	Value

[ Top ]

toMessage [line 189]

void toMessage(
OpenID_Message
$message)

Adds the extension contents to an OpenID_Message

Throws: OpenID_Extension_Exception on error
Access: public

Parameters:

OpenID_Message $message — Message to add the extension contents to

[ Top ]