Dictionary
The Dictionary class defines a multi-level key value repository with dot notation keys accessors.
Dictionary is a behaviour class, it must be extended by another class or the value repository will be shared.
class Config extends Dictionary {}You can set a value from a key path via the get method.
A valid key path is a arbitrary deep sequence of . separated strings.
Examples
testalpha.betapages.section.text_block.3
Config::set('options.use_cache',false);
Config::set('users.whitelist',[
'frank.ciccio',
'walter.submarine',
'pepen.spacca',
]);You can get a value from a key path via the get method.
echo Config::get('users.whitelist.1'); // walter.submarineYou can optionally pass a default value to be returned when the requested key is not found. If a callable is passed the returned value will be used.
print_r( Config::get('a.test',['b'=>123]) ); // Array( [b] => 123 )
echo Config::get('a.test.b'); // 123You can get all key-values as an associative array via the all method.
$all_data = Config::all();Results :
Array (
[users] => Array (
[whitelist] => Array(
[0] => frank.ciccio
[1] => walter.submarine
[2] => pepen.spacca
)
)
)You can clear all values from a dictionary via the clear method.
Config::clear();The merge method extends the dictionary with values passed via an associative array. The second optional parameter will define the if merge data from right-to-left or backwise (default is false = left-to-right ).
Setting initial data
Config::clear();
Config::merge([
'user' => [
'name' => 'Simon',
'role' => 'Villain',
],
]);Array (
[user] => Array (
[name] => Simon
[role] => Villain
)
)Standard merge (left-to-right)
Config::merge([
'user' => [
'name' => 'Frank',
],
'happy' => true,
]);Array (
[user] => Array (
[name] => Frank
[role] => Villain
)
[happy] => 1
)Back merge (right-to-left)
Config::merge([
'user' => [
'name' => 'Frank',
],
'happy' => true,
],true);Array (
[user] => Array (
[name] => Simon
[role] => Villain
)
[happy] => 1
)You can retrieve multiple values, minimizing function calls by passing an associative array of type :
DESTINATION_KEY => DICTIONARY_PATH
Example :
MyService::init([
'username' => Config::get('aws.username'),
'password' => Config::get('aws.password'),
'from' => Config::get('user.email'),
'verbose' => Config::get('app.global.debug'),
]);
Can be written with a single call to get as :
MyService::init( Config::get([
'username' => 'aws.username',
'password' => 'aws.password',
'from' => 'user.email',
'verbose' => 'app.global.debug',
]));
