lorenzoferrarajr/lfj-configuration-builder

A PHP library to build array configuration from various sources

0.2.2 2015-12-04 19:04 UTC

Requires

• php: >=5.5
• zendframework/zend-stdlib: ^2

Requires (Dev)

• phpunit/phpunit: ~4.6

MIT

• Lorenzo Ferrara

README

A PHP library to merge configuration arrays.

Installation

The suggested installation method is via composer:

composer require lorenzoferrarajr/lfj-configuration-builder

Usage

Instantiate a ConfigurationBuilder object, add configurations, call the build method to get the merged array. Zend\Stdlib\ArrayUtils::merge is used for merging.

Adding configurations

The ConfigurationBuilder provides various methods that can be used to add configurations:

• addFile: to add a single php file returning an array
• addFiles: to add multiple files
• addDirectory: to add files located inside a directory
• addArray: to add configuration from array

Exceptions

To catch exceptions the build method can be called inside a try block. Available exceptions are:

• FileNotExistsException
• FileNotReadableException
• NotArrayException: if a configuration file does not return an array
• NotFileException

Examples

For the examples two configuration files are be used: mail.global.php and mail.local.php

<?php
// mail.global.php

return array(
    'mail' => array(
        'host' => 'localhost',
        'port' => 25
    )
);

<?php
// mail.local.php

return array(
    'mail' => array(
        'host' => '192.168.1.1',
    )
);

Building configuration from single files

In this example two files are passed to the ConfigurationBuilder object: first the mail.global.php file and then mail.local.php. The result will be an array containing the port of the first and the host of the second.

$cb = new \Lfj\ConfigurationBuilder\ConfigurationBuilder();

$cb->addFile(__DIR__.'/config/mail.global.php');
$cb->addFile(__DIR__.'/config/mail.local.php');

$config = $cb->build();

Building configuration from multiple files at once

This example is the same as the previous one but files are passed all at once as an array.

$cb = new \Lfj\ConfigurationBuilder\ConfigurationBuilder();

$cb->addFiles(array(
    __DIR__.'/config/mail.global.php',
    __DIR__.'/config/mail.local.php',
));

$config = $cb->build();

Building configuration from a directory

In this example configuration files are loaded from a directory. The pattern used for file matching is the same as global($pattern, GLOB_BRACE), so first mail.global.php and then mail.local.php.

$cb = new \Lfj\ConfigurationBuilder\ConfigurationBuilder();

$cb->addDirectory(__DIR__.'/config/*.{global,local}.php');

$config = $cb->build();

More information on patterns can be found in the glob documentation.

Building configuration from a directory and array

This example is the same as the previous but before calling the build method a new configuration is provided by passing an array.

$cb = new \Lfj\ConfigurationBuilder\ConfigurationBuilder();

$cb->addDirectory(__DIR__.'/config/*.{global,local}.php');
$cb->addArray(array(
    'mail' => array(
        'host' => 'other'
    )
));

$config = $cb->build();