devture/silex-provider-config

Silex (Pimple) provider for configuration management

2.0 2017-03-17 16:58 UTC

Requires

• pimple/pimple: ^3.0

BSD

• Slavi Pantaleev

• silex
• config

README

A configuration provider for the Silex micro-framework.

Usage

The configuration loader uses the concept of configuration files (containing the configuration skeleton) and parameter files (variables that customize the configuration).

Moving some configuration values outside of the config skeleton allows config files to be commited to version control and remain identical everywhere, while leaving certain "parameters" up for customization.

Parameter files can be provided to the library as file paths or as PHP arrays of values. The latter is useful whenever you want to grab some environment variables.

Example configuration:

//config.json
{
    "key": "value",
    "something": "%something%",
    "websites": {
        "first": "%main_website%",
        "second": "%another_website%"
    }
}

//parameters.json
{
    "something": "value for something",
    "main_website": "http://devture.com/",
    "another_website": "http://github.com/spantaleev"
}

Usage:

<?php
$app->register(new \Devture\SilexProvider\Config\ServicesProvider());

$configFiles = array('/path/to/config.json');

//Each is either a path to a parameter file (JSON) or an array of parameters (key => value dictionary).
$parameterFiles = array(
    '/path/to/parameters.json',
    array('something' => 'overriden value for something'),
);

$app['config'] = $app['devture_config.loader']->load($configFiles, $parameterFiles);

Result:

$app['config'] = array(
    'key' => 'value',
    'something' => 'overriden value for something',
    'websites' => array(
        'first' => 'http://devture.com/',
        'second' => 'http://github.com/spantaleev',
    )
);

Limitations

• Only JSON config files an inline arrays are supported (intentional)
• Partial parameter replacements are not supported ("storage_path": "%base_path%/storage") - may be implemented later