Edit on GitHub
Jump to docs navigation

Configuration / Accessing & Reading Configuration

Note: You are currently reading the documentation for Bolt 3.6. Looking for the documentation for Bolt 3.5 instead?

Once an application has loaded then you are able to access configuration parameters either in PHP code or via Twig templates within your active theme. As part of the application boot process a few processing steps happen to compile the final configuration and this includes merging any environment specific overrides inside _local.yml suffixed files.

Accessing Configuration in PHP

The configuration service is made available on the Bolt application via $app['config']. The primary method to read configuration variables is $app['config']->get(). Since config variables can take the form of nested arrays then this method allows you to traverse through the array structure by using the slash separator.

Additionally there are prefixes to specify which configuration type you want to read from.

These prefixes are:

Section YAML file
general config.yml and config_local.yml
contenttypes contenttypes.yml
menu menu.yml
permissions permissions.yml
routing routing.yml
taxonomy taxonomy.yml
theme theme.yml (in the active theme directory)

"General" refers to the main configuration found in config.yml and config_local.yml. For example to fetch the locale setting from the main configuration, we can use: $app['config']->get('general/locale');

To traverse into an array we just need to specify it in the method call: $app['config']->get('general/database/driver');

Accessing Configuration in Twig

You can use the above method to read configuration values in Twig too, the service is made available in all Twig templates via the config service. Usage is otherwise the same as the PHP details above.

To print the relevant value:

{{ config.get('general/locale') }}

The theme.yml can also be accessed directly, so it looks cleaner in the template code:

{{ theme.foo }} // Outputs the `foo:` setting

Dynamic runtime values

Occasionally you may want to provide and read dynamic values that can be provided either via an environment variable or via another service that in turn provides a value.

Reading environment variables

Within the config files you can specify such values using the following syntax:

    database:
        driver: mysql
        username: %APP_USERNAME%
        password: %APP_PASSWORD%
        databasename: %APP_DATABASE%

This is very convenient if you want to inject configuration into a staging or production server, rather than having it in the configuration files that might be stored in your versioning system.

The values will be swapped out at runtime for the value returned by getenv(), like for example getenv('APP_DB_HOST') for %APP_DB_HOST%, if it is set.

Note: If you are using Nginx with PHP-FPM, you will need to change the clear_env variable value to no in the PHP configuration. Generally this configuration is in /etc/php5/fpm/pool.d/www.conf commented as ;clear_env = no, just uncomment this line and restart php-fpm

Providing variables with a service

Similar to the environment lookup you can delegate the value to a service that is defined on $app

Within the config file you can use the following syntax.

    sitecolor: %colourservice%
    headercolumns: %layoutservice:header%
    bodycolumns: %layoutservice:body%

When referring to a service it must either be a callable and return a value or in the case of a simple value (eg: $app['config.example'] = 'example') then this will be returned as is.

You are also able to pass one parameter to a callable, this is separated with the : as in the example above.

The services as defined above would need to be implemented as in the examples below:

    $app['colourservice'] = function() {
        $colours = ['red', 'white', 'blue'];

        return $colours[array_rand($colours)];
    };

    $app['layoutservice'] = function($block) {
        if ($block === 'header') {
            return 4;
        }

        return 6;
    };
Edit this page on GitHub
Couldn't find what you were looking for? We are happy to help you in the forum, on Slack or on IRC.