Auth/Storage/Interface.php
Show:
inherited
inheritedZend 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-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Auth
- Subpackage
- Storage
- Version
- $Id$
\Zend_Auth_Storage_Interface
Package: Zend_Auth\Storage
Throws
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Methods
clear() : voidClears contents from storage
Throws
| Exception | Description |
|---|---|
| \Zend_Auth_Storage_Exception | If clearing contents from storage is impossible |
isEmpty() : booleanReturns true if and only if storage is empty
Returns
Throws
| Type | Description |
|---|---|
| boolean |
| Exception | Description |
|---|---|
| \Zend_Auth_Storage_Exception | If it is impossible to determine whether storage is empty |
read() : mixedReturns the contents of storage
Behavior is undefined when storage is empty.
Returns| Type | Description |
|---|---|
| mixed |
| Exception | Description |
|---|---|
| \Zend_Auth_Storage_Exception | If reading contents from storage is impossible |
write(mixed $contents) : voidWrites $contents to storage
Parameters
Throws
| Name | Type | Description |
|---|---|---|
| $contents | mixed |
| Exception | Description |
|---|---|
| \Zend_Auth_Storage_Exception | If writing $contents to storage is impossible |