Zend Framework  3.0
Public Member Functions | List of all members
StorageInterface Interface Reference

Public Member Functions

 isEmpty ()
 Returns true if and only if storage is empty.
 
 read ()
 Returns the contents of storage.
 
 write ($contents)
 Writes $contents to storage.
 
 clear ()
 Clears contents from storage.
 

Member Function Documentation

clear ( )

Clears contents from storage.

Exceptions
\Zend\Authentication\Exception\ExceptionInterfaceIf clearing contents from storage is impossible
Returns
void

Implemented in Session, Chain, and NonPersistent.

isEmpty ( )

Returns true if and only if storage is empty.

Exceptions
\Zend\Authentication\Exception\ExceptionInterfaceIf it is impossible to determine whether storage is empty
Returns
bool

Implemented in Session, Chain, and NonPersistent.

read ( )

Returns the contents of storage.

Behavior is undefined when storage is empty.

Exceptions
\Zend\Authentication\Exception\ExceptionInterfaceIf reading contents from storage is impossible
Returns
mixed

Implemented in Session, Chain, and NonPersistent.

write (   $contents)

Writes $contents to storage.

Parameters
mixed$contents
Exceptions
\Zend\Authentication\Exception\ExceptionInterfaceIf writing $contents to storage is impossible
Returns
void

Implemented in Session, Chain, and NonPersistent.