Wrapper for configuration arrays. Multiple configuration readers can be attached to allow loading configuration from files, database, etc.
Configuration directives cascade across config sources in the same way that files cascade across the filesystem.
Directives from sources high in the sources list will override ones from those below them.
Class declared in SYSPATH/classes/config.php on line 3.
Callback used by the config group to store changes made to configuration
string
$group
required - Group namestring
$key
required - Variable namemixed
$value
required - The new valueKohana_Config - Chainable instancepublic function _write_config($group, $key, $value)
{
foreach($this->_sources as $source)
{
if ( ! ($source instanceof Kohana_Config_Writer))
{
continue;
}
// Copy each value in the config
$source->write($group, $key, $value);
}
return $this;
}Attach a configuration reader. By default, the reader will be added as
the first used reader. However, if the reader should be used only when
all other readers fail, use FALSE for the second parameter.
$config->attach($reader); // Try first
$config->attach($reader, FALSE); // Try last
Kohana_Config_Source
$source
required - Instanceboolean
$first
= bool TRUE - Add the reader as the first used object$thispublic function attach(Kohana_Config_Source $source, $first = TRUE)
{
if ($first === TRUE)
{
// Place the log reader at the top of the stack
array_unshift($this->_sources, $source);
}
else
{
// Place the reader at the bottom of the stack
$this->_sources[] = $source;
}
return $this;
}Copy one configuration group to all of the other writers.
$config->copy($name);
string
$group
required - Configuration group name$thispublic function copy($group)
{
// Load the configuration group
$config = $this->load($group);
foreach($config->as_array() as $key => $value)
{
$this->_write_config($group, $key, $value);
}
return $this;
}Detach a configuration reader.
$config->detach($reader);
Kohana_Config_Source
$source
required - Instance$thispublic function detach(Kohana_Config_Source $source)
{
if (($key = array_search($source, $this->_sources)) !== FALSE)
{
// Remove the writer
unset($this->_sources[$key]);
}
return $this;
}Load a configuration group. Searches all the config sources, merging all the directives found into a single config group. Any changes made to the config in this group will be mirrored across all writable sources.
$array = $config->load($name);
See Kohana_Config_Group for more info
string
$group
required - Configuration group nameKohana_Config_Grouppublic function load($group)
{
if( ! count($this->_sources))
{
throw new Kohana_Exception('No configuration sources attached');
}
if (empty($group))
{
throw new Kohana_Exception("Need to specify a config group");
}
if ( ! is_string($group))
{
throw new Kohana_Exception("Config group must be a string");
}
if (strpos($group, '.') !== FALSE)
{
// Split the config group and path
list ($group, $path) = explode('.', $group, 2);
}
if(isset($this->_groups[$group]))
{
if (isset($path))
{
return Arr::path($this->_groups[$group], $path, NULL, '.');
}
return $this->_groups[$group];
}
$config = array();
// We search from the "lowest" source and work our way up
$sources = array_reverse($this->_sources);
foreach ($sources as $source)
{
if ($source instanceof Kohana_Config_Reader)
{
if ($source_config = $source->load($group))
{
$config = Arr::merge($config, $source_config);
}
}
}
$this->_groups[$group] = new Config_Group($this, $group, $config);
if (isset($path))
{
return Arr::path($config, $path, NULL, '.');
}
return $this->_groups[$group];
}