thewunder/conphigure

Framework Agnostic Configuration Library

Conphigure

![Software License][ico-license] , _(*1)

Conphigure is a framework agnostic library for reading and retrieving configuration. If your application has outgrown a single configuration file this library will be a good choice., _(*2)

It can read configuration files in the following formats:, _(*3)

• php
• yaml
• json
• xml
• ini
• dotenv

Conphigure can also read entire directories containing configuration files., _(*4)

Install

Via Composer, _(*5)

``` bash $ composer require thewunder/conphigure, <sub>(*6)</sub>

## Usage

If you have configuration in myfile.yml

``` yaml
smtp:
  host: smtp.mycompany.com
  port: 25

Read it in your php application like the following, <sub>(*7)</sub>

``` php $config = Conphigure::create();, <sub>(*8)</sub>

//load configuration from a single file $config->read('/directory/myfile.yml');, <sub>(*9)</sub>

//get a value $port = $config->get('smtp/port');, <sub>(*10)</sub>

//add configuration from somewhere else (cache / database / etc) $arrayFromSomewhere = [ 'database' => [ 'host' => 'localhost' ] ]; $config->addConfiguration($arrayFromSomewhere);, <sub>(*11)</sub>

//you can also use it like an array $host = $config['database']['host']; $host = $config['database/host'];, <sub>(*12)</sub>

//throws an exception if a value is missing $value = $config->get('missing/key');, <sub>(*13)</sub>

When reading a config directory Conphigure will (by default) organize the configuration in each file into a common root based
on the file path.

For example, a directory /directory/config/ with:

- system.yml
- email.yml
- logging.yml
- subdirectory/something.yml

``` php
//read the directory
$config->read('/directory/config/');

//get all configuration as an array
$all = $config->all();
var_export($all);
/* The result will be:
[
    'system' => ['...'], //contents of system.yml
    'email' => ['...'], //contents of email.yml
    'logging' => ['...'], //contents of logging.yml
    'subdirectory' => [
        'something' => ['...'], //contents of subdirectory/something.yml
    ]
];
*/

This allows you to keep things organized, and keep each file very flat., <sub>(*14)</sub>

Change log

Please see CHANGELOG for more information on what has changed recently., <sub>(*15)</sub>

Testing

bash $ composer test, <sub>(*16)</sub>

Contributing

Please see CONTRIBUTING for details., <sub>(*17)</sub>

Credits

• Michael O'Connell

License

The MIT License (MIT). Please see License File for more information., <sub>(*18)</sub>