Modules

  1. +Kohana
    2. Debug
    3. I18n
    4. Kohana
    5. Kohana_Core
    6. Request
    7. Request_Client
    8. Request_Client_External
    9. Request_Client_Internal
    10. Response
    11. Route
    12. UTF8
    13. View
    14. +Cache
      1. Cache_Xcache
    15. +Configuration
      1. Config
      2. Config_File
      3. Config_Reader
    16. +Controller
      1. Controller
      2. Controller_REST
      3. Controller_Template
      4. Controller_Welcome
    17. +Exceptions
      1. HTTP_Exception
      2. HTTP_Exception_400
      3. HTTP_Exception_401
      4. HTTP_Exception_402
      5. HTTP_Exception_403
      6. HTTP_Exception_404
      7. HTTP_Exception_405
      8. HTTP_Exception_406
      9. HTTP_Exception_407
      10. HTTP_Exception_408
      11. HTTP_Exception_409
      12. HTTP_Exception_410
      13. HTTP_Exception_411
      14. HTTP_Exception_412
      15. HTTP_Exception_413
      16. HTTP_Exception_414
      17. HTTP_Exception_415
      18. HTTP_Exception_416
      19. HTTP_Exception_417
      20. HTTP_Exception_500
      21. HTTP_Exception_501
      22. HTTP_Exception_502
      23. HTTP_Exception_503
      24. HTTP_Exception_504
      25. HTTP_Exception_505
      26. Kohana_Exception
      27. Kohana_Request_Exception
      28. Kohana_View_Exception
      29. Validation_Exception
    18. +HTTP
      1. HTTP
      2. HTTP_Header
      3. HTTP_Header_Value
    19. +Helpers
      1. Arr
      2. CLI
      3. Cookie
      4. Date
      5. Feed
      6. File
      7. Form
      8. Fragment
      9. HTML
      10. Inflector
      11. Num
      12. Profiler
      13. Text
      14. URL
      15. Upload
    20. +Logging
      1. Log
      2. Log_File
      3. Log_StdErr
      4. Log_StdOut
      5. Log_Syslog
      6. Log_Writer
    21. +Models
      1. Model
    22. +Security
      1. Encrypt
      2. Security
      3. Valid
      4. Validation
    23. +Session
      1. Session
      2. Session_Cookie
      3. Session_Native
  2. +Kohana/Auth
    2. Auth
    3. Auth_File
    4. Auth_ORM
    5. Model_Auth_Role
    6. Model_Auth_User
    7. Model_Auth_User_Token
    8. Model_Role
    9. Model_User
    10. Model_User_Token
  3. +Kohana/Cache
    2. Cache
    3. Cache_Apc
    4. Cache_Eaccelerator
    5. Cache_File
    6. Cache_Memcache
    7. Cache_MemcacheTag
    8. Cache_Sqlite
    9. Cache_Wincache
    10. Kohana_Cache_Exception
    11. Kohana_Cache_GarbageCollect
    12. Kohana_Cache_Tagging
  4. +Kohana/Codebench
    2. Codebench
    3. +Controllers
      1. Controller_Codebench
    4. +Tests
      1. Bench_ArrCallback
      2. Bench_AutoLinkEmails
      3. Bench_DateSpan
      4. Bench_ExplodeLimit
      5. Bench_GruberURL
      6. Bench_LtrimDigits
      7. Bench_MDDoBaseURL
      8. Bench_MDDoImageURL
      9. Bench_MDDoIncludeViews
      10. Bench_StripNullBytes
      11. Bench_Transliterate
      12. Bench_URLSite
      13. Bench_UserFuncArray
      14. Bench_ValidColor
      15. Bench_ValidURL
  5. +Kohana/Database
    2. DB
    3. Database
    4. Database_Expression
    5. +Configuration
      1. Config_Database
    6. +Drivers
      1. Database_MySQL
      2. Database_PDO
    7. +Exceptions
      1. Database_Exception
    8. +Models
      1. Model_Database
    9. +Query
      1. Database_Query
      2. Database_Query_Builder
      3. Database_Query_Builder_Delete
      4. Database_Query_Builder_Insert
      5. Database_Query_Builder_Join
      6. Database_Query_Builder_Select
      7. Database_Query_Builder_Update
      8. Database_Query_Builder_Where
    10. +Query/Result
      1. Database_MySQL_Result
      2. Database_Result
      3. Database_Result_Cached
    11. +Session
      1. Session_Database
  6. +Kohana/Image
    2. Image
    3. +Drivers
      1. Image_GD
  7. +Kohana/ORM
    2. ORM
    3. ORM_Validation_Exception
  8. +Kohana/Userguide
    2. Kodoc
    3. Kodoc_Class
    4. Kodoc_Markdown
    5. Kodoc_Method
    6. Kodoc_Method_Param
    7. Kodoc_Property
    8. +Controllers
      1. Controller_Userguide
    9. +Undocumented
      1. Kodoc_Missing
  9. +[Unknown]
    2. HTTP_Interaction
    3. HTTP_Request
    4. HTTP_Response

Kohana_Config

Wrapper for configuration arrays. Multiple configuration readers can be attached to allow loading configuration from files, database, etc.

package
Kohana
category
Configuration
author
Kohana Team
copyright
© 2009-2012 Kohana Team
license
http://kohanaframework.org/license

Class declared in SYSPATH/classes/kohana/config.php on line 12.

Constants

  • None

Properties

Methods

Properties

protected static Kohana_Config $_instance

Singleton static instance

object Config()

protected array $_readers

Configuration readers

Methods

public attach( Config_Reader $reader [, boolean $first = bool TRUE ] ) (defined in Kohana_Config)

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

Parameters

  • Config_Reader $reader required - Config_Reader instance
  • boolean $first = bool TRUE - Add the reader as the first used object

Return Values

  • $this

Source Code

?
public function attach(Config_Reader $reader, $first = TRUE)
{
    if ($first === TRUE)
    {
        // Place the log reader at the top of the stack
        array_unshift($this->_readers, $reader);
    }
    else
    {
        // Place the reader at the bottom of the stack
        $this->_readers[] = $reader;
    }
 
    return $this;
}

public copy( string $group ) (defined in Kohana_Config)

Copy one configuration group to all of the other readers.

?
$config->copy($name);

Parameters

  • string $group required - Configuration group name

Return Values

  • $this

Source Code

?
public function copy($group)
{
    // Load the configuration group
    $config = $this->load($group);
 
    foreach ($this->_readers as $reader)
    {
        if ($config instanceof $reader)
        {
            // Do not copy the config to the same group
            continue;
        }
 
        // Load the configuration object
        $object = $reader->load($group, array());
 
        foreach ($config as $key => $value)
        {
            // Copy each value in the config
            $object->offsetSet($key, $value);
        }
    }
 
    return $this;
}

public detach( Config_Reader $reader ) (defined in Kohana_Config)

Detach a configuration reader.

?
$config->detach($reader);

Parameters

  • Config_Reader $reader required - $source Config_Reader instance

Return Values

  • $this

Source Code

?
public function detach(Config_Reader $reader)
{
    if (($key = array_search($reader, $this->_readers)) !== FALSE)
    {
        // Remove the writer
        unset($this->_readers[$key]);
    }
 
    return $this;
}

public static instance( ) (defined in Kohana_Config)

Get the singleton instance of Config.

?
$config = Config::instance();

Return Values

  • Config

Source Code

?
public static function instance()
{
    if (Config::$_instance === NULL)
    {
        // Create a new instance
        Config::$_instance = new Config;
    }
 
    return Config::$_instance;
}

public load( string $group ) (defined in Kohana_Config)

Load a configuration group. Searches the readers in order until the group is found. If the group does not exist, an empty configuration array will be loaded using the first reader.

?
$array = $config->load($name);

Parameters

  • string $group required - Configuration group name

Tags

Return Values

  • Config_Reader

Source Code

?
public function load($group)
{
    foreach ($this->_readers as $reader)
    {
        if ($config = $reader->load($group))
        {
            // Found a reader for this configuration group
            return $config;
        }
    }
 
    // Reset the iterator
    reset($this->_readers);
 
    if ( ! is_object($config = current($this->_readers)))
    {
        throw new Kohana_Exception('No configuration readers attached');
    }
 
    // Load the reader as an empty array
    return $config->load($group, array());
}