neutrino/dotconst

The Neutrino dotconst package.

Loads constants variables from .const.ini, .const.[APP_ENV].ini files., _(*1)

How Use

Make sure the .const.ini, .const.*.ini, file is added to your .gitignore so it is not checked-in the code., _(*2)

Add this to your .gitignore :, _(*3)

.const.ini
.const.*.ini

Create your .const.ini and put any variables in !, _(*4)

Dotconst work with .ini file., _(*5)

Every sections will be flatten. Each variable will be prefixed with the section name., _(*6)

Every variable will be UPPERIZED. e.g., _(*7)

[database]
user = db_user

Will become, _(*8)

DATABASE_USER === 'db_user'

Special key

base_path = @php/dir
app_env = @php/env:APP_ENV
php_v = @php/const:PHP_VERSION_ID

Will become :, _(*9)

BASE_PATH === {base path of .const.ini file}
APP_ENV === getenv('APP_ENV')
PHP_V === PHP_VERSION_ID

And compile :, _(*10)

define('BASE_PATH', '{base path of .const.ini file}');
define('APP_ENV', getenv('APP_ENV'));
define('PHP_V', PHP_VERSION_ID);

Loading

It's really simple, just add this to your bootstrap :, _(*11)

\Neutrino\Dotconst::load('/ini_path' [, '/compile_path']);

Environment Overloading

The first file called is ".const.ini". If the variable "APP_ENV" is defined in this file, dotconst will look for the file ".const. {APP_ENV} .ini", and override the base values. Useful when working on multiple environments., _(*12)

; .const.ini
[app]
env = production

[database]
host = localhost

; .const.production.ini
[database]
host = 10.0.0.0

Will become, _(*13)

DATABASE_HOST === '10.0.0.0'

Compilation

For the best performance, you can compile the variables loaded into a php file, by calling :, _(*14)

\Neutrino\Dotconst\Compile::compile('/ini_path', '/compile_path');

Will generate for this ini file :, _(*15)

; .const.ini
[database]
user = db_user

define('DATABASE_USER', 'db_user');

Extensions

I can easily extends Dotconst :, _(*16)

class MyExtention extends \Neutrino\Dotconst\Extensions\Extension{

    protected $identifier = "php/my";

    public function parse($value, $path) {
        return 'my';
    }

    public function compile($value, $path){
        return "'my'";
    }
}

\Neutrino\Dotconst::addExtension(MyExtention::class);

In your .const.ini file :, _(*17)

[foo]
bar = @php/my

Will be parse :, _(*18)

FOO_BAR === 'my'

And compile :, _(*19)

define('FOO_BAR', 'my');