jomisacu/configloader

A simple config system

ConfigLoader

Provide a simple interface to handle configuration values., _(*1)

Concepts

Config root directory

It's a place to store all configuration files under environments represented by sub directories., _(*2)

Enviroment

A environment represents a directory into directory root., _(*3)

By default the selected environment is ConfigLoader::ENV_PRODUCTION ("production"), to override this, you can put into config root directory a file named ENVIRONMENT.txt that contains a environment name, or, configure $_SERVER['ENVIRONMENT'] var through http server. For example, you can set this var on apache adding the line below:, _(*4)

# httpd.conf or .htaccess 
SetEnv ENVIRONMENT 'development'

Config file

A config file is a pure php file that contains an array named $config with the specific scope values. Example:, _(*5)

<?php // [config root dir]/[selected environment]/default.php file

$config['system_timezone'] = 'Americas/Santo_Domingo';

installation

php composer.phar require "jomisacu/configloader"

Usage

Use this package require atleast the below steps, _(*6)

1. include

<?php

include "vendor/autoload.php";

1. Create a instance

<?php

// for specific environment values.
// represents a sub directory on config files root directory
// it's a string and can exists any number of environments
$environment = \Jomisacu\ConfigLoader::ENV_DEVELOPMENT; 

// directory where resides configuration environments dirs
// -+ config (config root)
//  |-- development
//  |-- production
//  |-- testing
//  |-- qa
//  |-- example
//  |-- ... 
$configFilesRootDir = __DIR__ . '/config';

// configuration files to be loaded automatically
$autoloadFiles = ['default'];

$config = \Jomisacu\ConfigLoaderFactory::create($configFilesRootDir, $environment, $autoloadFiles);

1. Access to configuration values

```php <?php, <sub>(*7)</sub>

// ..., <sub>(*8)</sub>

// load files $config->load('default');, <sub>(*9)</sub>

// via method call echo $config->get('system_timezone') . "
";, <sub>(*10)</sub>

// via magic method echo $config->system_timezone . "
";, <sub>(*11)</sub>

// ..., <sub>(*12)</sub>