corex/config

Config Framework (multiple apps)

Config Component

, _(*1)

Breaking changes - this package has been rewritten from scratch to be more strict and flexible to use. Adapters are supported in favor of loaders. Breaking changes can be found in CHANGELOG., _(*2)

Getting configuration values works by creating instance of Config::class and use methods to get values. Multiple adapters are supported., _(*3)

Example:, _(*4)

$adapter = new ArrayAdapter([
    'actor' => [
        'name' => 'James Bond',
    ],
]);

$config = new Config([$adapter]);

$actorName = $config->getString('actor.name');

A method section() is added for convenience when section and rest of key is separated eg. section = "actor" and key = "name"., _(*5)

Example of using section():, _(*6)

$adapter = new ArrayAdapter([
    'actor' => [
        'name' => 'James Bond',
    ],
]);

$config = new Config([$adapter]);

$actorName = $config->section('actor')->getString('name');

A method getConfigClassObject() is added for getting array and pass to config-class on constructor., _(*7)

Example of using getConfigClassObject():, _(*8)

class MyConfigClass implements ConfigClassInterface
{
    public function __construct(array $data)
    {
    }

    public static function getSection(): string
    {
        return 'actor';
    }
}

$adapter = new ArrayAdapter([
    'actor' => [
        'name' => 'James Bond',
    ],
]);

$config = new Config([$adapter]);

/** @var MyConfigClass $actorConfig */
$myConfigClass = $config->getConfigClassObject(MyConfigClass::class);

ConfigFactory

A ConfigFactory exists to make it easier to create instances of Config::class., _(*9)

Example:, _(*10)

$config = (new ConfigFactory())
    ->createWithServerAndEnvAndProjectConfigArrayFileAdapter();

The above example exposes 3 adapters ServerAdapter, EnvAdapter and ProjectConfigArrayFileAdapter., _(*11)

From above example, when getting value, the process is following. - ServerAdapter is checked for key. If found, value is returned. - EnvAdapter is checked for key. If found, value is returned. - ProjectConfigArrayFileAdapter is checked for key. If found, value is returned., _(*12)

Based on various methods to get values, a null is returned or an exception is thrown., _(*13)

More methods exists, but in the situation where they does not fit in, instantiate Config::class with your own order of adapters., _(*14)

Keys

Every key must be specified as dot notation e.g. "actor.name"., _(*15)

"_" and "-" will not be treated as separators., _(*16)

When using ServerAdapter and EnvAdapter, the key will be converted to shoutcase e.g. ACTOR_NAME. This makes it easy to override values in e.g. cloud environments., _(*17)

Key object is passed to adapter and multiple methods exists to get key in various formats. Use custom() to build your own., _(*18)

Config

Various methods exists on config-class for getting values in correct format. There exists methods for getting specific type with or without null eg. "getString()" or "getStringOrNull()" . Following types are supported: string, int, bool translated-bool, double, array, list., _(*19)

For all type methods, value from adapters will be checked if they are correct type, otherwise an exception is thrown., _(*20)

"translated-bool" translates/converts following values to boolean., _(*21)

Values for true : ['true', true, 'yes', 'on', 1, '1']., _(*22)

Values for false : ['false', false, 'no', 'off', 0, '0']., _(*23)

"list" means an array where keys are numeric keys 0..n., _(*24)

Adapters

It is possible to write your own adapter by extending AbstractAdapter or implementing AdapterInterface., _(*25)

Following standard adapters expose arrays as the basis for configuration values., _(*26)

ArrayAdapter, _(*27)

Serve simple array., _(*28)

$adapter = new ArrayAdapter([
    'actor' => [
        'name' => 'James Bond',
    ],
]);

EnvAdapter, _(*29)

Serve $_ENV global array., _(*30)

$adapter = new EnvAdapter();

ServerAdapter, _(*31)

Serve $_SERVER global array., _(*32)

$adapter = new ServerAdapter();

ArrayFileAdapter, _(*33)

Serve php array files outside project root., _(*34)

$adapter = new ArrayFileAdapter(new Filesystem(), '/config-dir-outside-project-root');

ProjectPathArrayFileAdapter - Serve, _(*35)

Serve php array files in project root from relative directory., _(*36)

$adapter = new ProjectPathArrayFileAdapter(new Filesystem(), 'my-config-dir');

ProjectConfigArrayFileAdapter, _(*37)

Serve php array files in project root from relative directory called "config"., _(*38)

$adapter = new ProjectConfigArrayFileAdapter(new Filesystem());

Array files.

Example of an array-file., _(*39)

Name of file "bond.php"., _(*40)

<?php

declare(strict_types=1);

return [
    'actor1' => [
        'firstname' => 'Roger',
        'lastname' => 'Moore'
    ],
    'actor3' => [
        'firstname' => 'Daniel',
        'lastname' => 'Craig'
    ]
];

These type of files can be loaded via ArrayFileAdapter, ProjectPathArrayFileAdapter and ProjectConfigArrayFileAdapter., _(*41)

Example of a config-key: "bond.actor1.firstname" which will return "Roger"., _(*42)

First section of key "bond" indicates the section and on these adapters the filename., _(*43)