API Documentation

OpenId/Provider/Storage/File.php

Includes Classes 
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_OpenId
subpackage
Zend_OpenId_Provider
version
$Id: File.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_OpenId_Provider_Storage_File

Description

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.

Zend_OpenId_Provider_Storage_File
jump to top

Extends from
Zend_OpenId_Provider_Storage
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_OpenId
subpackage
Zend_OpenId_Provider
Properties
$_dir
Methods
__construct
addAssociation
getAssociation
delAssociation
addUser
hasUser
checkUser
delUser
getTrustedSites
addSite

Description

External storage implemmentation using serialized files

Properties

$_dir
jump to class

string $_dir = ''

Directory name to store data files in

Details

$_dir
string
visibility
private
default
final
false
static
false

Methods

__construct
jump to class

__construct( string $dir = null ) :

Constructs storage object and creates storage directory

Arguments
$dir
string
directory name to store data files in
Details
visibility
public
final
false
static
false
throws

addAssociation
jump to class

addAssociation( string $handle, string $macFunc, string $secret, string $expires ) : bool

Stores information about session identified by $handle

Arguments
$handle
string
assiciation handle
$macFunc
string
HMAC function (sha1 or sha256)
$secret
string
shared secret
$expires
string
expiration UNIX time
Output
bool
Details
visibility
public
final
false
static
false

addSite
jump to class

addSite( string $id, string $site, mixed $trusted ) : bool

Stores information about trusted/untrusted site for given user

Arguments
$id
string
user identity URL
$site
string
site URL
$trusted
mixed
trust data from extension or just a boolean value
Output
bool
Details
visibility
public
final
false
static
false

addUser
jump to class

addUser( 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

Arguments
$id
string
user identity URL
$password
string
encoded user password
Output
bool
Details
visibility
public
final
false
static
false

checkUser
jump to class

checkUser( string $id, string $password ) : bool

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

Arguments
$id
string
user identity URL
$password
string
user password
Output
bool
Details
visibility
public
final
false
static
false

delAssociation
jump to class

delAssociation( string $handle ) : bool

Removes information about association identified by $handle

Arguments
$handle
string
assiciation handle
Output
bool
Details
visibility
public
final
false
static
false

delUser
jump to class

delUser( string $id ) : bool

Removes information abou specified user

Arguments
$id
string
user identity URL
Output
bool
Details
visibility
public
final
false
static
false

getAssociation
jump to class

getAssociation( 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

Arguments
$handle
string
assiciation handle
$macFunc
string
&$macFunc HMAC function (sha1 or sha256)
$secret
string
&$secret shared secret
$expires
string
&$expires expiration UNIX time
Output
bool
Details
visibility
public
final
false
static
false

getTrustedSites
jump to class

getTrustedSites( string $id ) : array

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

Arguments
$id
string
user identity URL
Output
array
Details
visibility
public
final
false
static
false

hasUser
jump to class

hasUser( string $id ) : bool

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

Arguments
$id
string
user identity URL
Output
bool
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.