Zend Framework  1.12
Public Member Functions | List of all members
Zend_OpenId_Consumer_Storage_File Class Reference

Public Member Functions

 __construct ($dir=null)
 Constructs storage object and creates storage directory.
 
 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 otherwise.
 
 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.
 
- Public Member Functions inherited from Zend_OpenId_Consumer_Storage
 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.
 

Constructor & Destructor Documentation

__construct (   $dir = null)

Constructs storage object and creates storage directory.

Parameters
string$dirdirectory name to store data files in
Exceptions
Zend_OpenId_Exception
See Also
Zend_OpenId_Exception
Zend_OpenId_Exception
Zend_OpenId_Exception
Zend_OpenId_Exception

Member Function Documentation

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

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

Parameters
string$urlOpenID server URL
string$handleassiciation handle
string$macFuncHMAC function (sha1 or sha256)
string$secretshared secret
long$expiresexpiration UNIX time
Returns
bool
addDiscoveryInfo (   $id,
  $realId,
  $server,
  $version,
  $expires 
)

Stores information discovered from identity $id.

Parameters
string$ididentity
string$realIddiscovered real identity URL
string$serverdiscovered OpenID server URL
float$versiondiscovered OpenID protocol version
long$expiresexpiration UNIX time
Returns
bool
delAssociation (   $url)

Deletes association identified by $url.

Parameters
string$urlOpenID server URL
Returns
bool
delDiscoveryInfo (   $id)

Removes cached information discovered from identity $id.

Parameters
string$ididentity
Returns
bool
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.

Parameters
string$urlOpenID server URL
string&$handleassiciation handle
string&$macFuncHMAC function (sha1 or sha256)
string&$secretshared secret
long&$expiresexpiration UNIX time
Returns
bool
getAssociationByHandle (   $handle,
$url,
$macFunc,
$secret,
$expires 
)

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

Parameters
string$handleassiciation handle
string&$urlOpenID server URL
string&$macFuncHMAC function (sha1 or sha256)
string&$secretshared secret
long&$expiresexpiration UNIX time
Returns
bool
getDiscoveryInfo (   $id,
$realId,
$server,
$version,
$expires 
)

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

Parameters
string$ididentity
string&$realIddiscovered real identity URL
string&$serverdiscovered OpenID server URL
float&$versiondiscovered OpenID protocol version
long&$expiresexpiration UNIX time
Returns
bool
isUniqueNonce (   $provider,
  $nonce 
)

The function checks the uniqueness of openid.response_nonce.

Parameters
string$provideropenid.openid_op_endpoint field from authentication response
string$nonceopenid.response_nonce field from authentication response
Returns
bool
purgeNonces (   $date = null)

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

Parameters
mixed$datedate of expired data