bauhaus/config

Simple config container

, _(*1)

, _(*2)

Warning! This package won't worry about backward compatibily for v0.*., _(*3)

Bauhaus Config

Bauhaus Config aims to provide a simple way to load and validate configurations via a container implementation of PSR-11., _(*4)

TODOS

This package isn't still complete. Missing features are:, _(*5)

• Validate configuration schema (use JSON schema)
• Load from yaml (It will be done in a new repository bauhaus/config-yaml)

Motivation

It's annoying when something inside your application breaks just because a configuration entry was missing., _(*6)

To prevent it, Bauhaus Config validates when the configurations are loaded (being implemented)., _(*7)

Usage

<?php

use Psr\Container\NotFoundExceptionInterface as PsrNotFoundException;
use Psr\Container\ContainerInterface as PsrContainer;
use Bauhaus\Config;
use Bauhaus\Config\NotFoundException;

$config = new Config([
    'instrument' => 'bass',
    'pokemons' => ['charmander', 'pikachu'],
    'books' => [
        'study' => ['Clean Code', 'GOOS', 'Design Patterns'],
    ],
]);

$config instanceof PsrContainer; // true

$config->has('instrument'); // true
$config->has('pokemons'); // true
$config->has('books.study'); // true
$config->has('cars'); // false
$config->has('travels.asia'); // false

$config->get('instrument'); // 'bass'
$config->get('pokemons'); // ['charmander', 'pikachu']
$config->get('books'); // Config(['study' => ['Clean Code', 'GOOS', 'Design Patterns']])
$config->get('cars'); // throw NotFoundException implementing PsrNotFoundException
$config->get('travels.asia'); // throw NotFoundException implementing PsrNotFoundException

$config->get('books')->has('study'); // true

Installation

Install it using Composer:, _(*8)

$ composer require bauhaus/config

Coding Standard and Testing

This code has two levels of testing:, _(*9)

1. Coding standard (using PHPCS with PSR-2 standard):, _(*10)

   $ composer run test:cs
   

2. Unit tests (using PHPUnit):, _(*11)

   $ composer run test:unit
   

To run all at one:, _(*12)

$ composer run tests