Class Configuration

Provides access to core the configuration and application settings with support for drivers.

Each entry has a key and value and can be accessed as such; keys use a namespace pattern. Values have a type associated with them to validate and automatically parse/un-parse them for storage.

Core\Object implements Core\Chainable

Core\Set implements Core\Accessor

Core\Set\Mutable implements Core\Mutator

Core\Field implements Core\Inquiry

Core\Field\Mutable implements Core\Variator

Core\Configuration

Direct known subclasses

Core\Configuration\Driver\constant, Core\Configuration\Driver\ini, Core\Configuration\Driver\yaml

Abstract
Namespace: Core
Package: Core
Since: 3.2
Requires: PHP 5.3
Version: 1.0
Located at Configuration.inc.php

Methods summary

`protected`	# `__construct( Core\URI $uri )` Driver initialisation. Driver initialisation. Parameters `$uri` Driver configuration URI. Since 3.2
`public static Core\Configuration`	# `autocreate( Core\URI $uri )` Configuration driver factory. Configuration driver factory. Parameters `$uri` Driver configuration URI. Returns `Core\Configuration` New configuration driver instance. Since 3.2
`public static string`	# `decodeClassName( string $identifier )` Decodes configuration notion of class identifiers by transforming the string to camel-case and replacing dots (`"."`) and colons (`":"`) by namespace separators. Decodes configuration notion of class identifiers by transforming the string to camel-case and replacing dots (`"."`) and colons (`":"`) by namespace separators. The notion is usually used in configuration files for improved readability. Parameters `$identifier` Class name identifier using camel-case notion and dots (`"."`) as namespace separators. If an already PHP-style class names is passed, it is returned normalised. Returns string Decoded class name. Since 3.2
`public mixed`	# `get( string $key, mixed $default = null )` Retrieves a configuration option or a given default value, if the configuration option is not defined. Retrieves a configuration option or a given default value, if the configuration option is not defined. Parameters `$key` Name of configuration option to retrieve. `$default` Default value to return, if configuration option is not defined. Returns mixed Since 3.2
`public array`	# `getArray( string $key, mixed $default = null )` Retrieves a configuration option as an array. If the option is the default value given are not an array, the value is converted into an array. Retrieves a configuration option as an array. If the option is the default value given are not an array, the value is converted into an array. Parameters `$key` Name of configuration option to retrieve. `$default` Default value to return, if configuration option is not defined. Returns array Configuration option value array. If the option yields `null`, an empty array is returned. Since 3.2
`public mixed`	# `getDataForUndefinedKey( string $key )` Retrieves a configuration option or `null`, if the configuration option is not defined. Retrieves a configuration option or `null`, if the configuration option is not defined. Parameters `$key` Name of configuration option to retrieve. Returns mixed Throws `Core\Exception\UndefinedKey` Failed to resolve data field for the given key. Since 3.2 Overrides `Core\Field::getDataForUndefinedKey`
`public Core\Value`	# `getValue( string $key, mixed $default = null )` Retrieves a configuration option or a given default value, if the configuration option is not defined, as a value instance. Retrieves a configuration option or a given default value, if the configuration option is not defined, as a value instance. Parameters `$key` Name of configuration option to retrieve. `$default` Default value to return, if configuration option is not defined. Returns `Core\Value` Value instance of retrieved option value. Since 3.2
`protected mixed`	# `_lookup( $key )` Retrieves the raw value for a given key from the back-end storage. Retrieves the raw value for a given key from the back-end storage. Parameters `$key` of configuration option to retrieve. Returns mixed Raw configuration value. Remark The standard implementation assumes that the internal field data is an associative recursive array. Drivers that implement a different buffer or retrieval method should override this method accordingly. Since 3.2

Constants summary

Constants inherited from Core\Object

AnyParameterType, AutochainParameterType, AutocreateParameterType, BooleanParameterType, CharParameterType, EnumParameterType, IntegerParameterType, RealParameterType, StringParameterType, UserParameterType

Properties summary

`protected array`	`$_v_parameters` Driver configuration parameters. Driver configuration parameters. Since 3.2	#

Properties inherited from Core\Field\Mutable

$_v_masqueradedKeys

Properties inherited from Core\Field

$_v_data

Magic properties

`public read-only array`	`$parameters` Driver configuration parameters.

Magic properties inherited from Core\Field\Mutable

$masqueradedKeys

Magic properties inherited from Core\Field

$data

Magic properties inherited from Core\Object

$hash, $uuid

Namespaces

Classes

Interfaces

Exceptions

Constants

Class Configuration

Direct known subclasses

Methods summary

Parameters

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Throws

Since

Overrides

Parameters

Returns

Since

Parameters

Returns

Remark

Since

Methods inherited from Core\Field\Mutable

Methods inherited from Core\Field

Methods inherited from Core\Set\Mutable

Methods inherited from Core\Set

Methods inherited from Core\Object

Constants summary

Constants inherited from Core\Object

Properties summary

Since

Properties inherited from Core\Field\Mutable

Properties inherited from Core\Field

Magic properties

Magic properties inherited from Core\Field\Mutable

Magic properties inherited from Core\Field

Magic properties inherited from Core\Object