interface/modules/zend_modules/library/Zend/Memory/Container/ContainerInterface.php

   1 <?php
   2 /**
   3  * Zend Framework (http://framework.zend.com/)
   4  *
   5  * @link      http://github.com/zendframework/zf2 for the canonical source repository
   6  * @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
   7  * @license   http://framework.zend.com/license/new-bsd New BSD License
   8  */
   9
  10 namespace Zend\Memory\Container;
  11
  12 /**
  13  * Memory value container interface
  14  */
  15 interface ContainerInterface
  16 {
  17     /**
  18      * Get string value reference
  19      *
  20      * _Must_ be used for value access before PHP v 5.2
  21      * or _may_ be used for performance considerations
  22      *
  23      * @return &string
  24      */
  25     public function &getRef();
  26
  27     /**
  28      * Signal, that value is updated by external code.
  29      *
  30      * Should be used together with getRef()
  31      */
  32     public function touch();
  33
  34     /**
  35      * Lock object in memory.
  36      */
  37     public function lock();
  38
  39     /**
  40      * Unlock object
  41      */
  42     public function unlock();
  43
  44     /**
  45      * Return true if object is locked
  46      *
  47      * @return bool
  48      */
  49     public function isLocked();
  50 }