Docs For Class ConfigurationReader

Description

This class provides methods for reading Database driven Configurations.

It is designed to be used as static class, to avoid instantiation.
Use it as follows:

 $bar = ConfigurationReader::getConfigurationEntry('foo', 'bar');

Method Summary

array getAll ()

ConfigurationEntry getConfigurationEntry (String $package, String $name)

mixed getConfigurationValue (String $package, String $name, [mixed $undefined = null])

array getPackage (String $package)

Methods

getAll (line 51)

Gets all Configuration Values available.

Calls will never be cached.

array getAll ()

getConfigurationEntry (line 103)

Fetch a known ConfigurationEntry from a Configuration Package.

ConfigurationEntry getConfigurationEntry (String $package, String $name)

getConfigurationValue (line 131)

Returns the Value of a ConfigurationEntry, or

$undefined

if the requested Configuration Entry could not be found.

No need of explicit casting for:

mixed getConfigurationValue (String $package, String $name, [mixed $undefined = null])

getPackage (line 77)

All Value of the Package will be fetched and returned as an Array of

ConfigurationEntry

instances.

This method call caches its Results (if not NULL).
If a Package was read, Calls against the same package within the methods

getConfigurationEntry()

and

getConfigurationValue()

will fetch their results from this cached Package.
If you want to read more than ONE entry/value of a Package it is always recommended to call

getPackage($package)

first to fill the cache and speed up the Calls (less DB calls).

array getPackage (String $package)