jameswmcnab/config-yaml

A simple YAML config file loader for Laravel, taking inspiration from illuminate/config.

Abandoned

This package is abandoned and no longer maintained. The author suggests using the pragmarx/yaml package instead., _(*1)

YAML Config Loader for Laravel

, _(*2)

This provides simple YAML config loading to Laravel. It takes a lot of inspiration from the illuminate/config package and uses the Symfony YAML parser., _(*3)

This is not a replacement for the built-in PHP config file system in Laravel but is intended as an extra 'layer' of configuration. This allows you to have one or more Ruby-like config.yaml files containing user-configurable config for your application., _(*4)

By default the package assumes your YAML files are in the base_path() directory, but you can customise this by publishing the package config file (config-yaml.php) to your application and changing the yaml_path key., _(*5)

Installation

Installation is via Composer:, _(*6)

$ composer require jameswmcnab/config-yaml

Publish package config (optional)

If you want to customise the package config, publish the package config then edit the newly created config/config-yaml.php file:, _(*7)

$ php artisan vendor:publish --provider=ConfigYamlServiceProvider

Usage

Example YAML file:, _(*8)

``` yaml, <sub>(*9)</sub>

Example YAML config.yaml file

app: name: "Great App" version: 1.0.2, <sub>(*10)</sub>

log: dir: /var/log/vendor/app level: debug, <sub>(*11)</sub>

database: adapter: mysql database: app_live username: user password: password ````, <sub>(*12)</sub>

Using the facade

Note: Remember to register the facade in your app.php config., <sub>(*13)</sub>

``` php ConfigYaml::get('config.database.adapter'); // mysql, <sub>(*14)</sub>

#### Using dependency injection

If you don't want to use the facade just directly inject `Jameswmcnab\ConfigYaml\RepositoryInterface` wherever dependency 
injection is supported and use it directly:

``` php
<?php

namespace App\Foo;

use Jameswmcnab\ConfigYaml\RepositoryInterface;

class FooBar
{
    /**
     * @var RepositoryInterface
     */
    private $yamlConfig;

    /**
     * FooBar constructor.
     *
     * @param RepositoryInterface $yamlConfig
     */
    public function __construct(RepositoryInterface $yamlConfig)
    {
        $this->yamlConfig = $yamlConfig;
    }

    /**
     * @return array|string
     */
    private function getDatabaseAdapter()
    {
        return $this->yamlConfig->get('config.database.adapter');  // mysql
    }
}

Running Tests

To run the package tests:, <sub>(*15)</sub>

bash $ vendor/bin/phpspec run $ vendor/bin/phpunit, <sub>(*16)</sub>