Docs For Class OpenID

addExtension [line 247]

void addExtension(
OpenID_Extension
$extension)

Adds an extension to an OpenID_Message object.

See: OpenID_Extension
Access: public

Parameters:

OpenID_Extension $extension — Instance of OpenID_Extension

[ Top ]

delete [line 106]

void delete(
string
$name)

Deletes a key from a message

Access: public

Parameters:

string $name — Key name

[ Top ]

__construct (Constructor) [line 58]

void __construct(
[mixed
$message = null], [string
$format = self::FORMAT_ARRAY])

Optionally instanciates this object with the contents of an OpenID message.

Access: public

Parameters:

mixed	`$message`	—	Message contents
string	`$format`	—	Source message format (KV, HTTP, or ARRAY)

[ Top ]

get [line 72]

mixed get(
string
$name)

Gets the value of any key in this message.

Return: Value of key if set, defaults to null
Access: public

Parameters:

string $name — Name of key

[ Top ]

getArrayFormat [line 139]

array getArrayFormat(
)

Gets the current message in ARRAY format

See: OpenID_Message::getMessage()
Access: public

[ Top ]

getHTTPFormat [line 128]

string getHTTPFormat(
)

Gets the current message in HTTP (url encoded) format

See: OpenID_Message::getMessage()
Access: public

[ Top ]

getKVFormat [line 117]

string getKVFormat(
)

Gets the current message in KV format

See: OpenID_Message::getMessage()
Access: public

[ Top ]

getMessage [line 156]

mixed getMessage(
[string
$format = self::FORMAT_ARRAY])

Gets the message in one of three formats:

OpenID_Message::FORMAT_ARRAY (default) OpenID_Message::FORMAT_KV (KV pairs, OpenID response format) OpenID_Message::FORMAT_HTTP (url encoded pairs, for use in a query string)

Return: array, kv string, or url query string paramters
Throws: OpenID_Message_Exception When passed an invalid format argument
Access: public

Parameters:

string $format — One of the above three formats

[ Top ]

set [line 88]

void set(
string
$name, mixed
$val)

Sets a message key value.

Access: public

Parameters:

string	`$name`	—	Key name
mixed	`$val`	—	Key value

[ Top ]

setMessage [line 194]

void setMessage(
mixed
$message, [mixed
$format = self::FORMAT_ARRAY])

Sets message contents. Wipes out any existing message contents. Default source format is Array, but you can also use KV and HTTP formats.

Access: public

Parameters:

mixed	`$message`	—	Source message
mixed	`$format`	—	Source message format (OpenID_Message::FORMAT_KV, OpenID_Message::FORMAT_ARRAY, OpenID_Message::FORMAT_HTTP)

[ Top ]

Class: OpenID_Message

Class Overview

Author(s):

Copyright:

Variables

Methods

Inherited Variables

Inherited Methods

Class Details

Class Variables

$data = array()

$validFormats = array(self::FORMAT_KV,
self::FORMAT_HTTP,
self::FORMAT_ARRAY)

Method Detail

addExtension [line 247]

Parameters:

delete [line 106]

Parameters:

__construct (Constructor) [line 58]

Parameters:

get [line 72]

Parameters:

getArrayFormat [line 139]

getHTTPFormat [line 128]

getKVFormat [line 117]

getMessage [line 156]

Parameters:

set [line 88]

Parameters:

setMessage [line 194]

Parameters:

Class: OpenID_Message

Class Overview

Author(s):

Copyright:

Variables

Methods

Inherited Variables

Inherited Methods

Class Details

Class Variables

$data = array()

$validFormats = array(self::FORMAT_KV, self::FORMAT_HTTP, self::FORMAT_ARRAY)

Method Detail

addExtension [line 247]

Parameters:

delete [line 106]

Parameters:

__construct (Constructor) [line 58]

Parameters:

get [line 72]

Parameters:

getArrayFormat [line 139]

getHTTPFormat [line 128]

getKVFormat [line 117]

getMessage [line 156]

Parameters:

set [line 88]

Parameters:

setMessage [line 194]

Parameters:

$validFormats = array(self::FORMAT_KV,
self::FORMAT_HTTP,
self::FORMAT_ARRAY)