External storage implemmentation using serialized files

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

 Methods

Constructs storage object and creates storage directory

__construct(string $dir = null

Parameters

$dir

string

directory name to store data files in

Exceptions

\Zend_OpenId_Exception

Stores information about association identified by $url/$handle

addAssociation(string $url, string $handle, string $macFunc, string $secret, \long $expires) : boolean
inherited_from \Zend_OpenId_Consumer_Storage::addAssociation()

Parameters

$url

string

OpenID server URL

$handle

string

assiciation handle

$macFunc

string

HMAC function (sha1 or sha256)

$secret

string

shared secret

$expires

\long

expiration UNIX time

Returns

boolean

Stores information about association identified by $url/$handle

addAssociation(string $url, string $handle, string $macFunc, string $secret, \long $expires) : void
Inherited

Parameters

$url

string

OpenID server URL

$handle

string

assiciation handle

$macFunc

string

HMAC function (sha1 or sha256)

$secret

string

shared secret

$expires

\long

expiration UNIX time

Stores information discovered from identity $id

addDiscoveryInfo(string $id, string $realId, string $server, float $version, \long $expires) : boolean
inherited_from \Zend_OpenId_Consumer_Storage::addDiscoveryInfo()

Parameters

$id

string

identity

$realId

string

discovered real identity URL

$server

string

discovered OpenID server URL

$version

float

discovered OpenID protocol version

$expires

\long

expiration UNIX time

Returns

boolean

Stores information discovered from identity $id

addDiscoveryInfo(string $id, string $realId, string $server, float $version, \long $expires) : void
Inherited

Parameters

$id

string

identity

$realId

string

discovered real identity URL

$server

string

discovered OpenID server URL

$version

float

discovered OpenID protocol version

$expires

\long

expiration UNIX time

Deletes association identified by $url

delAssociation(string $url) : boolean
inherited_from \Zend_OpenId_Consumer_Storage::delAssociation()

Parameters

$url

string

OpenID server URL

Returns

boolean

Deletes association identified by $url

delAssociation(string $url) : void
Inherited

Parameters

$url

string

OpenID server URL

Removes cached information discovered from identity $id

delDiscoveryInfo(string $id) : boolean
inherited_from \Zend_OpenId_Consumer_Storage::delDiscoveryInfo()

Parameters

$id

string

identity

Returns

boolean

Removes cached information discovered from identity $id

delDiscoveryInfo(string $id) : boolean
Inherited

Parameters

$id

string

identity

Returns

boolean

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

getAssociation(string $url, $handle, $macFunc, $secret, $expires) : boolean
inherited_from \Zend_OpenId_Consumer_Storage::getAssociation()

Parameters

$url

string

OpenID server URL

$handle

$macFunc

$secret

$expires

Returns

boolean

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

getAssociation(string $url, $handle, $macFunc, $secret, $expires) : boolean
Inherited

Parameters

$url

string

OpenID server URL

$handle

$macFunc

$secret

$expires

Returns

boolean

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

getAssociationByHandle(string $handle, $url, $macFunc, $secret, $expires) : boolean
inherited_from \Zend_OpenId_Consumer_Storage::getAssociationByHandle()

Parameters

$handle

string

assiciation handle

$url

$macFunc

$secret

$expires

Returns

boolean

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

getAssociationByHandle(string $handle, $url, $macFunc, $secret, $expires) : boolean
Inherited

Parameters

$handle

string

assiciation handle

$url

$macFunc

$secret

$expires

Returns

boolean

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

getDiscoveryInfo(string $id, $realId, $server, $version, $expires) : boolean
inherited_from \Zend_OpenId_Consumer_Storage::getDiscoveryInfo()

Parameters

$id

string

identity

$realId

$server

$version

$expires

Returns

boolean

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

getDiscoveryInfo(string $id, $realId, $server, $version, $expires) : boolean
Inherited

Parameters

$id

string

identity

$realId

$server

$version

$expires

Returns

boolean

The function checks the uniqueness of openid.response_nonce

isUniqueNonce(string $provider, string $nonce) : boolean
inherited_from \Zend_OpenId_Consumer_Storage::isUniqueNonce()

Parameters

$provider

string

openid.openid_op_endpoint field from authentication response

$nonce

string

openid.response_nonce field from authentication response

Returns

boolean

The function checks the uniqueness of openid.response_nonce

isUniqueNonce(string $provider, string $nonce) : boolean
Inherited

Parameters

$provider

string

openid.openid_op_endpoint field from authentication response

$nonce

string

openid.response_nonce field from authentication response

Returns

boolean

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

purgeNonces(mixed $date = null
inherited_from \Zend_OpenId_Consumer_Storage::purgeNonces()

Parameters

$date

mixed

date of expired data

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

purgeNonces(string $date = null
Inherited

Parameters

$date

string

Date of expired data

 Properties

 

Directory name to store data files in

$_dir : string

Default