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

Public Member Functions

 __construct ($dir=null)
 Constructs storage object and creates storage directory.
 
 addAssociation ($handle, $macFunc, $secret, $expires)
 Stores information about session identified by $handle.
 
 getAssociation ($handle, &$macFunc, &$secret, &$expires)
 Gets information about association identified by $handle Returns true if given association found and not expired and false otherwise.
 
 delAssociation ($handle)
 Removes information about association identified by $handle.
 
 addUser ($id, $password)
 Register new user with given $id and $password Returns true in case of success and false if user with given $id already exists.
 
 hasUser ($id)
 Returns true if user with given $id exists and false otherwise.
 
 checkUser ($id, $password)
 Verify if user with given $id exists and has specified $password.
 
 delUser ($id)
 Removes information abou specified user.
 
 getTrustedSites ($id)
 Returns array of all trusted/untrusted sites for given user identified by $id.
 
 addSite ($id, $site, $trusted)
 Stores information about trusted/untrusted site for given user.
 
- Public Member Functions inherited from Zend_OpenId_Provider_Storage
 addAssociation ($handle, $macFunc, $secret, $expires)
 Stores information about session identified by $handle.
 
 getAssociation ($handle, &$macFunc, &$secret, &$expires)
 Gets information about association identified by $handle Returns true if given association found and not expired and false otherwise.
 
 addUser ($id, $password)
 Register new user with given $id and $password Returns true in case of success and false if user with given $id already exists.
 
 hasUser ($id)
 Returns true if user with given $id exists and false otherwise.
 
 checkUser ($id, $password)
 Verify if user with given $id exists and has specified $password.
 
 getTrustedSites ($id)
 Returns array of all trusted/untrusted sites for given user identified by $id.
 
 addSite ($id, $site, $trusted)
 Stores information about trusted/untrusted site for given user.
 

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

Member Function Documentation

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

Stores information about session identified by $handle.

Parameters
string$handleassiciation handle
string$macFuncHMAC function (sha1 or sha256)
string$secretshared secret
string$expiresexpiration UNIX time
Returns
bool
addSite (   $id,
  $site,
  $trusted 
)

Stores information about trusted/untrusted site for given user.

Parameters
string$iduser identity URL
string$sitesite URL
mixed$trustedtrust data from extension or just a boolean value
Returns
bool
addUser (   $id,
  $password 
)

Register new user with given $id and $password Returns true in case of success and false if user with given $id already exists.

Parameters
string$iduser identity URL
string$passwordencoded user password
Returns
bool
checkUser (   $id,
  $password 
)

Verify if user with given $id exists and has specified $password.

Parameters
string$iduser identity URL
string$passworduser password
Returns
bool
delAssociation (   $handle)

Removes information about association identified by $handle.

Parameters
string$handleassiciation handle
Returns
bool
delUser (   $id)

Removes information abou specified user.

Parameters
string$iduser identity URL
Returns
bool
getAssociation (   $handle,
$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&$macFuncHMAC function (sha1 or sha256)
string&$secretshared secret
string&$expiresexpiration UNIX time
Returns
bool
getTrustedSites (   $id)

Returns array of all trusted/untrusted sites for given user identified by $id.

Parameters
string$iduser identity URL
Returns
array
hasUser (   $id)

Returns true if user with given $id exists and false otherwise.

Parameters
string$iduser identity URL
Returns
bool