/zf/library/Zend/Memory/Container/Interface.php

 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_Memory
17 * @copyright  Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)
18 * @license    http://framework.zend.com/license/new-bsd     New BSD License
19 * @version    $Id: Interface.php 23775 2011-03-01 17:25:24Z ralph $
20 */
21
22/**
23 * Memory value container interface
24 *
25 * @category   Zend
26 * @package    Zend_Memory
27 * @copyright  Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)
28 * @license    http://framework.zend.com/license/new-bsd     New BSD License
29 */
30interface Zend_Memory_Container_Interface
31{
32    /**
33     * Get string value reference
34     *
35     * _Must_ be used for value access before PHP v 5.2
36     * or _may_ be used for performance considerations
37     *
38     * @return &string
39     */
40    public function &getRef();
41
42    /**
43     * Signal, that value is updated by external code.
44     *
45     * Should be used together with getRef()
46     */
47    public function touch();
48
49    /**
50     * Lock object in memory.
51     */
52    public function lock();
53
54    /**
55     * Unlock object
56     */
57    public function unlock();
58
59    /**
60     * Return true if object is locked
61     *
62     * @return boolean
63     */
64    public function isLocked();
65}
66