GeckoPackages

Silex config service

A service provider for Silex for loading configuration files. Supported formats:

json
yml (yaml)
php

For Silex 1.x please see the 1.x branches of the project.

Requirements

PHP 5.5 (PHP7 supported). Optional HHVM support >= 3.9.

Install

The package can be installed using Composer . Add the package to your composer.json.

"require": {
    "gecko-packages/gecko-silex-config-service" : "^2.0"
}

_{Use ^v1.1 if you are using Silex 1.x}

Usage

The provider will find and read configuration files in a directory. The files are found using; a directory, a format and a key.

The format is a string which can have an optional placeholder %env% (environment), for example: '%key%.%env%.json'

The key is the configuration key to be used, usually the file name without the extension.

Typically the directory and format are set during registering of the service and the key is used for fetching the configuration.

Example

$app->register(
    new GeckoPackages\Silex\Services\Config\ConfigServiceProvider(),
    [
        'config.dir' => __DIR__.'/config',
        'config.format' => '%key%.%env%.json',
        'config.env' => 'dev',
        'config.cache' => 'memcached',
    ]
);

// This will read: `'__DIR__.'/config/database.dev.json` and returns an array with values.
$app['config']->get('database');

// array access is also supported
$app['config']['database'];

Options

The service takes the following options:

config.dir Directory where the configuration files should be loaded from. [string]
config.format Format to translate a key to a file. The default is %key%.json. %env% placeholder is supported. [string]
config.cache Name under which a caching service is registered on the application. The default is null, which means caching is disabled. [string]
config.env The value of the environment, this is (optional) used to replace the %env% placeholder in the file format. [string], default null.

Runtime options

The following methods can be used to get or change properties of the service at runtime (for example after registering).

// returns the current configuration directory
$app['config']->getDir()

$app['config']
    ->setDir($dir)         // change the configuration directory to read from
    ->setEnvironment($env) // change the value used in the replacement of `%env%` in the `format`.
    ->setFormat($format)   // change the format used to transform a key to a file name
    ->setCache($name)      // change the caching service to use (`null` to disable)
;

// when need the service can be called directly to flush
// config values from the cache
$app['config']->flushConfig($key)

// flush all known items
$app['config']->flushAll()

Twig example

When using Twig in combination with a config file with key foo which holds the data:

// when read and parsed by the config loader
["bar" => "test"]

You can simply get the value like:

{{ app.config.foo.bar.test }}

Custom name registering / multiple services

You can register the service using a name other than the default name config. The same method can be used to register multiple configuration services. Pass the name at the constructor of the service and use the same name as prefix for the configuration. For example:

// first service
$app->register(new ConfigServiceProvider('config.database'), ['config.database.dir' => $configDatabaseDir]);

// second service
$app->register(new ConfigServiceProvider('config.test'), ['config.test.dir' => $configTestDir]);

// usage
$app['config.database']->get('db.user.name');

License

The project is released under the MIT license, see the LICENSE file.

Contributions

Contributions are welcome!

Semantic Versioning

This project follows Semantic Versioning.

_{Kindly note:
We do not keep a backwards compatible promise on the tests and tooling (such as document generation) of the project itself
nor the content and/or format of exception messages.}

logorn / GeckoSilexConfigService