Source for file Lockable.class.php

Documentation is available at Lockable.class.php

  1. <?php
  2. /**
  3.  * Gumbo Library Framework
  4.  *
  5.  * LICENSE
  6.  * This library is being released under the terms of the New BSD License.  A
  7.  * copy of the license is packaged with the software (LICENSE.txt).  If no
  8.  * copy is found, a copy of the license template can be found at:
  9.  * http://www.opensource.org/licenses/bsd-license.php
  10.  * 
  11.  * @category Gumbo
  12.  * @package Lockable
  13.  * @copyright Copyright (c) 2007, iBayou, Michael Luster
  14.  * @license http://www.opensource.org/licenses/bsd-license.php New BSD License
  15.  * @author Michael Luster <mluster79@yahoo.com>
  16.  * @link http://sourceforge.net/projects/phpgumbo
  17.  * @version 0.0.1
  18.  */
  19.  
  20. /**
  21.  * Lockable Interface
  22.  * 
  23.  * This just indicates a particular object can be locked, preserving it's state
  24.  * so no changes can be made to it.  Once the object is locked, it should not be
  25.  * allowed to be unlocked from the outside.
  26.  *
  27.  * @category Gumbo
  28.  * @package Lockable
  29.  * @copyright Copyright (c) 2007, iBayou, Michael Luster
  30.  * @license http://www.opensource.org/licenses/bsd-license.php New BSD License
  31.  * @author Michael Luster <mluster79@yahoo.com>
  32.  * @link http://sourceforge.net/projects/phpgumbo
  33.  * @desc Lockable Interface
  34.  * @version 0.0.1
  35.  */
  36.  
  37. interface Gumbo_Interface_Lockable {
  38.     
  39.     /**
  40.      * Locks an object
  41.      * @postcondition isLocked()
  42.      */
  43.     public function lock ();
  44.     
  45.     /**
  46.      * Returns if the object is currently locked
  47.      * @return bool 
  48.      */
  49.     public function isLocked ();
  50.     
  51. }
  52.  
  53. ?>