Source for file Settings.class.php

Documentation is available at Settings.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.  * Settings Interface
  22.  * 
  23.  * A Settings Class can hold any number of Setting objects.  Each Setting will be
  24.  * required to have a key associated with it.  This will allow the program
  25.  * to access particular Setting Objects thru a key reference.
  26.  *
  27.  * @category Gumbo
  28.  * @package Setting
  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 Settings Interface
  34.  * @version 0.0.1
  35.  */
  36.  
  37. interface Gumbo_Interface_Settings {
  38.     
  39.     /**
  40.      * Adds a setting, overwriting the original setting if exists
  41.      * @postcondition remove all non alpha-numeric (except underscores) characters from $key
  42.      * @param Gumbo_Interface_Setting $setting 
  43.      * @param string $key reference key
  44.      */
  45.     public function addSetting (Gumbo_Interface_Setting $setting, $key);
  46.     
  47.     /**
  48.      * Removes a Setting
  49.      * @param string $key 
  50.      */
  51.     public function removeSetting ($key);
  52.     
  53.     /**
  54.      * Resets all Settings
  55.      * @postcondition clears all settings
  56.      */
  57.     public function resetSettings ();
  58.     
  59.     
  60.     
  61.     /**
  62.      * Returns the list of all Settings
  63.      * @return Gumbo_Interface_Setting[] 
  64.      */
  65.     public function getSettings ();
  66.     
  67.     /**
  68.      * Returns a single Setting object based on the key
  69.      * @param string $key 
  70.      * @return Gumbo_Interface_Setting 
  71.      */
  72.     public function getSetting ($key);
  73.     
  74.     /**
  75.      * Returns if a Setting exists
  76.      * @param string $key 
  77.      * @return bool 
  78.      */
  79.     public function isSetting ($key);
  80.     
  81. }
  82.  
  83. ?>