File indexing completed on 2024-12-22 05:36:52

0001 <?php
0002 /**
0003  * Zend Framework
0004  *
0005  * LICENSE
0006  *
0007  * This source file is subject to the new BSD license that is bundled
0008  * with this package in the file LICENSE.txt.
0009  * It is also available through the world-wide-web at this URL:
0010  * http://framework.zend.com/license/new-bsd
0011  * If you did not receive a copy of the license and are unable to
0012  * obtain it through the world-wide-web, please send an email
0013  * to license@zend.com so we can send you a copy immediately.
0014  *
0015  * @category   Zend
0016  * @package    Zend_Memory
0017  * @copyright  Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
0018  * @license    http://framework.zend.com/license/new-bsd     New BSD License
0019  * @version    $Id$
0020  */
0021 
0022 /**
0023  * Memory value container interface
0024  *
0025  * @category   Zend
0026  * @package    Zend_Memory
0027  * @copyright  Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
0028  * @license    http://framework.zend.com/license/new-bsd     New BSD License
0029  */
0030 interface Zend_Memory_Container_Interface
0031 {
0032     /**
0033      * Get string value reference
0034      *
0035      * _Must_ be used for value access before PHP v 5.2
0036      * or _may_ be used for performance considerations
0037      *
0038      * @return &string
0039      */
0040     public function &getRef();
0041 
0042     /**
0043      * Signal, that value is updated by external code.
0044      *
0045      * Should be used together with getRef()
0046      */
0047     public function touch();
0048 
0049     /**
0050      * Lock object in memory.
0051      */
0052     public function lock();
0053 
0054     /**
0055      * Unlock object
0056      */
0057     public function unlock();
0058 
0059     /**
0060      * Return true if object is locked
0061      *
0062      * @return boolean
0063      */
0064     public function isLocked();
0065 }
0066