Source for file Setting.class.php

Documentation is available at Setting.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 Setting
  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.  * Setting Interface
  22.  * 
  23.  * This is a specialized type of List, in name only.  It contains a list of data
  24.  * in key=>value pairs.  It is primarily a helper to some class, or feature for
  25.  * holding information.  The primary difference between a Setting and a List is
  26.  * a Setting requires a key reference (as a string).  This key is used to retrieve
  27.  * a specific piece of information.
  28.  *
  29.  * @category Gumbo
  30.  * @package Setting
  31.  * @copyright Copyright (c) 2007, iBayou, Michael Luster
  32.  * @license http://www.opensource.org/licenses/bsd-license.php New BSD License
  33.  * @author Michael Luster <mluster79@yahoo.com>
  34.  * @link http://sourceforge.net/projects/phpgumbo
  35.  * @desc Setting Interface
  36.  * @version 0.0.1
  37.  */
  38.  
  39. gumbo_load ("Interface_List");
  40.  
  41. interface Gumbo_Interface_Setting extends Gumbo_Interface_List {
  42.     
  43.     /** MUTATOR METHODS **/
  44.     /**
  45.      * Sets the setting values by defining a key=>val pair, or by sending an associative array
  46.      * @param string|array$key 
  47.      * @param mixed $val 
  48.      */
  49.     public function set ($data, $val=null);
  50.     
  51. }
  52.  
  53. ?>