Вступ у параметри

Параметри у файлах конфігурації

Використайте розділ parameters файлу конфігурації, щоб встановити параметри:

        1
2
        parameters:
    mailer.transport: sendmail
    

        1
2
3
4
5
6
7
8
9
10
        <?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
        http://symfony.com/schema/dic/services/services-1.0.xsd">

    <parameters>
        <parameter key="mailer.transport">sendmail</parameter>
    </parameters>
</container>
    

        1
        $container->setParameter('mailer.transport', 'sendmail');
    

Ви можете посилатися на параметри де завгодно у будь-якому файлі конфігурації, оточивши їх знаками відсотку (%), наприклад, %mailer.transport%. Одним з методів застосування цього є впровадження значень у ваші сервіси. Це дозволяє вам сконфігурувати різні версії сервісів між додатками або декілька сервісів, заснованих на одному класі, але сконфігурованих по-різному в межах одного додатку. Ви можете впровадити вибір поштового транспорту у клас Mailer напряму. Але його оголошення в якості парамета спрощує зміни, замість того, щоб повʼязувати його та ховати у визначенні сервісу:

        1
2
3
4
5
6
        parameters:
    mailer.transport: sendmail

services:
    AppBundle\Service\Mailer:
        arguments: ['%mailer.transport%']
    

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
        <?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
        http://symfony.com/schema/dic/services/services-1.0.xsd">

    <parameters>
        <parameter key="mailer.transport">sendmail</parameter>
    </parameters>

    <services>
        <service id="AppBundle\Service\Mailer">
            <argument>%mailer.transport%</argument>
        </service>
    </services>
</container>
    

        1
2
3
4
5
6
7
        use AppBundle\Service\Mailer;
use Symfony\Component\DependencyInjection\Reference;

$container->setParameter('mailer.transport', 'sendmail');

$container->register(Mailer::class)
    ->addArgument('%mailer.transport%');
    

Caution

Значення між тегами parameter у файлах конфігурації XML не усікаються.

Це означає, що наступний приклад конфігурації матиме значення \n sendmail\n:

        1
2
3
        <parameter key="mailer.transport">
    sendmail
</parameter>
    

У деяких випадках (для констант або імен класу), це може викликати помилки. Щоб уникнути цього, ви маєте завжди вбудовувати ваші параметри наступним чином:

        1
        <parameter key="mailer.transport">sendmail</parameter>
    

Note

Якщо ви використовуєте рядок, що починається з @ або має % в будь-якому місці, вам потрібно екранувати його, додавши ще один @ або %:

        1
2
3
4
5
6
7
        # app/config/parameters.yml
parameters:
    # Це буде інтерпретовано як рядок '@securepass'
    mailer_password: '@@securepass'

    # Интерпретировано, как http://symfony.com/?foo=%s&amp;bar=%d
    url_pattern: 'http://symfony.com/?foo=%%s&amp;bar=%%d'
    

        1
2
3
4
5
6
7
        <parameters>
    <!-- символ @ symbol НЕ треба екранувати в XML -->
    <parameter key="mailer_password">@securepass</parameter>

    <!-- Але % треба екранувати -->
    <parameter key="url_pattern">http://symfony.com/?foo=%%s&amp;bar=%%d</parameter>
</parameters>
    

        1
2
3
4
5
        // символ @ symbol НЕ треба екранувати в XML
$container->setParameter('mailer_password', '@securepass');

// Але % треба екранувати
$container->setParameter('url_pattern', 'http://symfony.com/?foo=%%s&amp;bar=%%d');
    

Отримання та установка параметрів контейнера в PHP

Робота з параметрами контейнера прямолінійна за використання методів доступу контейнера для параметрів:

        1
2
3
4
5
6
7
8
        // перевірте, чи визначено параметр
$container->hasParameter('mailer.transport');

// отримайте значення параметра
$container->getParameter('mailer.transport');

// додайте новий параметр
$container->setParameter('mailer.transport', 'sendmail');
    

Caution

Використана нотація . - це просто угода Symfony , щоб зробити парамети легшими для читання. Параметир є просто лінійними ключовими значеннями елементів, вони не можуть бути організоваі у вкладений масив.

Note

Ви можете встановити параметр лише до того як було скомпільовано контейнер: не під час прогону. Щоб дізнатися більше про компіляцію контейнера, див. Компіляція контейнера.

Параметри масиву

Параметри не мають буди лінійними рядками, вони також можуть містити значення масиву. Для формату XML вам потрібно використати атрибут type="collection" для усіх параметрів, які є масивами.

        1
2
3
4
5
6
7
8
9
10
        parameters:
    my_mailer.gateways: [mail1, mail2, mail3]

    my_multilang.language_fallback:
        en:
            - en
            - fr
        fr:
            - fr
            - en
    

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
        <?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
        http://symfony.com/schema/dic/services/services-1.0.xsd">

    <parameters>
        <parameter key="my_mailer.gateways" type="collection">
            <parameter>mail1</parameter>
            <parameter>mail2</parameter>
            <parameter>mail3</parameter>
        </parameter>

        <parameter key="my_multilang.language_fallback" type="collection">
            <parameter key="en" type="collection">
                <parameter>en</parameter>
                <parameter>fr</parameter>
            </parameter>

            <parameter key="fr" type="collection">
                <parameter>fr</parameter>
                <parameter>en</parameter>
            </parameter>
        </parameter>
    </parameters>
</container>
    

        1
2
3
4
5
        $container->setParameter('my_mailer.gateways', array('mail1', 'mail2', 'mail3'));
$container->setParameter('my_multilang.language_fallback', array(
    'en' => array('en', 'fr'),
    'fr' => array('fr', 'en'),
));
    

Змінні середовища та динамічні значення

Дивіться Як встановлювати зовнішні параметри в сервіс-контейнері.

Константи як параметри

Установка PHP-констант як параметрів також підтримується. Щоб скористатися перевагами цієї функції, звʼяжіть імʼя вашої константи з ключом параметра та визначіть тип як constant.

        1
2
3
        parameters:
    global.constant.value: !php/const:GLOBAL_CONSTANT
    my_class.constant.value: !php/const:My_Class::CONSTANT_NAME
    

        1
2
3
4
5
6
7
8
9
10
11
        <?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
        http://symfony.com/schema/dic/services/services-1.0.xsd">

    <parameters>
        <parameter key="global.constant.value" type="constant">GLOBAL_CONSTANT</parameter>
        <parameter key="my_class.constant.value" type="constant">My_Class::CONSTANT_NAME</parameter>
    </parameters>
</container>
    

        1
2
        $container->setParameter('global.constant.value', GLOBAL_CONSTANT);
$container->setParameter('my_class.constant.value', My_Class::CONSTANT_NAME);
    

Ключові слова PHP в XML

За замовчуванням, true, false і null в XML конвертуються у ключові слова PHP (true, false і null, відповідно):

        1
2
3
4
5
6
7
        <parameters>
    <parameter key="mailer.send_all_in_once">false</parameter>
</parameters>

<!-- after parsing
$container->getParameter('mailer.send_all_in_once'); // returns false
-->
    

Щоб відключити цю поведінку, використайте тип string:

        1
2
3
4
5
6
7
        <parameters>
    <parameter key="mailer.some_parameter" type="string">true</parameter>
</parameters>

<!-- after parsing
$container->getParameter('mailer.some_parameter'); // returns "true"
-->
    

Note

Це недоступно для YAML або PHP, так як вони вже мають вбудовану підтримку ключових слів PHP.