laradic/config

Laradic Development Project

Laravel 5 Config package

, _(*1)

Version 1.3

Features

• Namespaced config (like laravel 4: Config::get('vendor/package::config.item'))
• Namespaced publishing (like laravel 4: config/packages/VENDOR/PACKAGE/config.php)
• Or use the standard Laravel 5 way: Compatible with laravel 5 default configs. Adding the package will not invalidate your current setup.
• Persistent configuration. Save changes to a mirroring file or database.
• Config::getLoader()->set('iam/awesome::my.config.key', 'A changed value') saves it to a mirroring file or db
• Supports PHP, YAML and soon also XML configuration files.

, _(*2)

Overview _^

• Features
• Overview
• Installation
• Usage
• Persistent config
• Todo
• Copyright/license

, _(*3)

Installation _^

Composer

"laradic/config": "1.3.*"

Service provider

"Laradic\Config\ConfigServiceProvider"

Bootstrapper

Replace the default laravel Illuminate\Foundation\Bootstrap\LoadConfiguration bootstrapper with Laradic\Config\Bootstrap\LoadConfiguration bootstrapper inside app/Http/Kernel.php and app/Console/Kernel.php., _(*4)

use Illuminate\Foundation\Http\Kernel as HttpKernel;
class Kernel extends HttpKernel {
    protected $bootstrappers = [
        'Illuminate\Foundation\Bootstrap\DetectEnvironment',
        'Laradic\Config\Bootstrap\LoadConfiguration',
        'Illuminate\Foundation\Bootstrap\ConfigureLogging',
        'Illuminate\Foundation\Bootstrap\HandleExceptions',
        'Illuminate\Foundation\Bootstrap\RegisterFacades',
        'Illuminate\Foundation\Bootstrap\RegisterProviders',
        'Illuminate\Foundation\Bootstrap\BootProviders',
    ];
}

, _(*5)

Basic usage _^

Inside any ServiceProvider:, _(*6)

class YourServiceProvider extends ServiceProvider
{
    use ConfigProviderTrait;

    public function register()
    {
        $this->addConfigComponent('vendorname/packagename', 'vendorname/packagename', realpath(__DIR__.'/../resources/config'));    
    }
}

• Namespaced configuration can be accessed with Config::get('vendorname/packagename::config.item').
• Publishing the config file is done with the default laravel vendor:publish command.

, _(*7)

Persistent config _^

You can set persistent config items, by default the values will be saved in a seperate, mirrored file that gets merged on boot. It is also possible to save to database., _(*8)

Inside the config file you can change the save method by changing the [loader] value., _(*9)

return array(
    'loader' => 'file',
    'loaders' => array(
        'file' => array(
            'save_path' => storage_path('laradic_config')
        ),
        'db' => array(
            'table' => 'config'
        )
    ),
    //.... other options
);

Important: If you plan on using the db loader, you will have to run the included migration that will create the required config database table., _(*10)

You can set persistent config values like this:, _(*11)

Config::getLoader()->set('config.item', 'value');

, _(*12)

Todo _^

• [x] YAML/YML file support.
• [x] Database saving
• [ ] XML file support
• [ ] Unit tests

, _(*13)

Copyright/License _^

Copyright 2015 Robin Radic - MIT Licensed, _(*14)