API Documentation

Zend/OpenId/Provider/Storage/File.php

Show: inherited
Table of Contents

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_OpenId  
Subpackage
Zend_OpenId_Provider  
Version
$Id: File.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_OpenId_Provider_Storage_File

Package: Zend\OpenId\Zend\OpenId\Provider

External storage implemmentation using serialized files

Parent(s)
\Zend_OpenId_Provider_Storage
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

Propertyprivatestring  $_dir= ''

Directory name to store data files in

Details
Type
string

Methods

methodpublic__construct( string $dir = null ) : void

Constructs storage object and creates storage directory

Parameters
Name Type Description
$dir string

directory name to store data files in

Throws
Exception Description
\Zend_OpenId_Exception
methodpublicaddAssociation( string $handle, string $macFunc, string $secret, string $expires ) : bool

Stores information about session identified by $handle

Parameters
Name Type Description
$handle string

assiciation handle

$macFunc string

HMAC function (sha1 or sha256)

$secret string

shared secret

$expires string

expiration UNIX time

Returns
Type Description
bool
methodpublicaddSite( string $id, string $site, mixed $trusted ) : bool

Stores information about trusted/untrusted site for given user

Parameters
Name Type Description
$id string

user identity URL

$site string

site URL

$trusted mixed

trust data from extension or just a boolean value

Returns
Type Description
bool
methodpublicaddUser( string $id, string $password ) : bool

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

Parameters
Name Type Description
$id string

user identity URL

$password string

encoded user password

Returns
Type Description
bool
methodpubliccheckUser( string $id, string $password ) : bool

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

Parameters
Name Type Description
$id string

user identity URL

$password string

user password

Returns
Type Description
bool
methodpublicdelAssociation( string $handle ) : bool

Removes information about association identified by $handle

Parameters
Name Type Description
$handle string

assiciation handle

Returns
Type Description
bool
methodpublicdelUser( string $id ) : bool

Removes information abou specified user

Parameters
Name Type Description
$id string

user identity URL

Returns
Type Description
bool
methodpublicgetAssociation( string $handle, string $macFunc, string $secret, string $expires ) : bool

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

Parameters
Name Type Description
$handle string

assiciation handle

$macFunc string

&$macFunc HMAC function (sha1 or sha256)

$secret string

&$secret shared secret

$expires string

&$expires expiration UNIX time

Returns
Type Description
bool
methodpublicgetTrustedSites( string $id ) : array

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

Parameters
Name Type Description
$id string

user identity URL

Returns
Type Description
array
methodpublichasUser( string $id ) : bool

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

Parameters
Name Type Description
$id string

user identity URL

Returns
Type Description
bool
Documentation was generated by DocBlox 0.15.1.