Zend Framework API Documentation » \Zend_OpenId_Extension

'Simple Refistration Extension' for Zend_OpenId

category	Zend
package	Zend_OpenId
copyright	Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
license	New BSD License
inherited_from	\Zend_OpenId_Extension

Methods

Creates SREG extension object

__construct(array $props = null, string $policy_url = null, float $version = 1.0) : array

Parameters

$props

array

associative array of SREG variables

$policy_url

string

SREG policy URL

$version

float

SREG version

Returns

array

Check if given $data contains necessury SREG properties to sutisfy OpenId request. On success sets SREG response properties from given $data and returns true, on failure returns false.

checkTrustData(array $data) : boolean

inherited_from	\Zend_OpenId_Extension::checkTrustData()

Parameters

$data

array

data from tusted servers database

Returns

boolean

Method to check if data from trusted servers database is enough to sutisfy request.

checkTrustData(array $data) : boolean

Inherited

Parameters

$data

array

data from tusted servers database

Returns

boolean

Calls given function with given argument for all extensions

forAll(mixed $extensions, string $func, $params) : boolean

InheritedStatic

Parameters

$extensions

mixed

list of extensions or one extension

$func

string

function to be called

$params

Returns

boolean

Returns SREG policy URL

getPolicyUrl() : string

Returns

string

Returns associative array of SREG variables

getProperties() : array

Returns

array

Returns array of allowed SREG variable names.

getSregProperties() : array

Static

Returns

array

Addes SREG properties that are allowed to be send to consumer to the given $data argument.

getTrustData($data) : boolean

inherited_from	\Zend_OpenId_Extension::getTrustData()

Parameters

$data

Returns

boolean

Method to prepare data to store it in trusted servers database.

getTrustData($data) : boolean

Inherited

Parameters

$data

Returns

boolean

Returns SREG protocol version

getVersion() : float

Returns

float

Parses OpenId 'checkid_immediate' or 'checkid_setup' request, extracts SREG variables and sets ovject properties to corresponding values.

parseRequest(array $params) : boolean

inherited_from	\Zend_OpenId_Extension::parseRequest()

Parameters

$params

array

request's var/val pairs

Returns

boolean

Method to parse OpenId 'checkid_immediate' or 'checkid_setup' request and initialize object with passed data. This method parses nothing but inherited class may override this method to do somthing.

parseRequest(array $params) : boolean

Inherited

Parameters

$params

array

request's var/val pairs

Returns

boolean

Parses OpenId 'id_res' response and sets object's properties according to 'openid.sreg.*' variables in response

parseResponse(array $params) : boolean

inherited_from	\Zend_OpenId_Extension::parseResponse()

Parameters

$params

array

response's var/val pairs

Returns

boolean

Method to parse OpenId 'id_res' response and initialize object with passed data. This method parses nothing but inherited class may override this method to do somthing.

parseResponse(array $params) : boolean

Inherited

Parameters

$params

array

response's var/val pairs

Returns

boolean

Adds additional SREG data to OpenId 'checkid_immediate' or 'checkid_setup' request.

prepareRequest($params) : boolean

inherited_from	\Zend_OpenId_Extension::prepareRequest()

Parameters

$params

Returns

boolean

Method to add additional data to OpenId 'checkid_immediate' or 'checkid_setup' request. This method addes nothing but inherited class may add additional data into request.

prepareRequest($params) : boolean

Inherited

Parameters

$params

Returns

boolean

Adds additional SREG data to OpenId 'id_res' response.

prepareResponse($params) : boolean

inherited_from	\Zend_OpenId_Extension::prepareResponse()

Parameters

$params

Returns

boolean

Method to add additional data to OpenId 'id_res' response. This method addes nothing but inherited class may add additional data into response.

prepareResponse($params) : boolean

Inherited

Parameters

$params

Returns

boolean

Properties

$_policy_url

$_policy_url

Default

$_props

$_props

Default

$_version

$_version

Default

Constants

SREG 1.1 namespace. All OpenID SREG 1.1 messages MUST contain variable openid.ns.sreg with its value.

NAMESPACE_1_1 = "http://openid.net/extensions/sreg/1.1"