activecollab/configrepository

Configuration repository

1.0.0 2015-12-17 12:42 UTC

Requires

• activecollab/configfile: ~1.0
• activecollab/etcd: ~1.0.0
• vlucas/phpdotenv: ~2.0

Requires (Dev)

• phpunit/phpunit: ~5.0

MIT

README

This package provides a way to compose a configuration repository that reads and write options from serveral sources.

Existing adapters:

1. DotEnvAdapter - load environment variables from .env file (read-only),
2. EtcdAdapter - read and write options from and to etcd cluster,
3. PhpConstantsAdapter - load options from regular PHP file full of constants. Note that this file is not included, but parsed statically, so you don't need to worry that these constants will be defined in your code.

To write your own adapters, simply implement ActiveCollab\ConfigRepository\AdapterInterface.

Working with data

Repository provides a couple of confenient methods to retrive and set the data:

<?php

use ActiveCollab\ConfigRepository\ConfigRepository;
use ActiveCollab\ConfigRepository\Adapter\PhpConstantsAdapter;

$repository = new ConfigRepository(new PhpConstantsAdapter('/path/to/config.php'));

// Check if option exists in any of the adapters
$repository->exists('CONFIG_NAME');

// Get value from first adapter that has it, or return default value if none of the adapters have it
$repository->get('CONFIG_NAME', 'default if not found');

// Get value from first adapter that has it, or throw an exception if it is not found in any adapter
$repository->mustGet('CONFIG_NAME'); // Throws an exception if option is not fpund

// Set value in all adapters where this option exists. Read-only adapters that have this option will throw an exception
$repository->set('CONFIG_NAME', 'value to set');

To work with the data from a particular adapter, find it and use the same methods:

<?php

use ActiveCollab\ConfigRepository\ConfigRepository;
use ActiveCollab\ConfigRepository\Adapter\PhpConstantsAdapter;

$repository = new ConfigRepository(new PhpConstantsAdapter('/path/to/config.php'));

$repository->getAdapter(PhpConstantsAdapter::class)->exists('CONFIG_NAME');
$repository->getAdapter(PhpConstantsAdapter::class)->get('CONFIG_NAME', 'default if not found');
$repository->getAdapter(PhpConstantsAdapter::class)->mustGet('CONFIG_NAME'); // Throws an exception if option is not fpund
$repository->getAdapter(PhpConstantsAdapter::class)->set('CONFIG_NAME', 'value to set');

Adapter Composition

When constructing a repository instance, you can specify a list of adapters:

<?php

use ActiveCollab\ConfigRepository\ConfigRepository;
use ActiveCollab\ConfigRepository\Adapter\DotEnvAdapter;
use ActiveCollab\ConfigRepository\Adapter\PhpConstantsAdapter;

$repository = new ConfigRepository(new PhpConstantsAdapter(__DIR__ . '/Resources/config.simple.php'), new DotEnvAdapter(__DIR__ . '/Resources', '.env'));

Adapters added like this will be indexed by their class names, so instances of the same class can't be added like this. To do that, provide an array, where key is adaper name and value is adapter instance (if key is missing, library will use adapter's class as adapter name):

<?php

use ActiveCollab\ConfigRepository\ConfigRepository;
use ActiveCollab\ConfigRepository\Adapter\DotEnvAdapter;
use ActiveCollab\ConfigRepository\Adapter\PhpConstantsAdapter;

$repository = new ConfigRepository([
    new PhpConstantsAdapter(__DIR__ . '/Resources/config.simple.php'),
    'second' => new PhpConstantsAdapter(__DIR__ . '/Resources/config.simple.php'),
], new DotEnvAdapter(__DIR__ . '/Resources', '.env'));

$repository->getAdapter(PhpConstantsAdapter::class); // Returns PhpConstantsAdapter instance
$repository->getAdapter('second');                   // Returns PhpConstantsAdapter instance
$repository->getAdapter(DotEnvAdapter::class);       // Returns DotEnvAdapter instance

Adapters can also be added at any time, using addAdapter() method:

<?php

use ActiveCollab\ConfigRepository\ConfigRepository;
use ActiveCollab\ConfigRepository\Adapter\DotEnvAdapter;
use ActiveCollab\ConfigRepository\Adapter\PhpConstantsAdapter;

$repository = new ConfigRepository(new PhpConstantsAdapter(__DIR__ . '/Resources/config.simple.php'));
$repository->addAdapter(new DotEnvAdapter($repository->get('DOT_ENV_DIR_PATH')));