API Documentation

Zend/Auth/Storage/Interface.php

Show: inherited
    Table of Contents

    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.

    Category
    Zend  
    Copyright
    Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
    License
    New BSD License  
    Package
    Zend_Auth  
    Subpackage
    Storage  
    Version
    $Id: Interface.php 24594 2012-01-05 21:27:01Z matthew $  

    \Zend_Auth_Storage_Interface

    Package: Zend\Auth\Storage

    Category
    Zend  
    Copyright
    Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
    License
    New BSD License  

    Methods

    methodpublicclear( ) : void

    Clears contents from storage

    Throws
    Exception Description
    \Zend_Auth_Storage_Exception If clearing contents from storage is impossible
    methodpublicisEmpty( ) : boolean

    Returns true if and only if storage is empty

    Returns
    Type Description
    boolean
    Throws
    Exception Description
    \Zend_Auth_Storage_Exception If it is impossible to determine whether storage is empty
    methodpublicread( ) : mixed

    Returns the contents of storage

    Behavior is undefined when storage is empty.

    Returns
    Type Description
    mixed
    Throws
    Exception Description
    \Zend_Auth_Storage_Exception If reading contents from storage is impossible
    methodpublicwrite( mixed $contents ) : void

    Writes $contents to storage

    Parameters
    Name Type Description
    $contents mixed
    Throws
    Exception Description
    \Zend_Auth_Storage_Exception If writing $contents to storage is impossible
    Documentation was generated by DocBlox 0.15.1.