Zend_OpenId_Consumer_Storage Class Reference

Public Member Functions
	addAssociation ($url, $handle, $macFunc, $secret, $expires)
	Stores information about association identified by $url/$handle.
	getAssociation ($url, &$handle, &$macFunc, &$secret, &$expires)
	Gets information about association identified by $url Returns true if given association found and not expired and false otherwise.
	getAssociationByHandle ($handle, &$url, &$macFunc, &$secret, &$expires)
	Gets information about association identified by $handle Returns true if given association found and not expired and false othverwise.
	delAssociation ($url)
	Deletes association identified by $url.
	addDiscoveryInfo ($id, $realId, $server, $version, $expires)
	Stores information discovered from identity $id.
	getDiscoveryInfo ($id, &$realId, &$server, &$version, &$expires)
	Gets information discovered from identity $id Returns true if such information exists and false otherwise.
	delDiscoveryInfo ($id)
	Removes cached information discovered from identity $id.
	isUniqueNonce ($provider, $nonce)
	The function checks the uniqueness of openid.response_nonce.
	purgeNonces ($date=null)
	Removes data from the uniqueness database that is older then given date.

Member Function Documentation

addAssociation (   $url,   $handle,   $macFunc,   $secret,   $expires  )

abstract

Stores information about association identified by $url/$handle.

Parameters

string	$url	OpenID server URL
string	$handle	assiciation handle
string	$macFunc	HMAC function (sha1 or sha256)
string	$secret	shared secret
long	$expires	expiration UNIX time

Returns

void

addDiscoveryInfo (   $id,   $realId,   $server,   $version,   $expires  )

abstract

Stores information discovered from identity $id.

Parameters

string	$id	identity
string	$realId	discovered real identity URL
string	$server	discovered OpenID server URL
float	$version	discovered OpenID protocol version
long	$expires	expiration UNIX time

Returns

void

delAssociation (   $url )

abstract

Deletes association identified by $url.

Parameters

string

$url

OpenID server URL

Returns

void

delDiscoveryInfo (   $id )

abstract

Removes cached information discovered from identity $id.

Parameters

string

$id

identity

Returns

bool

getAssociation (   $url, &  $handle, &  $macFunc, &  $secret, &  $expires  )

abstract

Gets information about association identified by $url Returns true if given association found and not expired and false otherwise.

Parameters

string	$url	OpenID server URL
string	&$handle	assiciation handle
string	&$macFunc	HMAC function (sha1 or sha256)
string	&$secret	shared secret
long	&$expires	expiration UNIX time

Returns

bool

getAssociationByHandle (   $handle, &  $url, &  $macFunc, &  $secret, &  $expires  )

abstract

Gets information about association identified by $handle Returns true if given association found and not expired and false othverwise.

Parameters

string	$handle	assiciation handle
string	&$url	OpenID server URL
string	&$macFunc	HMAC function (sha1 or sha256)
string	&$secret	shared secret
long	&$expires	expiration UNIX time

Returns

bool

getDiscoveryInfo (   $id, &  $realId, &  $server, &  $version, &  $expires  )

abstract

Gets information discovered from identity $id Returns true if such information exists and false otherwise.

Parameters

string	$id	identity
string	&$realId	discovered real identity URL
string	&$server	discovered OpenID server URL
float	&$version	discovered OpenID protocol version
long	&$expires	expiration UNIX time

Returns

bool

isUniqueNonce (   $provider,   $nonce  )

abstract

The function checks the uniqueness of openid.response_nonce.

Parameters

string	$provider	openid.openid_op_endpoint field from authentication response
string	$nonce	openid.response_nonce field from authentication response

Returns

bool

purgeNonces (   $date = null )

abstract

Removes data from the uniqueness database that is older then given date.

Parameters

string

$date

Date of expired data