anax/configure

Anax Configure module for reading config files.

Anax Configure

, _(*1)

, _(*2)

, _(*3)

, _(*4)

Read configuration files for Anax and Anax modules., _(*5)

The configuration files for a module can be stored in one of several base directories. The Configuration class scans all valid base directories and stops at the first one containing configuration items., _(*6)

The configuration items can be stored in a file, and/or in a directory containing several files. All files are loaded and combined into one array containing each bits and piece of the module configuration., _(*7)

Install

$ composer require anax/configure

Related classes

These are the classes included in this module, and their primary purpose., _(*8)

Use as DI service

You can create the Configuration object as a $di service. That is how Anax does it., _(*9)

Sample usage

Create a object that can read configuration files., _(*10)

First create the object and point it to a set of directories., _(*11)

$config = new \Anax\Configure\Configuration();
$dirs = ["path1", "path2"];
$config->setBaseDirectories($dirs);

Now use the objekt to find and load configuration files for an item, in the example we are using the module "router" as an example., _(*12)

$config = $di->get("configuration")->load("route")

The $config will now contain the configuration items found from the file, or files. You could now provide the array to the module or object that should use it., _(*13)

A configuration file

A configuration file for a module "route" is any, or a combination of the following., _(*14)

The files should return a value, which will be its contribution to the configuration., _(*15)

The configuration array

The resulting configuration array looks like this, still using "route" as example for the module name., _(*16)

$config = [
    "file" => filename for route.php,
    "config" => result returned from route.php,
    "items" => [
        [
            "file" => filename for route/file1.php,
            "config" => result returned from route/file1.php,
        ],
        [
            "file" => filename for route/file2.php,
            "config" => result returned from route/file2.php,
        ],
    ].
];

Tha "route" module can then decide on how to use the actual configuration details., _(*17)

Dependency

There are no dependencies., _(*18)

License

This software carries a MIT license. See LICENSE.txt for details., _(*19)

 .  
..:  Copyright (c) 2013 - 2018 Mikael Roos, mos@dbwebb.se