Skip to content

Working with confguration values

Minicli provides a confguration manager through the Config class. At the same time, the Config class is a built-in service (by implementing ServiceInterface) resgistered as a service when the Appclass is instanciated, allowing it to be used inside each command controller.

Getting Configuration values

It is expected for any application to depend on configuration values. They can be provided by static files or even from environment variables. As long as the App instance is accessible, the entire configuration definition will be available and just like retrieving services from the App container, the configuration keys will be available via __get magic method: In the case of a certain configuration key is not set, null will be returned instead.

In your controllers, you can access the configuration values via the config property:

Command Controller Example

PHP
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
<?php
namespace App\Command\Demo;
use Minicli\Command\CommandController;
class ConfigExampleController extends CommandController
{
    public function handle(): void
    {
        $configValue = $this->config->applicationEnvironment ;
    }
}

Service class example

PHP
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
<?php
namespace App\Services;
use Minicli\App;
use Minicli\ServiceInterface;

class ExampleService implements ServiceInterface
{
    private $stencilTemplatePath;

    public function load(App $app): void
    {
        $this->stencilTemplatePath = $app->config->customStencilsPath;
    }
}

Check if configuration exists via has method

As mentioned, if the configuration name does not exists, then null will be returned. When it is required to validate if a configuration key exists, the has() method is the right one.

PHP
1
2
3
4
5
...
    if($app->config->has('customKey') {
        // ...
    }
...

Setting configuration values

When instanciating App

An arrayof configuration values can be defined when instanciating the App class, given that its __construct will use it to create the Config service and add it to the app container.

PHP
1
2
3
4
5
6
7
...
$configs = [
    'customStencilsPath' => __DIR__ . '/stencils',
    'customConfigKey' => 'custom-config-value'
];

$app = new App($configs);

Custom configuration from external sources

Another approach is using the magic __set() method from the Config class to add configuration values. Consider the scenario in which configs are available on environment variables or in a json file:

Reading configurations from external sources
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
// code from your minicli file ...
$app = new App([
    ...
]);

/* Adding configs using env vars */
$app->config->db_host = getenv('ENV_VAR_NAME');

/* Adding configs using json files */
$externalJSONContent = file_get_contents(__DIR__ . '/configs.json');
$parsedContent = json_decode($externalJSONContent);

foreach ($parsedContent as $name => $value) {
    $app->config->$name = $value;
}
// code continues ...
configs.json file example from the previous code block
1
2
3
4
{
    "api_url": "https://api.minicli.dev",
    "api_version": "1.2"
}