Zend_OpenId_Extension_Sreg Class Reference

Public Member Functions
	__construct (array $props=null, $policy_url=null, $version=1.0)
	Creates SREG extension object.
	getProperties ()
	Returns associative array of SREG variables.
	getPolicyUrl ()
	Returns SREG policy URL.
	getVersion ()
	Returns SREG protocol version.
	prepareRequest (&$params)
	Adds additional SREG data to OpenId 'checkid_immediate' or 'checkid_setup' request.
	parseRequest ($params)
	Parses OpenId 'checkid_immediate' or 'checkid_setup' request, extracts SREG variables and sets ovject properties to corresponding values.
	prepareResponse (&$params)
	Adds additional SREG data to OpenId 'id_res' response.
	parseResponse ($params)
	Parses OpenId 'id_res' response and sets object's properties according to 'openid.sreg.
	getTrustData (&$data)
	Addes SREG properties that are allowed to be send to consumer to the given $data argument.
	checkTrustData ($data)
	Check if given $data contains necessury SREG properties to sutisfy OpenId request.
Public Member Functions inherited from Zend_OpenId_Extension
	prepareRequest (&$params)
	Method to add additional data to OpenId 'checkid_immediate' or 'checkid_setup' request.
	parseRequest ($params)
	Method to parse OpenId 'checkid_immediate' or 'checkid_setup' request and initialize object with passed data.
	prepareResponse (&$params)
	Method to add additional data to OpenId 'id_res' response.
	parseResponse ($params)
	Method to parse OpenId 'id_res' response and initialize object with passed data.
	getTrustData (&$data)
	Method to prepare data to store it in trusted servers database.
	checkTrustData ($data)
	Method to check if data from trusted servers database is enough to sutisfy request.

Static Public Member Functions
static	getSregProperties ()
	Returns array of allowed SREG variable names.
Static Public Member Functions inherited from Zend_OpenId_Extension
static	forAll ($extensions, $func, &$params)
	Calls given function with given argument for all extensions.

Public Attributes
const	NAMESPACE_1_1 = "http://openid.net/extensions/sreg/1.1"
	SREG 1.1 namespace.

Constructor & Destructor Documentation

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

Creates SREG extension object.

Parameters

array	$props	associative array of SREG variables
string	$policy_url	SREG policy URL
float	$version	SREG version

Returns

array

Member Function Documentation

checkTrustData

(

$data

)

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.

Parameters

array

$data

data from tusted servers database

Returns

bool

getPolicyUrl

(

)

Returns SREG policy URL.

Returns

string

getProperties

(

)

Returns associative array of SREG variables.

Returns

array

static getSregProperties ( )

static

Returns array of allowed SREG variable names.

Returns

array

getTrustData

(

&

$data

)

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

Parameters

array

&$data

data to be stored in tusted servers database

Returns

bool

getVersion

(

)

Returns SREG protocol version.

Returns

float

parseRequest

(

$params

)

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

Parameters

array

$params

request's var/val pairs

Returns

bool

parseResponse

(

$params

)

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

*' variables in response

Parameters

array

$params

response's var/val pairs

Returns

bool

prepareRequest

(

&

$params

)

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

Parameters

array

&$params

request's var/val pairs

Returns

bool

prepareResponse

(

&

$params

)

Adds additional SREG data to OpenId 'id_res' response.

Parameters

array

&$params

response's var/val pairs

Returns

bool

Member Data Documentation

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

SREG 1.1 namespace.

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