API Documentation

OpenId/Consumer/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_Consumer
version
$Id: File.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_OpenId_Consumer_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_Consumer_Storage_File
jump to top

Extends from
Zend_OpenId_Consumer_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_Consumer
Properties
$_dir
Methods
__construct
addAssociation
getAssociation
getAssociationByHandle
delAssociation
addDiscoveryInfo
getDiscoveryInfo
delDiscoveryInfo
isUniqueNonce
purgeNonces

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 $url, string $handle, string $macFunc, string $secret, long $expires ) : bool

Stores information about association identified by $url/$handle

Arguments
$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
Output
bool
Details
visibility
public
final
false
static
false

addDiscoveryInfo
jump to class

addDiscoveryInfo( string $id, string $realId, string $server, float $version, long $expires ) : bool

Stores information discovered from identity $id

Arguments
$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
Output
bool
Details
visibility
public
final
false
static
false

delAssociation
jump to class

delAssociation( string $url ) : bool

Deletes association identified by $url

Arguments
$url
string
OpenID server URL
Output
bool
Details
visibility
public
final
false
static
false

delDiscoveryInfo
jump to class

delDiscoveryInfo( string $id ) : bool

Removes cached information discovered from identity $id

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

getAssociation
jump to class

getAssociation( string $url, string $handle, string $macFunc, string $secret, long $expires ) : bool

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

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

getAssociationByHandle
jump to class

getAssociationByHandle( string $handle, string $url, string $macFunc, string $secret, long $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
$url
string
&$url OpenID server URL
$macFunc
string
&$macFunc HMAC function (sha1 or sha256)
$secret
string
&$secret shared secret
$expires
long
&$expires expiration UNIX time
Output
bool
Details
visibility
public
final
false
static
false

getDiscoveryInfo
jump to class

getDiscoveryInfo( string $id, string $realId, string $server, float $version, long $expires ) : bool

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

Arguments
$id
string
identity
$realId
string
&$realId discovered real identity URL
$server
string
&$server discovered OpenID server URL
$version
float
&$version discovered OpenID protocol version
$expires
long
&$expires expiration UNIX time
Output
bool
Details
visibility
public
final
false
static
false

isUniqueNonce
jump to class

isUniqueNonce( string $provider, string $nonce ) : bool

The function checks the uniqueness of openid.response_nonce

Arguments
$provider
string
openid.openid_op_endpoint field from authentication response
$nonce
string
openid.response_nonce field from authentication response
Output
bool
Details
visibility
public
final
false
static
false

purgeNonces
jump to class

purgeNonces( mixed $date = null ) :

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

Arguments
$date
mixed
date of expired data
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.