Docs For Class Cfg

Description

A class for accessing application-level configuration information.

This class is a wrapper around an array of configuration information. It obtains the array by calling Support_Resources::config_data(). The default implementation simply uses a global array named APP_CONFIG which it obtains by including the file config.php (which can be located anywhere in the include path). In addition to providing some basic conveniences over direct array access, part of this class's purpose is to provide a simple layer of abstraction around the storage of the configuration values. More advanced applications could replace the provider in Resources with one that retrieves configuration information from an XML file (or other formatted text file) or a database (or even some combination of the two.

This class allows configuration properties to be divided into sections. Sections are separated from the property name using a forward slash character (/). Sections may be nested up to arbitrary depths, but an enclosing section is not required. The forward slash character can therefore not be used in any property name. Sections are implemented in the global array as a nested array.

An example config file (using the default provider):

$APP_CONFIG['ApplicationName'] = 'My App';
$APP_CONFIG['SessionKey'] = 'MYAPPSESS';
$APP_CONFIG['SessionExpires'] = 120;
$APP_CONFIG['Database'] = array(
'Host' => 'localhost',
'User' => 'fred',
'Password' => 'secret');
$APP_CONFIG['RemoteFTP'] = array(
'Host' => '192.168.0.5',
'User' => 'www',
'Password', => '*****');

Of course, the config file is just a PHP file, so any valid PHP code can be used to build the structure.

Examples, of accessing the configuration information:

Cfg::get('ApplicationName'); // => 'My App'
Cfg::get('MOTD'); // => NULL
Cfg::get('BackgroundColor', 0xFFFFFF); // 0xFFFFFF
Cfg::get('SessionExpires'); // => 120
Cfg::get('Database/Host'); // => 'localhost'
Cfg::get('RemoteFTP/Host'); // => '192.168.0.5'
Cfg::get_required('Database/User'); // => 'fred'
Cfg::get_required('Database/Schema'); // throws MissingRequiredConfigurationError

Located in /support/lib/Cfg.php (line 85)

Variable Summary

static mixed $data

Method Summary

static bool exists (string $key)

static bool find_key (string $key, string &$value)

static mixed get (string $key, [string $default = NULL])

static mixed get_required (string $key)

Variables

static mixed $data = null (line 86)

access: protected

Methods

static exists (line 129)

Test for the existence of a key in the configuration.

access: public

bool exists (string $key)

string $key: The name of the key to test

static find_key (line 142)

Locate the named key in the configuration.

return: Returns true if the key was found, false otherwise
access: protected

bool find_key (string $key, string &$value)

string $key: The name of the key to find
string &$value: Output parameter for the key's value if found

static get (line 98)

Returns the value of the given key in the configuration. If they key does not exist, any default value provided is returned instead (or NULL if none is provided).

access: public

mixed get (string $key, [string $default = NULL])

string $key: The name of the key to retrieve
string $default: The default value to return if not key exists (optional)

static get_required (line 114)

Returns the value of the given key in the configuration. If they key does not exist, MissingRequiredConfigurationError is thrown instead.

access: public

mixed get_required (string $key)

string $key: The name of the key to retrieve