Class SimpleID\Protocols\OpenID\Message

`abstract`
`extends`	`ArrayWrapper`

An abstract class representing an OpenID message (request and response).

This class is a subclass of ArrayWrapper . Message parameters are stored in

ArrayWrapper->container

and are accessed using array syntax.

SimpleID\Util\ArrayWrapper implements ArrayAccess<string, mixed>, Countable, IteratorAggregate<string, mixed>
- SimpleID\Protocols\OpenID\Message
  - SimpleID\Protocols\OpenID\Request
  - SimpleID\Protocols\OpenID\Response

Located at core/Protocols/OpenID/Message.php

Methods


					
	public

getVersion(): int

Returns the OpenID version of the message

Returns

either OPENID_VERSION_2 or OPENID_VERSION_1_1


					
	public

getParamsForExtension(string $ns): array<string, string>

Filters an OpenID request to find keys specific to an extension, as specified by the Type URI.

For exmaple, if the extension has the Type URI http://example.com/ and the alias example, this function will return an array of all the keys in the OpenID request which starts with openid.example

Parameters

$ns

the Type URI of the extension

Returns

the filtered request, with the prefix (in the example above, openid.example.) stripped in the keys.


					
	public

hasExtension(string $ns): bool

Determines whether an extension is present in an OpenID request.

Parameters

$ns

the Type URI of the extension

Returns

true if the extension is present in the request


					
	public

getExtensionMap(): array<string, string>

Obtains the mapping between namespace URIs and their aliases.

Returns

the mapping between namespace URIs and their aliases


					
	protected
					static

toKeyValueForm(array<string, string> $data): string|null

Creates a OpenID message for direct response.

The response will be encoded using Key-Value Form Encoding.

Parameters

$data

the data in the response

Returns

the message in key-value form encoding


					
	protected

buildSignatureBaseString(array<string> $signed_fields, string $prefix = ''): string

Calculates the base string from which an OpenID signature is generated, given a list of fields to sign.

Parameters

`$signed_fields`	the list of fields to sign
`$prefix`	the prefix to be prepended to $signed_field to obtain the field value - used for Requests

Returns

the signature base string


					abstract
	public

getSignatureBaseString(): string

Calculates the base string from which an OpenID signature is generated.

Subclasses specify the list of fields to sign and calls buildSignatureBaseString()

Returns

the signature base string

Implemented by


					abstract
	protected

getPrefix(): string

Returns the base string from which an OpenID signature is generated

Returns

the base string

Implemented by

Methods inherited from SimpleID\Util\ArrayWrapper
`__construct(), loadData(), toArray(), offsetSet(), offsetExists(), offsetUnset(), offsetGet(), __set(), count(), getIterator(), get(), exists(), set(), append(), unset(), ref(), refLimit(), splitPath()`

Constants
`public`	`OPENID_VERSION_2 = 2`	#
`public`	`OPENID_VERSION_1_1 = 1`	#
`public`	`OPENID_NS_2_0 = 'http://specs.openid.net/auth/2.0'` Constant for OpenID namespace Constant for OpenID namespace	#

Properties
`protected`	`array<string, string>`	`$extension_map = ["http://openid.net/extensions/sreg/1.1" => "sreg"]`	#
`protected`	`int`	`$version`	#

Properties inherited from SimpleID\Util\ArrayWrapper
`$container`

Namespaces

Classes

Class SimpleID\Protocols\OpenID\Message

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Returns

Implemented by

Returns

Implemented by