theofidry/laravel-yaml

Laravel ServiceProvider for using YAML configuration files

Laravel Yaml ServiceProvider

, _(*1)

A simple Laravel library to declare your parmeters and services in Yaml like in [Symfony][2]:, _(*2)

# resources/providers/services.yml

services:
    dummy_service:
        class: App\Services\DummyService
        alias: dummy
        arguments:
            - %app.url%
            - %app.env%

instead of:, _(*3)

# app/Providers/AppServiceProvider.php

//...
public function register()
{
    $this->app->singleton(
        'dummy_service',
        function ($app) {
            $url = env('APP_URL');
            $env = env('APP_ENV');

            return new \App\Services\DummyService($url, $env);
        }
    );
}

Documentation

1. Disclaimer: why using this library?
2. Install
3. Everything about parameters
   1. YAML vs PHP
   2. Refering to another value
   3. Refering to an environment value
   4. Refering to constants
   5. Overriding values
   6. Environment dependent parameters
4. Service declaration
   1. Simple services
   2. Factories
   3. Decorating services
5. Custom file organisation
   1. Import other files
   2. Use your own provider

Install

You can use Composer to install the bundle to your project:, _(*4)

composer require theofidry/laravel-yaml

Then, add the provider Fidry\LaravelYaml\Provider\DefaultExtensionProvider to your application providers:, _(*5)

<?php
// config/app.php

'providers' => [
    // ...
    \Fidry\LaravelYaml\Provider\DefaultExtensionProvider::class,
];

Usage

See how to declare and use parameters and services!, _(*6)

By convention, you should have the following structure:, _(*7)

resources/
    providers/
        parameters.yml
        parameters_testing.yml
        services.yml

The parameters.yml should contain all of your application parameters values:, _(*8)

# resources/providers/parameters.yml

parameters:
    my_parameter: parameter_value

Depending of your environment, a second parameters file will be loaded. For example, if your application environment (by default defined by the environment variable APP_ENV in your .env file) is 'testing' or 'production', the library will try to load the parameters_testing.yml or parameters_production.yml file., _(*9)

Then services.yml should contain all your service definitions., _(*10)

See more., _(*11)

Credits

This bundle is developed by Théo FIDRY., _(*12)