1 <?php

     2 /**

     3  * Zend Framework

     4  *

     5  * LICENSE

     6  *

     7  * This source file is subject to the new BSD license that is bundled

     8  * with this package in the file LICENSE.txt.

     9  * It is also available through the world-wide-web at this URL:

    10  * http://framework.zend.com/license/new-bsd

    11  * If you did not receive a copy of the license and are unable to

    12  * obtain it through the world-wide-web, please send an email

    13  * to license@zend.com so we can send you a copy immediately.

    14  *

    15  * @category   Zend

    16  * @package    Zend_Http

    17  * @subpackage UserAgent

    18  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)

    19  * @license    http://framework.zend.com/license/new-bsd     New BSD License

    20  */

    21 

    22 /**

    23  * @category   Zend

    24  * @package    Zend_Http

    25  * @subpackage UserAgent

    26  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)

    27  * @license    http://framework.zend.com/license/new-bsd     New BSD License

    28  */

    29 interface Zend_Http_UserAgent_Storage

    30 {

    31     /**

    32      * Returns true if and only if storage is empty

    33      *

    34      * @throws Zend_Http_UserAgent_Storage_Exception If it is impossible to determine whether storage is empty

    35      * @return boolean

    36      */

    37     public function isEmpty();

    38 

    39     /**

    40      * Returns the contents of storage associated to the key parameter

    41      *

    42      * Behavior is undefined when storage is empty.

    43      *

    44      * @throws Zend_Http_UserAgent_Storage_Exception If reading contents from storage is impossible

    45      * @return mixed

    46      */

    47     public function read();

    48 

    49     /**

    50      * Writes $contents associated to the key parameter to storage

    51      *

    52      * @param  mixed $contents

    53      * @throws Zend_Http_UserAgent_Storage_Exception If writing $contents to storage is impossible

    54      * @return void

    55      */

    56     public function write($contents);

    57 

    58     /**

    59      * Clears contents from storage

    60      *

    61      * @throws Zend_Http_UserAgent_Storage_Exception If clearing contents from storage is impossible

    62      * @return void

    63      */

    64     public function clear();

    65 }