OpenId/Consumer/Storage/File.php
inherited
Classes
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_OpenId
- Subpackage
- Zend_OpenId_Consumer
- Version
- $Id$
\Zend_OpenId_Consumer_Storage_File
- Parent(s)
- \Zend_OpenId_Consumer_Storage
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties
Methods
__construct(string $dir = null) : voidConstructs storage object and creates storage directory
| Name | Type | Description |
|---|---|---|
| $dir | string | directory name to store data files in |
| Exception | Description |
|---|---|
| \Zend_OpenId_Exception |
addAssociation(string $url, string $handle, string $macFunc, string $secret, \long $expires) : boolStores information about association identified by $url/$handle
| Name | Type | Description |
|---|---|---|
| $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 |
| Type | Description |
|---|---|
| bool |
addDiscoveryInfo(string $id, string $realId, string $server, float $version, \long $expires) : boolStores information discovered from identity $id
| Name | Type | Description |
|---|---|---|
| $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 |
| Type | Description |
|---|---|
| bool |
delAssociation(string $url) : boolDeletes association identified by $url
| Name | Type | Description |
|---|---|---|
| $url | string | OpenID server URL |
| Type | Description |
|---|---|
| bool |
delDiscoveryInfo(string $id) : boolRemoves cached information discovered from identity $id
| Name | Type | Description |
|---|---|---|
| $id | string | identity |
| Type | Description |
|---|---|
| bool |
getAssociation(string $url, $handle, $macFunc, $secret, $expires) : boolGets information about association identified by $url Returns true if given association found and not expired and false otherwise
| Name | Type | Description |
|---|---|---|
| $url | string | OpenID server URL |
| $handle | ||
| $macFunc | ||
| $secret | ||
| $expires |
| Type | Description |
|---|---|
| bool |
getAssociationByHandle(string $handle, $url, $macFunc, $secret, $expires) : boolGets information about association identified by $handle Returns true if given association found and not expired and false otherwise
| Name | Type | Description |
|---|---|---|
| $handle | string | assiciation handle |
| $url | ||
| $macFunc | ||
| $secret | ||
| $expires |
| Type | Description |
|---|---|
| bool |
getDiscoveryInfo(string $id, $realId, $server, $version, $expires) : boolGets information discovered from identity $id Returns true if such information exists and false otherwise
| Name | Type | Description |
|---|---|---|
| $id | string | identity |
| $realId | ||
| $server | ||
| $version | ||
| $expires |
| Type | Description |
|---|---|
| bool |
isUniqueNonce(string $provider, string $nonce) : boolThe function checks the uniqueness of openid.response_nonce
| Name | Type | Description |
|---|---|---|
| $provider | string | openid.openid_op_endpoint field from authentication response |
| $nonce | string | openid.response_nonce field from authentication response |
| Type | Description |
|---|---|
| bool |
purgeNonces(mixed $date = null) : voidRemoves data from the uniqueness database that is older then given date
| Name | Type | Description |
|---|---|---|
| $date | mixed | date of expired data |