A quick and easy Config package designed to pass around a set of values, accessible anywhere in an application.
composer require tomwright/php-config
Create an instance of Config
to get going:
$config = new Config();
$config->put('key', 'value');
$value = $config->get('key');
You can add separators to the key
string in order to have the data stored slightly differently.
For example, let's say we have a contact name and email address. You can set this in any of the following ways:
$config->put('contact', [
'name' => 'Tom',
'email' => '[email protected]',
]);
$config->put('contact.name', 'Tom');
$config->put('contact.email', '[email protected]');
You can even mix and match between the above:
$config->put('contact', [
'name' => 'Tom',
]);
$config->put('contact.email', '[email protected]');
You can use the dot separators in a similar way to the above when fetching data too.
Assuming we have the same contact details stored, let's look at the following:
$config->get('contact'); // [ 'name' => 'Tom', 'email' => '[email protected]' ]
$config->get('contact.name'); // Tom
$config->get('contact.email'); // [email protected]
You can use as many separators in the key as you would like. The following will end up working in the same way as the above, just with a deeper level of storage.
$config->put('company.person.tom.email', '[email protected]');
$config->put('company.person.jim.email', '[email protected]');
$config->get('company');
/*
[
'person' => [
'tom' => [ 'email' => '[email protected]' ],
'jim' => [ 'email' => '[email protected]' ],
]
]
*/
If you would like to use a separator other than the .
character, you may set one using the setSeparator()
method, or by passing it in in the Config constructor.
$config = new Config([
'separator' => '|', // Equal
]);
$config->setSeparator('|'); // Equal
$config->put('contact', [
'contact' => [
'name' => 'Tom',
'email' => '[email protected]',
],
]);
$config->get('contact|name'); // Tom
$config->get('contact.email'); // NULL
Config readers are classes to help you auto-populate the config object with values.
To use a Config Reader, simply pass it into $config->read()
.
$config = new Config();
$config->read(new SomeConfigReader());
$config->get('some.value.from.my.reader');
You can also pass an array of Config Readers into the Config constructor:
$config = new Config([
'readers' => [
new SomeConfigReader(),
],
]);
$config->get('some.value.from.my.reader');
If you would like to create a Config Reader please feel free. The only requirement is that you implement the ConfigReader
interface.
If you have already created a Config Reader and would like it to appear here, please submit a pull request.