Annajwaszahro
/
MIF_E31222691
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

added better comments to config class.

This commit is contained in:
Taylor Otwell 2011-09-21 22:34:01 -05:00
parent 23ccc0a6a4
commit 1a028e6487
1 changed files with 39 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
laravel/config.php
View File

@ -1,4 +1,4 @@
<?php namespace Laravel; <?php namespace Laravel; use Closure;
class Config { class Config {
@ -32,6 +32,14 @@ public static function paths($paths)
/** /**
* Determine if a configuration item or file exists. * Determine if a configuration item or file exists.
* *
* <code>
* // Determine if the "session" configuration file exists
* $exists = Config::has('session');
*
* // Determine if the "timezone" option exists in the "application" configuration array
* $exists = Config::has('application.timezone');
* </code>
*
* @param string $key * @param string $key
* @return bool * @return bool
*/ */
@ -43,6 +51,16 @@ public static function has($key)
/** /**
* Get a configuration item. * Get a configuration item.
* *
* If no item is requested, the entire configuration array will be returned.
*
* <code>
* // Get the "session" configuration array
* $session = Config::get('session');
*
* // Get the "timezone" option from the "application" configuration file
* $timezone = Config::get('application.timezone');
* </code>
*
* @param string $key * @param string $key
* @param string $default * @param string $default
* @return array * @return array
@ -53,7 +71,7 @@ public static function get($key, $default = null)
if ( ! static::load($file)) if ( ! static::load($file))
{ {
return ($default instanceof \Closure) ? call_user_func($default) : $default; return ($default instanceof Closure) ? call_user_func($default) : $default;
} }
if (is_null($key)) return static::$items[$file]; if (is_null($key)) return static::$items[$file];
@ -62,7 +80,15 @@ public static function get($key, $default = null)
} }
/** /**
* Set a configuration item. * Set a configuration item's value.
*
* <code>
* // Set the "session" configuration array
* Config::set('session', $array);
*
* // Set the "timezone" option in the "application" configuration file
* Config::set('application.timezone', 'UTC');
* </code>
* *
* @param string $key * @param string $key
* @param mixed $value * @param mixed $value
@ -87,13 +113,15 @@ protected static function parse($key)
{ {
$segments = explode('.', $key); $segments = explode('.', $key);
// If there is only one segment after exploding on dots, we will return NULL
// as the key value, causing the entire configuration array to be returned.
$key = (count($segments) > 1) ? implode('.', array_slice($segments, 1)) : null; $key = (count($segments) > 1) ? implode('.', array_slice($segments, 1)) : null;
return array($segments[0], $key); return array($segments[0], $key);
} }
/** /**
* Load all of the configuration items from a module configuration file. * Load all of the configuration items from a configuration file.
* *
* @param string $file * @param string $file
* @return bool * @return bool
@ -104,6 +132,9 @@ protected static function load($file)
$config = array(); $config = array();
// Configuration files cascade. Typically, the system configuration array is loaded
// first, followed by the application array, followed by the environment array.
// This allows the convenient overriding of configuration options.
foreach (static::$paths as $directory) foreach (static::$paths as $directory)
{ {
if (file_exists($path = $directory.$file.EXT)) if (file_exists($path = $directory.$file.EXT))
@ -112,10 +143,10 @@ protected static function load($file)
} }
} }
if (count($config) > 0) // If configuration options were actually found, they will be loaded into the
{ // array containing all of the options for all files. The array is keyed by the
static::$items[$file] = $config; // configuration file name.
} if (count($config) > 0) static::$items[$file] = $config;
return isset(static::$items[$file]); return isset(static::$items[$file]);
} }