Процессоры переменных окружения

Дата обновления перевода 2023-01-19

Процессоры переменных окружения

Использование переменных окружения для конфигурации приложений Symfony - это распространённая практика для того, чтобы сделать ваше приложение дейтвительно динамическим.

Главная проблема переменных окружения в том, что их значения могут быть только строками, а вашему приложению могут быть нужны другие типы данных (целые числа, булевы и т.л.). Symfony решает эту проблему с помощью "процессоров переменных окружения", которые преобразуют изначальное содержание заданных переменных окружения. Следующий пример использует процессор целого числа, чтобы преобразовать значение переменной окружения HTTP_PORT в целое число:

YAML
XML
PHP

        1
2
3
4
        # config/packages/framework.yaml
framework:
    router:
        http_port: '%env(int:HTTP_PORT)%'
    

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
        <!-- config/packages/framework.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:framework="http://symfony.com/schema/dic/symfony"
    xsi:schemaLocation="http://symfony.com/schema/dic/services
        https://symfony.com/schema/dic/services/services-1.0.xsd
        http://symfony.com/schema/dic/symfony
        https://symfony.com/schema/dic/symfony/symfony-1.0.xsd">

    <framework:config>
        <framework:router http-port="%env(int:HTTP_PORT)%"/>
    </framework:config>
</container>
    

        1
2
3
4
5
6
7
8
9
10
11
12
        // config/packages/framework.php
namespace Symfony\Component\DependencyInjection\Loader\Configurator;

use Symfony\Config\FrameworkConfig;

return static function (FrameworkConfig $framework) {
    $framework->router()
        ->httpPort('%env(int:HTTP_PORT)%')
        // или
        ->httpPort(env('HTTP_PORT')->int())
    ;
};
    

Встроенные процессоры переменных окружения

Symfony предоставляет следующие процессоры переменных окружения:

env(string:FOO)

Преобразует FOO в строку:

YAML
XML
PHP

        1
2
3
4
5
        # config/packages/framework.yaml
parameters:
    env(SECRET): 'some_secret'
framework:
    secret: '%env(string:SECRET)%'
    

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
        <!-- config/packages/framework.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:framework="http://symfony.com/schema/dic/symfony"
    xsi:schemaLocation="http://symfony.com/schema/dic/services
        https://symfony.com/schema/dic/services/services-1.0.xsd
        http://symfony.com/schema/dic/symfony
        https://symfony.com/schema/dic/symfony/symfony-1.0.xsd">

    <parameters>
        <parameter key="env(SECRET)">some_secret</parameter>
    </parameters>

    <framework:config secret="%env(string:SECRET)%"/>
</container>
    

        1
2
3
4
5
6
7
8
9
10
        // config/packages/framework.php
namespace Symfony\Component\DependencyInjection\Loader\Configurator;

use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Config\FrameworkConfig;

return static function (ContainerBuilder $container, FrameworkConfig $framework) {
    $container->setParameter('env(SECRET)', 'some_secret');
    $framework->secret(env('SECRET')->string());
};
    

env(bool:FOO)

Преобразует FOO в булево значение (значения true - 'true', 'on', 'yes' и все числа, кроме 0 и 0.0; всё другое - false):

YAML
XML
PHP

        1
2
3
4
5
        # config/packages/framework.yaml
parameters:
    env(HTTP_METHOD_OVERRIDE): 'true'
framework:
    http_method_override: '%env(bool:HTTP_METHOD_OVERRIDE)%'
    

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
        <!-- config/packages/framework.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:framework="http://symfony.com/schema/dic/symfony"
    xsi:schemaLocation="http://symfony.com/schema/dic/services
        https://symfony.com/schema/dic/services/services-1.0.xsd
        http://symfony.com/schema/dic/symfony
        https://symfony.com/schema/dic/symfony/symfony-1.0.xsd">

    <parameters>
        <parameter key="env(HTTP_METHOD_OVERRIDE)">true</parameter>
    </parameters>

    <framework:config http-method-override="%env(bool:HTTP_METHOD_OVERRIDE)%"/>
</container>
    

        1
2
3
4
5
6
7
8
9
10
        // config/packages/framework.php
namespace Symfony\Component\DependencyInjection\Loader\Configurator;

use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Config\FrameworkConfig;

return static function (ContainerBuilder $container, FrameworkConfig $framework) {
    $container->setParameter('env(HTTP_METHOD_OVERRIDE)', 'true');
    $framework->httpMethodOverride(env('HTTP_METHOD_OVERRIDE')->bool());
};
    

env(not:FOO)

Преобразует FOO в булево значение (как и env(bool:...)), но возвращает инвертированное значение (ложные значения возвращаются как true, правильные значения возвращаются какэ false):

YAML
XML
PHP

        1
2
3
        # config/services.yaml
parameters:
    safe_for_production: '%env(not:APP_DEBUG)%'
    

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
        <!-- config/services.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:framework="http://symfony.com/schema/dic/symfony"
    xsi:schemaLocation="http://symfony.com/schema/dic/services
        https://symfony.com/schema/dic/services/services-1.0.xsd
        http://symfony.com/schema/dic/symfony
        https://symfony.com/schema/dic/symfony/symfony-1.0.xsd">

    <parameters>
        <parameter key="safe_for_production">%env(not:APP_DEBUG)%</parameter>
    </parameters>

</container>
    

        1
2
        // config/services.php
$container->setParameter('safe_for_production', '%env(not:APP_DEBUG)%');
    

env(int:FOO)

Преобразует FOO в целое число.

env(float:FOO)

Преобразует FOO в плавающее число.

env(const:FOO)

Находит константное значение, именованное в FOO:

YAML
XML
PHP

        1
2
3
4
5
6
        # config/packages/security.yaml
parameters:
    env(HEALTH_CHECK_METHOD): 'Symfony\Component\HttpFoundation\Request::METHOD_HEAD'
security:
    access_control:
        - { path: '^/health-check$', methods: '%env(const:HEALTH_CHECK_METHOD)%' }
    

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
        <!-- config/packages/security.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:security="http://symfony.com/schema/dic/security"
    xsi:schemaLocation="http://symfony.com/schema/dic/services
        https://symfony.com/schema/dic/services/services-1.0.xsd
        http://symfony.com/schema/dic/security
        https://symfony.com/schema/dic/security/security-1.0.xsd">

    <parameters>
        <parameter key="env(HEALTH_CHECK_METHOD)">Symfony\Component\HttpFoundation\Request::METHOD_HEAD</parameter>
    </parameters>

    <security:config>
        <rule path="^/health-check$" methods="%env(const:HEALTH_CHECK_METHOD)%"/>
    </security:config>
</container>
    

        1
2
3
4
5
6
7
8
9
10
        // config/packages/security.php
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Config\SecurityConfig;

return static function (ContainerBuilder $container, SecurityConfig $security) {
    $container->setParameter('env(HEALTH_CHECK_METHOD)', 'Symfony\Component\HttpFoundation\Request::METHOD_HEAD');
    $security->accessControl()
        ->path('^/health-check$')
        ->methods([env('HEALTH_CHECK_METHOD')->const()]);
};
    

env(base64:FOO)

Расшифровывает содержание FOO, который является строкой, зашифрованной в base64.

env(json:FOO)

Расшифровывает содержание FOO, который является строкой, зашифрованной в JSON. Возвращает массив или null:

YAML
XML
PHP

        1
2
3
4
5
        # config/packages/framework.yaml
parameters:
    env(TRUSTED_HOSTS): '["10.0.0.1", "10.0.0.2"]'
framework:
    trusted_hosts: '%env(json:TRUSTED_HOSTS)%'
    

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
        <!-- config/packages/framework.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:framework="http://symfony.com/schema/dic/symfony"
    xsi:schemaLocation="http://symfony.com/schema/dic/services
        https://symfony.com/schema/dic/services/services-1.0.xsd
        http://symfony.com/schema/dic/symfony
        https://symfony.com/schema/dic/symfony/symfony-1.0.xsd">

    <parameters>
        <parameter key="env(TRUSTED_HOSTS)">["10.0.0.1", "10.0.0.2"]</parameter>
    </parameters>

    <framework:config trusted-hosts="%env(json:TRUSTED_HOSTS)%"/>
</container>
    

        1
2
3
4
5
6
7
8
9
10
        // config/packages/framework.php
namespace Symfony\Component\DependencyInjection\Loader\Configurator;

use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Config\FrameworkConfig;

return static function (ContainerBuilder $container, FrameworkConfig $framework) {
    $container->setParameter('env(TRUSTED_HOSTS)', '["10.0.0.1", "10.0.0.2"]');
    $framework->trustedHosts(env('TRUSTED_HOSTS')->json());
};
    

env(resolve:FOO)

Если содержание FOO имеет параметры контейнера (с синтаксисом %parameter_name%), заменяет параметры их значениями:

YAML
XML
PHP

        1
2
3
4
5
6
7
        # config/packages/sentry.yaml
parameters:
    env(HOST): '10.0.0.1'
    sentry_host: '%env(HOST)%'
    env(SENTRY_DSN): 'http://%sentry_host%/project'
sentry:
    dsn: '%env(resolve:SENTRY_DSN)%'
    

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
        <!-- config/packages/sentry.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://symfony.com/schema/dic/services
        https://symfony.com/schema/dic/services/services-1.0.xsd">

    <parameters>
        <parameter key="env(HOST)">10.0.0.1</parameter>
        <parameter key="sentry_host">%env(HOST)%</parameter>
        <parameter key="env(SENTRY_DSN)">http://%sentry_host%/project</parameter>
    </parameters>

    <sentry:config dsn="%env(resolve:SENTRY_DSN)%"/>
</container>
    

        1
2
3
4
5
6
7
        // config/packages/sentry.php
$container->setParameter('env(HOST)', '10.0.0.1');
$container->setParameter('sentry_host', '%env(HOST)%');
$container->setParameter('env(SENTRY_DSN)', 'http://%sentry_host%/project');
$container->loadFromExtension('sentry', [
    'dsn' => '%env(resolve:SENTRY_DSN)%',
]);
    

env(csv:FOO)

Расшифровывает содержание FOO, который является строкой, зашифрованной в CSV:

YAML
XML
PHP

        1
2
3
4
5
        # config/packages/framework.yaml
parameters:
    env(TRUSTED_HOSTS): "10.0.0.1,10.0.0.2"
framework:
   trusted_hosts: '%env(csv:TRUSTED_HOSTS)%'
    

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
        <!-- config/packages/framework.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:framework="http://symfony.com/schema/dic/symfony"
    xsi:schemaLocation="http://symfony.com/schema/dic/services
        https://symfony.com/schema/dic/services/services-1.0.xsd
        http://symfony.com/schema/dic/symfony
        https://symfony.com/schema/dic/symfony/symfony-1.0.xsd">

    <parameters>
        <parameter key="env(TRUSTED_HOSTS)">10.0.0.1,10.0.0.2</parameter>
    </parameters>

    <framework:config trusted-hosts="%env(csv:TRUSTED_HOSTS)%"/>
</container>
    

        1
2
3
4
5
6
7
8
9
10
        // config/packages/framework.php
namespace Symfony\Component\DependencyInjection\Loader\Configurator;

use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Config\FrameworkConfig;

return static function (ContainerBuilder $container, FrameworkConfig $framework) {
    $container->setParameter('env(TRUSTED_HOSTS)', '10.0.0.1,10.0.0.2');
    $framework->trustedHosts(env('TRUSTED_HOSTS')->csv());
};
    

env(shuffle:FOO)

Рандомно перемешивает значения переменной окружения FOO, которая должна быть массивом.

YAML
XML
PHP

        1
2
3
4
5
6
7
        # config/packages/framework.yaml
parameters:
    env(REDIS_NODES): "127.0.0.1:6380,127.0.0.1:6381"
services:
    RedisCluster:
        class: RedisCluster
        arguments: [null, "%env(shuffle:csv:REDIS_NODES)%"]
    

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
        <!-- config/packages/framework.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:framework="http://symfony.com/schema/dic/symfony"
    xsi:schemaLocation="http://symfony.com/schema/dic/services
        https://symfony.com/schema/dic/services/services-1.0.xsd
        http://symfony.com/schema/dic/symfony
        https://symfony.com/schema/dic/symfony/symfony-1.0.xsd">

    <parameters>
        <parameter key="env(REDIS_NODES)">redis://127.0.0.1:6380,redis://127.0.0.1:6381</parameter>
    </parameters>

    <services>
        <service id="RedisCluster" class="RedisCluster">
            <argument>null</argument>
            <argument>%env(shuffle:csv:REDIS_NODES)%</argument>
        </service>
    </services>
</container>
    

        1
2
3
4
5
6
7
        // config/services.php
use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;

return static function (ContainerConfigurator $configurator): void {
    $container = $configurator->services()
        ->set(\RedisCluster::class, \RedisCluster::class)->args([null, '%env(shuffle:csv:REDIS_NODES)%']);
};
    

6.2

Процессор переменной окружения env(shuffle:...) был представлен в Symfony 6.2.

env(file:FOO)

Возвращает содержание файла, чей путь является значением переменной окружения FOO:

YAML
XML
PHP

        1
2
3
4
5
        # config/packages/framework.yaml
parameters:
    env(AUTH_FILE): '../config/auth.json'
google:
    auth: '%env(file:AUTH_FILE)%'
    

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
        <!-- config/packages/framework.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:framework="http://symfony.com/schema/dic/symfony"
    xsi:schemaLocation="http://symfony.com/schema/dic/services
        https://symfony.com/schema/dic/services/services-1.0.xsd
        http://symfony.com/schema/dic/symfony
        https://symfony.com/schema/dic/symfony/symfony-1.0.xsd">

    <parameters>
        <parameter key="env(AUTH_FILE)">../config/auth.json</parameter>
    </parameters>

    <google auth="%env(file:AUTH_FILE)%"/>
</container>
    

        1
2
3
4
5
        // config/packages/framework.php
$container->setParameter('env(AUTH_FILE)', '../config/auth.json');
$container->loadFromExtension('google', [
    'auth' => '%env(file:AUTH_FILE)%',
]);
    

env(require:FOO)

require() PHP-файл, чей путь является значением переменной окружения FOO и возвращает значение, возвращённое из нее.

YAML
XML
PHP

        1
2
3
4
5
        # config/packages/framework.yaml
parameters:
    env(PHP_FILE): '../config/.runtime-evaluated.php'
app:
    auth: '%env(require:PHP_FILE)%'
    

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
        <!-- config/packages/framework.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:framework="http://symfony.com/schema/dic/symfony"
    xsi:schemaLocation="http://symfony.com/schema/dic/services
        https://symfony.com/schema/dic/services/services-1.0.xsd
        http://symfony.com/schema/dic/symfony
        https://symfony.com/schema/dic/symfony/symfony-1.0.xsd">

    <parameters>
        <parameter key="env(PHP_FILE)">../config/.runtime-evaluated.php</parameter>
    </parameters>

    <app auth="%env(require:PHP_FILE)%"/>
</container>
    

        1
2
3
4
5
        // config/packages/framework.php
$container->setParameter('env(PHP_FILE)', '../config/.runtime-evaluated.php');
$container->loadFromExtension('app', [
    'auth' => '%env(require:PHP_FILE)%',
]);
    

env(trim:FOO)

Усекает содержание переменной окружения FOO, удаляя пробелы в начале и конце строки. Это особенно полезно в сочетании с процессором file, так как он удалит пустые строчки в конце файла.

YAML
XML
PHP

        1
2
3
4
5
        # config/packages/framework.yaml
parameters:
    env(AUTH_FILE): '../config/auth.json'
google:
    auth: '%env(trim:file:AUTH_FILE)%'
    

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
        <!-- config/packages/framework.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:framework="http://symfony.com/schema/dic/symfony"
    xsi:schemaLocation="http://symfony.com/schema/dic/services
        https://symfony.com/schema/dic/services/services-1.0.xsd
        http://symfony.com/schema/dic/symfony
        https://symfony.com/schema/dic/symfony/symfony-1.0.xsd">

    <parameters>
        <parameter key="env(AUTH_FILE)">../config/auth.json</parameter>
    </parameters>

    <google auth="%env(trim:file:AUTH_FILE)%"/>
</container>
    

        1
2
3
4
5
        // config/packages/framework.php
$container->setParameter('env(AUTH_FILE)', '../config/auth.json');
$container->loadFromExtension('google', [
    'auth' => '%env(trim:file:AUTH_FILE)%',
]);
    

env(key:FOO:BAR)

Извлекает значение, ассоциированное с ключом FOO из массива, чьё содержание хранится в переменной окружения BAR:

YAML
XML
PHP

        1
2
3
4
5
        # config/services.yaml
parameters:
    env(SECRETS_FILE): '/opt/application/.secrets.json'
    database_password: '%env(key:database_password:json:file:SECRETS_FILE)%'
    # if SECRETS_FILE contents are: {"database_password": "secret"} it returns "secret"
    

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
        <!-- config/services.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:framework="http://symfony.com/schema/dic/symfony"
    xsi:schemaLocation="http://symfony.com/schema/dic/services
        https://symfony.com/schema/dic/services/services-1.0.xsd
        http://symfony.com/schema/dic/symfony
        https://symfony.com/schema/dic/symfony/symfony-1.0.xsd">

    <parameters>
        <parameter key="env(SECRETS_FILE)">/opt/application/.secrets.json</parameter>
        <parameter key="database_password">%env(key:database_password:json:file:SECRETS_FILE)%</parameter>
    </parameters>
</container>
    

        1
2
3
        // config/services.php
$container->setParameter('env(SECRETS_FILE)', '/opt/application/.secrets.json');
$container->setParameter('database_password', '%env(key:database_password:json:file:SECRETS_FILE)%');
    

env(default:fallback_param:BAR)

Извлекает значение параметра fallback_param, если переменная окружения BAR не доступна:

YAML
XML
PHP

        1
2
3
4
5
        # config/services.yaml
parameters:
    # если PRIVATE_KEY не является валидным путём файла, возвращается содержание raw_key
    private_key: '%env(default:raw_key:file:PRIVATE_KEY)%'
    raw_key: '%env(PRIVATE_KEY)%'
    

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
        <!-- config/services.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:framework="http://symfony.com/schema/dic/symfony"
    xsi:schemaLocation="http://symfony.com/schema/dic/services
        https://symfony.com/schema/dic/services/services-1.0.xsd
        http://symfony.com/schema/dic/symfony
        https://symfony.com/schema/dic/symfony/symfony-1.0.xsd">
    <parameters>
        <!-- если PRIVATE_KEY не является валидным путём файла, возвращается содержание raw_key -->
        <parameter key="private_key">%env(default:raw_key:file:PRIVATE_KEY)%</parameter>
        <parameter key="raw_key">%env(PRIVATE_KEY)%</parameter>
    </parameters>
</container>
    

        1
2
3
4
5
        // config/services.php

// если PRIVATE_KEY не является валидным путём файла, возвращается содержание raw_key
$container->setParameter('private_key', '%env(default:raw_key:file:PRIVATE_KEY)%');
$container->setParameter('raw_key', '%env(PRIVATE_KEY)%');
    

Если опускается резервный параметр (например, env(default::API_KEY)), то возвращённое значение - null.

env(url:FOO)

Анализирует абсолютный URL и возвращает его компоненты как ассоциативный массив.

        1
2
        # .env
MONGODB_URL="mongodb://db_user:db_password@127.0.0.1:27017/db_name"
    

YAML
XML
PHP

        1
2
3
4
5
6
7
8
9
10
11
        # config/packages/mongodb.yaml
mongo_db_bundle:
    clients:
        default:
            hosts:
                - { host: '%env(string:key:host:url:MONGODB_URL)%', port: '%env(int:key:port:url:MONGODB_URL)%' }
            username: '%env(string:key:user:url:MONGODB_URL)%'
            password: '%env(string:key:pass:url:MONGODB_URL)%'
    connections:
        default:
            database_name: '%env(key:path:url:MONGODB_URL)%'
    

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
        <!-- config/packages/mongodb.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://symfony.com/schema/dic/services
        https://symfony.com/schema/dic/services/services-1.0.xsd">

    <mongodb:config>
        <mongodb:client name="default" username="%env(string:key:user:url:MONGODB_URL)%" password="%env(string:key:pass:url:MONGODB_URL)%">
            <mongodb:host host="%env(string:key:host:url:MONGODB_URL)%" port="%env(int:key:port:url:MONGODB_URL)%"/>
        </mongodb:client>
        <mongodb:connections name="default" database_name="%env(key:path:url:MONGODB_URL)%"/>
    </mongodb:config>
</container>
    

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
        // config/packages/mongodb.php
$container->loadFromExtension('mongodb', [
    'clients' => [
        'default' => [
            'hosts' => [
                [
                    'host' => '%env(string:key:host:url:MONGODB_URL)%',
                    'port' => '%env(int:key:port:url:MONGODB_URL)%',
                ],
            ],
            'username' => '%env(string:key:user:url:MONGODB_URL)%',
            'password' => '%env(string:key:pass:url:MONGODB_URL)%',
        ],
    ],
    'connections' => [
        'default' => [
            'database_name' => '%env(key:path:url:MONGODB_URL)%',
        ],
    ],
]);
    

Caution

Для того, чтобы облегчить извлечение источника из URL, лидирующий / усекается из компонента path.

env(query_string:FOO)

Анализирует часть строки запроса заданного URL и возвращает его компоненты как ассоциативный массив.

        1
2
        # .env
MONGODB_URL="mongodb://db_user:db_password@127.0.0.1:27017/db_name?timeout=3000"
    

YAML
XML
PHP

        1
2
3
4
5
6
        # config/packages/mongodb.yaml
mongo_db_bundle:
    clients:
        default:
            # ...
            connectTimeoutMS: '%env(int:key:timeout:query_string:MONGODB_URL)%'
    

        1
2
3
4
5
6
7
8
9
10
11
        <!-- config/packages/mongodb.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://symfony.com/schema/dic/services
        https://symfony.com/schema/dic/services/services-1.0.xsd">

    <mongodb:config>
        <mongodb:client name="default" connectTimeoutMS="%env(int:key:timeout:query_string:MONGODB_URL)%"/>
    </mongodb:config>
</container>
    

        1
2
3
4
5
6
7
8
9
        // config/packages/mongodb.php
$container->loadFromExtension('mongodb', [
    'clients' => [
        'default' => [
            // ...
            'connectTimeoutMS' => '%env(int:key:timeout:query_string:MONGODB_URL)%',
        ],
    ],
]);
    

env(enum:FooEnum:BAR)

Пробует преобразовать переменную окружения в реальное значение \BackedEnum. Этот процессор берёт полностью квалифицированное имя \BackedEnum в качестве аргумента.

        1
2
3
4
5
6
        # App\Enum\Environment
enum Environment: string
{
    case Development = 'dev';
    case Production = 'prod';
}
    

YAML
XML
PHP

        1
2
3
        # config/services.yaml
parameters:
    typed_env: '%env(enum:App\Enum\Environment:APP_ENV)%'
    

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
        <!-- config/services.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:framework="http://symfony.com/schema/dic/symfony"
    xsi:schemaLocation="http://symfony.com/schema/dic/services
        https://symfony.com/schema/dic/services/services-1.0.xsd
        http://symfony.com/schema/dic/symfony
        https://symfony.com/schema/dic/symfony/symfony-1.0.xsd">

    <parameters>
        <parameter key="typed_env">%env(enum:App\Enum\Environment:APP_ENV)%</parameter>
    </parameters>
</container>
    

        1
2
        // config/services.php
$container->setParameter('typed_env', '%env(enum:App\Enum\Environment:APP_ENV)%');
    

6.2

Процессор переменной окружения env(enum:...) был представлен в Symfony 6.2.

Также возможно объединить любое количество процессоров:

YAML
XML
PHP

        1
2
3
4
5
6
7
8
9
        # config/packages/framework.yaml
parameters:
    env(AUTH_FILE): "%kernel.project_dir%/config/auth.json"
google:
    # 1. получает значение переменной окружения AUTH_FILE
    # 2. заменяет значения любого параметра конфигурации, чтобы получить путь конфигурации
    # 3. получает содержание файла, хранящегося по этому пути
    # 4. JSON-расшифровывает содержание файла и возвращает его
    auth: '%env(json:file:resolve:AUTH_FILE)%'
    

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
        <!-- config/packages/framework.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:framework="http://symfony.com/schema/dic/symfony"
    xsi:schemaLocation="http://symfony.com/schema/dic/services
        https://symfony.com/schema/dic/services/services-1.0.xsd
        http://symfony.com/schema/dic/symfony
        https://symfony.com/schema/dic/symfony/symfony-1.0.xsd">

    <parameters>
        <parameter key="env(AUTH_FILE)">%kernel.project_dir%/config/auth.json</parameter>
    </parameters>

    <!-- 1. получает значение переменной окружения AUTH_FILE -->
    <!-- 2. заменяет значения любого параметра конфигурации, чтобы получить путь конфигурации -->
    <!-- 3. получает содержание файла, хранящегося по этому пути -->
    <!-- 4. JSON-расшифровывает содержание файла и возвращает его -->
    <google auth="%env(json:file:resolve:AUTH_FILE)%"/>
</container>
    

        1
2
3
4
5
6
7
8
9
        // config/packages/framework.php
$container->setParameter('env(AUTH_FILE)', '%kernel.project_dir%/config/auth.json');
// 1. получает значение переменной окружения AUTH_FILE
// 2. заменяет значения любого параметра конфигурации, чтобы получить путь конфигурации
// 3. получает содержание файла, хранящегося по этому пути
// 4. JSON-расшифровывает содержание файла и возвращает его
$container->loadFromExtension('google', [
    'auth' => '%env(json:file:resolve:AUTH_FILE)%',
]);
    

Пользовательские процессоры переменных окружения

Также возможно добавлять ваши собственные процессоры для переменных окружения. Для начала, создайте класс, реализующий EnvVarProcessorInterface:

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
        use Symfony\Component\DependencyInjection\EnvVarProcessorInterface;

class LowercasingEnvVarProcessor implements EnvVarProcessorInterface
{
    public function getEnv(string $prefix, string $name, \Closure $getEnv)
    {
        $env = $getEnv($name);

        return strtolower($env);
    }

    public static function getProvidedTypes()
    {
        return [
            'lowercase' => 'string',
        ];
    }
}
    

Чтобы включить новый процессор в приложении, зарегистрируйте его как сервис и добавьте тег container.env_var_processor. Если вы используете конфигурацию services.yaml по умолчанию , это уже сделано за вас, благодаря автоконфигурации .