caseyamcl/configula

A simple, flexible, read-only config library for PHP 7.1+

Tuesday, March 27, 2018
by caseyamcl
Repository
4 Watchers
29 Stars
60,975 Installations

PHP
3 Dependents
0 Suggesters
8 Forks
9 Open issues
9 Versions
2 % Grown

The README.md

Configula

Configula is a configuration library for PHP 7.3+., _(*1)

[][link-ghbuild] , _(*2)

Use this library when you want to load configuration from the filesystem, environment, and other sources. It implements your configuration values as an immutable object in PHP. It is a framework-independent tool, and can be easily used in any PHP application., _(*3)

Features

Load configuration from a variety of sources:
- Load values from .php, .ini, .json, and .yml configuration file types
- Load values from the environment, and .env files using a DotEnv library (vlucas or Symfony)
- Easily write your own loaders to support other file types and sources
Cascade/deep merge values from multiple sources (e.g. array, files, environment, etc)
Optionally use in combination with Symfony Config Component to validate configuration values and/or cache them
Creates an immutable object to access configuration values in your application:
- Array-access (read-only)
- get(val), has(val), and hasValue(val) methods
- Magic methods (__get(val), __isset(val), and __invoke(val))
- Implements Traversable and Countable interfaces
Provides simple dot-based access to nested values (e.g. $config->get('application.sitename.prefix');)
Code quality standards: PSR-12, near-complete unit test coverage

Installation

composer require caseyamcl/configula

Need PHP v7.1, 7.2 or Symfony v3 compatibility?

Configula v4.x is compatible with PHP v7.3+ or v8.0+. If you need PHP 7.1, 7.2 compatibility, instruct Composer to use the 3.x version of this library instead of the current one:, _(*4)

composer require caseyamcl/configula:^3.1

Need PHP v5.* compatibility?

Configula Version 2.x is compatible with PHP v5.3+. If you need PHP 5.x compatibility, instruct Composer to use the 2.x version of this library instead of the current one:, _(*5)

composer require caseyamcl/configula:^2.4

Upgrading?

Refer to UPGRADE.md for notes on upgrading from Version 2.x, 3.x to v4., _(*6)

Loading Configuration

You can use the Configula\ConfigFactory to load configuration from files, the environment or other sources:, _(*7)

use Configula\ConfigFactory as Config;

// Load all .yml, .php, .json, and .ini files from directory (recursive)
// Supports '.local' and '.dist' modifiers to load config in correct order
$config = Config::loadPath('/path/to/config/files', ['optional' => 'defaults', ...]);

// Load all .yml, .php, .json, and .in files from directory (non-recursive)
// Supports '.local' and '.dist' modifiers to load config in correct order
$config = Config::loadSingleDirectory('/path/to/config/files', ['optional' => 'defaults', ...]);

// Load from array
$config = Config::fromArray(['some' => 'values']);

// Chain loaders -- performs deep merge
$config = Config::fromArray(['some' => 'values'])
    ->merge(Config::loadPath('/some/path'))
    ->merge(Config::loadEnv('MY_APP'));

Or, if you are loading an array, you can instantiate Configula\ConfigValues directly:, _(*8)

$config = new Configula\ConfigValues(['array' => 'values']);

Or, you can manually invoke any of the loaders in the Configula\Loader namespace:, _(*9)

$config = (new Configula\Loader\FileListLoader(['file-1.yml', 'file-2.json']))->load();

Accessing Values

The Configula\ConfigValues object provides several ways to access your configuration values:, _(*10)

// get method - throws exception if value does not exist
$config->get('some_value');

// get method with default - returns default if value does not exist
$config->get('some_value', 'default');

// find method - returns NULL if value does not exist
$config->find('some_value');

// has method - returns TRUE or FALSE
$config->has('some_value');

// hasValue method - returns TRUE if value exists and is not empty (NULL, [], "")
$config->hasValue('some_value');

Accessing values using dot notation

Configula supports accessing values via dot-notation (e.g some.nested.var):, _(*11)

// Here is a nested array:
$values = [
    'debug' => true,
    'db' => [
        'platform' => 'mysql',
        'credentials' => [
            'username' => 'some',
            'password' => 'thing'
        ]
    ],
];

// Load it into Configula
$config = new \Configula\ConfigValues($values);

// Access top-level item
$values->get('debug'); // bool; TRUE

// Access nested item
$values->get('db.platform'); // string; 'mysql'

// Access deeply nested item
$values->get('db.credentials.username'); // string: 'some'

// Get item as array
$values->get('db'); // array ['platform' => 'mysql', 'credentials' => ...]

// has/hasValue work too
$values->has('db.credentials.key'); // false
$values->hasValue('db.credentials.key'); // false

Property-like access to your config settings via __get() and __isset():, _(*12)

// Access configuration values
$config = Config::loadPath('/path/to/config/files');

// Throws exception if value does not exist
$some_value = $config->some_key;

// Returns TRUE or FALSE
isset($config->some_key);

Iterator and count access to your config settings:, _(*13)

// Basic iteration
foreach ($config as $item => $value) {
    echo "<li>{$item} is {$value}</li>";
}

// Count
count($config); /* or */ $config->count();

Callable access to your config settings via __invoke():, _(*14)

// Throws exception if value does not exist
$value = $config('some_value'); 

// Returns default value if value does not exist
$value = $config('some_value', 'default');

Array access to your config settings:, _(*15)

// Throws exception if value does not exist
$some_value = $config['some_key'];    

// Returns TRUE or FALSE
$exists = isset($config['some_key']); 

// Not allowed; always throws exception (config is immutable)
$config['some_key'] = 'foobar'; // Configula\Exception\ConfigLogicException
unset($config['some_key']);     // Configula\Exception\ConfigLogicException

Merging Configuration

Since Configula\ConfigValues is an immutable object, you cannot mutate the configuration once it is set. However, you can merge values and get a new copy of the object using the merge or mergeValues methods:, _(*16)

use Configula\ConfigValues;

$config = new ConfigValues(['foo' => 'bar', 'baz' => 'biz']);

// Merge configuration using merge()
$newConfig = $config->merge(new ConfigValues(['baz' => 'buzz', 'cad' => 'cuzz']));

// For convenience, you can pass in an array using mergeValues()
$newConfig = $config->mergeValues(['baz' => 'buzz', 'cad' => ['some' => 'thing']]);

Configula performs a deep merge. Nested arrays are traversed and the last value always takes precedence., _(*17)

Note that Configula does not deep merge nested objects, only arrays., _(*18)

Iterator and Count

The built-in ConfigValues::getIterator() and ConfigValues::count() methods flattens nested values when iterating or counting:, _(*19)

// Here is a nested array
$config = new Configula\ConfigValues([
    'debug' => true,
    'db' => [
        'platform' => 'mysql',
        'credentials' => [
            'username' => 'some',
            'password' => 'thing'
        ]
    ],
]);

// ---------------------

foreach ($config as $path => $value) {
    echo "\n" . $path . ": " . $value;
}

// Output:
//
// debug: 1
// db.platform: mysql
// db.credentials.username: some
// db.credentials.password: thing
// 

echo count($config);

// Output: 4

If you want to iterate only the top-level items in your configuration, you can use the getArrayCopy() method:, _(*20)

foreach ($config->getArrayCopy() as $path => $value) {
    echo "\n" . $path . ": " . $value;
}

// Output:
//
// debug: 1
// db: Array
//

Using the Folder Loader - Config Folder Layout

The folder loaders in Configula will load files with the following extensions (you can add your own custom loaders; see below):, _(*21)

php - Configula will look for an array called $config in this file.
json - Uses the built-in PHP json_decode() function
yaml or yml - Uses the Symfony YAML parser
ini - Uses the built-in PHP parse_ini_file() function

The ConfigFactory::loadPath($path) method will traverse directories in your configuration path recursively., _(*22)

The ConfigFactory::loadSingleDirectory($path) method will load your configuration in a single directory non-recursively., _(*23)

Local Configuration Files

In some cases, you may want to have local configuration files that override the default configuration files. There are two ways to do this:, _(*24)

prefix the default configuration file extension with .dist (e.g. config.dist.yml), and name the local configuration file normally: config.yml
name the default configuration file normally (e.g. config.yml) and prefix .local to the extension for the local configuration file: config.local.yml.

Either way will work, and you could even combine approaches if you want. The file iterator will always cascade merge files in this order:, _(*25)

FILENAME.dist.EXT
FILENAME.EXT
FILENAME.local.EXT

This is useful if you want to keep local configuration files out of revision control. Choose a paradigm, and simply add the following to your .gitignore, _(*26)

# If keeping .dist files...
[CONFIGDIR]/*
[!CONFIGDIR]/*.dist.*

# or, if ignoring .local files...
[CONFIGDIR]/*.local.*

Example

Consider the following directory layout..., _(*27)

/my/app/config
 ├config.php
 ├config.dist.php
 └/subfolder
  ├database.yml
  └database.dist.yml

If you use ConfigFactory::loadPath('/my/app/config'), the files will be parsed according to their extension and values will be merged in the following order (values in files that are later in the list will clobber earlier values):, _(*28)

- /config.dist.php
- /subfolder/database.dist.yml
- /config.php
- /subfolder/database.yml

Loading from environment variables

There are two common ways that configuration is generally stored in environment:, _(*29)

As multiple environment variables (perhaps loaded by phpDotEnv or Symfony dotEnv, or exposed by Heroku/Kubernetes/etc.).
As a single environment variable with a JSON-encoded value, which exposes the entire configuration tree.

Configula supports both. You can also write your own loader if your environment is different., _(*30)

Loading multiple environment variables

Configula supports loading environment variables as configuration values using getenv(). This is the 12 Factor App way of doing things., _(*31)

Common use-cases for this loader include:, _(*32)

Loading system environment as config values
Loading values using phpDotEnv or Symfony dotEnv
Accessing values injected into the environment by a cloud provider (Kubernetes, Docker, Heroku, etc.)

Default environment variable loading

The default behavior is to load the configuration values directly:, _(*33)

$config = ConfigFactory::loadEnv();

Result:, _(*34)

MYAPP_MYSQL_USERNAME="..."   --> becomes --> $config->get('MYAPP_MYSQL_USERNAME')
MYAPP_MYSQL_PASSWORD="..."   --> becomes --> $config->get('MYAPP_MYSQL_PASSWORD')
MYAPP_MYSQL_HOST_PORT="..."  --> becomes --> $config->get('MYAPP_MYSQL_HOST_PORT')
MYAPP_MYSQL_HOST_NAME="..."  --> becomes --> $config->get('MYAPP_MYSQL_HOST_NAME')
SERVER_NAME="..."            --> becomes --> $config->get('SERVER_NAME')
etc..

Load only environment variables with prefix

You can load ONLY environment variables with a specific prefix. Configula will remove the prefix when loading the configuration:, _(*35)

$config = ConfigFactory::loadEnv('MYAPP_');

Result:, _(*36)

MYAPP_MYSQL_USERNAME="..."   --> becomes --> $config->get('MYSQL_USERNAME')
MYAPP_MYSQL_PASSWORD="..."   --> becomes --> $config->get('MYSQL_PASSWORD')
MYAPP_MYSQL_HOST_PORT="..."  --> becomes --> $config->get('MYSQL_HOST_PORT')
MYAPP_MYSQL_HOST_NAME="..."  --> becomes --> $config->get('MYSQL_HOST_NAME')
SERVER_NAME="..."            --> ignored
etc..

Convert environment variables to nested configuration

You can convert a flat list into nested config values by passing a delimiter to break on:, _(*37)

$config = ConfigFactory::loadEnv('MYAPP', '_');

Result:, _(*38)

MYAPP_MYSQL_USERNAME="..."   --> becomes --> $config->get('MYSQL.USERNAME')
MYAPP_MYSQL_PASSWORD="..."   --> becomes --> $config->get('MYSQL.PASSWORD')
MYAPP_MYSQL_HOST_PORT="..."  --> becomes --> $config->get('MYSQL.HOST.PORT')
MYAPP_MYSQL_HOST_NAME="..."  --> becomes --> $config->get('MYSQL.HOST.NAME')

This allows you to access nested values as an array:, _(*39)

$config = ConfigFactory::loadEnv('MY_APP', '_');
$dbConfig = $config->get('mysql.host');

// $dbConfig: ['host' => '...', 'port' => '...']

Transform environment variables to lower-case

You can transform all the values to lower-case by passing TRUE as the last argument:, _(*40)

$config = ConfigFactory::loadEnv('MYAPP_', '_', true);

Result:, _(*41)

MYAPP_MYSQL_USERNAME="..."   --> becomes --> $config->get('mysql.username')
MYAPP_MYSQL_PASSWORD="..."   --> becomes --> $config->get('mysql.password')
MYAPP_MYSQL_HOST_PORT="..."  --> becomes --> $config->get('mysql.host.port')
MYAPP_MYSQL_HOST_NAME="..."  --> becomes --> $config->get('mysql.host.name')

Loading environment variables with regex pattern

Instead of using a prefix, you can pass a regex string to limit returned values:, _(*42)

$config = ConfigFactory::LoadEnvRegex('/.+_MYAPP_.+/', '_', true);

Result:, _(*43)

MYAPP_MYSQL_USERNAME="..."   --> becomes --> $config->get('myapp.mysql.username')
MYAPP_MYSQL_PASSWORD="..."   --> becomes --> $config->get('myapp.mysql.password')
MYAPP_MYSQL_HOST_PORT="..."  --> becomes --> $config->get('myapp.mysql.host.port')
EMAIL_MYAPP_SERVER="..."     --> becomes --> $config->get('email.myapp.server')
SERVER_NAME="..."            --> ignored

Loading a single JSON-encoded environment variable

Use the Configula\Loader\JsonEnvLoader to load a JSON environment variable:, _(*44)

MY_ENV_VAR = '{"foo: "bar", "baz": "biz"}'

use Configula\Loader\JsonEnvLoader;

$values = (new JsonEnvLoader('MY_ENV_VAR'))->load();

echo $values->foo;
echo $values->get('foo'); // "bar"

Loading from multiple loaders

You can use the Configula\ConfigFactory::loadMultiple() to load from multiple sources and merge results. This method accepts an iterator where each value is one of the following:, _(*45)

Instance of Configula\ConfigLoader\ConfigLoaderInterface
Array of configuration values
String or instance of SplFileInfo that is a path to a file or directory

Any other value in the iterator will trigger an \InvalidArgument exception, _(*46)

use Configula\ConfigFactory as Config;
use Configula\Loader;

$config = Config::loadMultiple([
    new Loader\EnvLoader('My_APP'),                 // Instance of LoaderInterface
    ['some' => 'values'],                           // Array of config vaules
    '/path/to/some/file.yml',                       // Path to file (must exist)
    new \SplFileInfo('/path/to/another/file.json')  // SplFileInfo
]);

// Alternatively, you can pass an iterator of `Configula\ConfigLoaderInterface` instances to
// `Configula\Loader\CascadingConfigLoader`.

Handling Errors

All exceptions extend Configula\Exception\ConfigException. You can catch this exception to catch certain types of Configula errors during loading and reading of configuration values., _(*47)

Loading Exceptions:

ConfigLoaderException is thrown when an error occurs during loading configuration.
ConfigFileNotFoundException is thrown when a required configuration file or path is missing. It is generally thrown from the FileLoader loader when the $required constructor parameter is set to true.
UnmappedFileExtensionException is thrown from the DecidingFileLoader for files with unrecognized extensions.

NOTE: Configula does NOT catch non-Configula exceptions and convert them to Configula exceptions. If you wan to catch all conceivable errors when loading configuration, you should surround your configuration loading code with a try...catch (\Throwable $e)., _(*48)

Config Value Exceptions:

ConfigValueNotFoundException is thrown when trying to reference a non-existent configuration value name and no default value is specified.
ConfigLogicException is thrown when attempting to mutate configuration via array
InvalidConfigValueException is not thrown from any Configula class directly, but provided as an option for implementing libraries (see "Extending the ConfigValues class" below).

// These throw a ConfigValueNotFoundException
$config->get('non_existent_value');
$config['non_existent_value'];
$config->non_existent_value;

// This will not throw an exception, but instead return NULL
$config->find('non_existent_value');

// This will not throw an exception, but instead return 'default'
$config->get('non_existent_value', 'default');

Extending the `ConfigValues` class (for IDE type-hinting)

While it is entirely possible to use the Configula\ConfigValues class directly, you might also want to provide some application-specific methods to load configuration values. This creates a better developer experience., _(*49)

use Configula\ConfigValues;
use Configula\Exception\InvalidConfigValueException;

class AppConfig extends ConfigValues
{
    /**
     * Is the app running in development mode?
     *
     * @return bool
     */
    public function isDevMode(): bool
    {
        // Get the value or assume false
        return (bool) $this->get('devmode', false);
    }

    /**
     * Get the encryption key (as 32-character alphanumeric string)
     *
     * @return string
     */
    public function getEncryptionKey(): string
    {
        // If the value doesn't exist, a `ConfigValueNotFoundException` is thrown
        $key = $this->get('encryption_key');

        // Let's do a little validation...
        if (strlen($key) != 32) {
            throw new InvalidConfigValueException('Encryption key must be 32 characters');
        }

        return $key;
    }
}

Note: Notice that the example above uses the InvalidConfigValueException, which is included with Configula for exactly this use-case., _(*50)

You can use your custom AppConfig class as follows:, _(*51)

use Configula\ConfigFactory;

// Build it
$config = AppConfig::fromConfigValues(ConfigFactory::loadPath('/some/path'));

// Use it (and enjoy the type-hinting in your IDE)
$config->getEncryptionKey();
$config->isDevMode();
// etc...

Using Symfony Config to define a configuration schema

In some cases, you may wish to strictly control what configuration values are allowed and also validate those values when loading the configuration. The Symfony Config Component provides an excellent mechanism for accomplishing this., _(*52)

First, include the Symfony Config Component library in your application:, _(*53)

composer require symfony/config

Then, create a class that provides your configuration tree. Refer to the Symfony Docs for all the cool stuff you can do in your configuration tree:, _(*54)


use Symfony\Component\Config\Definition\Builder\TreeBuilder;
use Symfony\Component\Config\Definition\ConfigurationInterface;

class ConfigTree implements ConfigurationInterface
{
    public function getConfigTreeBuilder()
    {
        $treeBuilder = new TreeBuilder();
        $rootNode = $treeBuilder->getRootNode();

        $rootNode->children()
            ->boolean('devmode')->defaultValue(false)->end()
            ->scalarNode('encryption_key')->isRequired()->cannotBeEmpty()->end()
            ->arrayNode('db')
                ->children()
                    ->scalarNode('host')->cannotBeEmpty()->defaultValue('localhost')->end()
                    ->integerNode('port')->min(0)->defaultValue(3306)->end()
                    ->scalarNode('driver')->cannotBeEmpty()->defaultValue('mysql')->end()
                    ->scalarNode('dbname')->cannotBeEmpty()->end()
                    ->scalarNode('user')->cannotBeEmpty()->end()
                    ->scalarNode('password')->end()
                ->end()
            ->end() // End DB
        -end();

        return $treeBuilder;
    }
}

Load your configuration as you normally would, and then pass the resulting ConfigValues object through the Symfony filter:, _(*55)


use Configula\ConfigFactory;
use Configula\Util\SymfonyConfigFilter;

// Setup your config tree, and load your configuration
$configTree = new ConfigTree();
$config = ConfigFactory::loadPath('/path/to/config');

// Validate the configuration by filtering it through the allowed values
// If anything goes wrong here, a Symfony exception will be thrown (not a Configula exception)
$config = SymfonyConfigFilter::filter($configTree, $config);

Writing your own loader

In addition to using the built-in loaders, you can write your own loader. There are two ways to do this:, _(*56)

Create your own file loader

Extend the Configula\Loader\AbstractFileLoader to write your own loader that reads data from a file., _(*57)


use Configula\Loader\AbstractFileLoader;

class MyFileLoader extends AbstractFileLoader
{
        /**
         * Parse file contents
         *
         * @param string $rawFileContents
         * @return array
         */
        protected function parse(string $rawFileContents): array
        {
            // Parse the file contents and return an array of values.
        }
}

Use it:, _(*58)


use Configula\ConfigFactory;

// use the factory..
$config = ConfigFactory::load(new MyFileLoader('/path/to/file'));

// ..or don't..
$config = (new MyFileLoader('/path/to/file'))->load();

If you want to use the FolderLoader and automatically map your new type to a file extension, you can do so:, _(*59)


use Configula\Loader\FileLoader;
use Configula\Loader\FolderLoader;

// Map my custom file loader to the 'conf' extension type (case-insensitive)
$extensionMap = array_merge(FileLoader::DEFAULT_EXTENSION_MAP, [
    'conf' => MyFileLoader::class
]);

// Now any files encountered in the folder with .conf extension will use my custom file loader
$config = (new FolderLoader('/path/to/folder', true, $extensionMap))->load();

Create your own custom loader

Create your own implementation of Configula\Loader\ConfigLoaderInterface, and you can load configuration from anywhere:, _(*60)


use Configula\Loader\ConfigLoaderInterface;
use Configula\Exception\ConfigLoaderException;
use Configula\ConfigValues;

class MyLoader implements ConfigLoaderInterface
{
    public function load(): ConfigValues
    {
        if (! $arrayOfValues = doWorkToLoadValuesHere()) {
            throw new ConfigLoaderException("Something went wrong..");
        }

        return new ConfigValues($arrayOfValues);
    }
}

Use it:, _(*61)


use Configula\ConfigFactory;

// use the factory..
$config = ConfigFactory::load(new MyLoader());

// ..or use it directly.
$config = (new MyLoader())->load();