classes/kohana/config/reader.php

   1 <?php defined('SYSPATH') or die('No direct script access.');
   2 /**
   3  * Abstract configuration reader. All configuration readers must extend
   4  * this class.
   5  *
   6  * @package    Kohana
   7  * @category   Configuration
   8  * @author     Kohana Team
   9  * @copyright  (c) 2008-2010 Kohana Team
  10  * @license    http://kohanaframework.org/license
  11  */
  12 abstract class Kohana_Config_Reader extends ArrayObject {
  13
  14         // Configuration group name
  15         protected $_configuration_group;
  16
  17         /**
  18          * Loads an empty array as the initial configuration and enables array
  19          * keys to be used as properties.
  20          *
  21          * @return  void
  22          */
  23         public function __construct()
  24         {
  25                 parent::__construct(array(), ArrayObject::ARRAY_AS_PROPS);
  26         }
  27
  28         /**
  29          * Return the current group in serialized form.
  30          *
  31          *     echo $config;
  32          *
  33          * @return  string
  34          */
  35         public function __toString()
  36         {
  37                 return serialize($this->getArrayCopy());
  38         }
  39
  40         /**
  41          * Loads a configuration group.
  42          *
  43          *     $config->load($name, $array);
  44          *
  45          * This method must be extended by all readers. After the group has been
  46          * loaded, call `parent::load($group, $config)` for final preparation.
  47          *
  48          * @param   string  configuration group name
  49          * @param   array   configuration array
  50          * @return  $this   a clone of this object
  51          */
  52         public function load($group, array $config = NULL)
  53         {
  54                 if ($config === NULL)
  55                 {
  56                         return FALSE;
  57                 }
  58
  59                 // Clone the current object
  60                 $object = clone $this;
  61
  62                 // Set the group name
  63                 $object->_configuration_group = $group;
  64
  65                 // Swap the array with the actual configuration
  66                 $object->exchangeArray($config);
  67
  68                 return $object;
  69         }
  70
  71         /**
  72          * Return the raw array that is being used for this object.
  73          *
  74          *     $array = $config->as_array();
  75          *
  76          * @return  array
  77          */
  78         public function as_array()
  79         {
  80                 return $this->getArrayCopy();
  81         }
  82
  83         /**
  84          * Get a variable from the configuration or return the default value.
  85          *
  86          *     $value = $config->get($key);
  87          *
  88          * @param   string   array key
  89          * @param   mixed    default value
  90          * @return  mixed
  91          */
  92         public function get($key, $default = NULL)
  93         {
  94                 return $this->offsetExists($key) ? $this->offsetGet($key) : $default;
  95         }
  96
  97         /**
  98          * Sets a value in the configuration array.
  99          *
 100          *     $config->set($key, $new_value);
 101          *
 102          * @param   string   array key
 103          * @param   mixed    array value
 104          * @return  $this
 105          */
 106         public function set($key, $value)
 107         {
 108                 $this->offsetSet($key, $value);
 109
 110                 return $this;
 111         }
 112
 113 } // End Kohana_Config_Reader