Introduction to Parameters

Version: 4.1
Edit this page

Warning: You are browsing the documentation for Symfony 4.1, which is no longer maintained.

Read the updated version of this page for Symfony 6.0 (the current stable version).

Introduction to Parameters

You can define parameters in the service container which can then be used directly or as part of service definitions. This can help to separate out values that you will want to change more regularly.

Parameters in Configuration Files

Use the parameters section of a config file to set parameters:

  • YAML
  • XML
  • PHP
1
2
3
# config/services.yaml
parameters:
    mailer.transport: sendmail

You can refer to parameters elsewhere in any config file by surrounding them with percent (%) signs, e.g. %mailer.transport%. One use for this is to inject the values into your services. This allows you to configure different versions of services between applications or multiple services based on the same class but configured differently within a single application. You could inject the choice of mail transport into the Mailer class directly. But declaring it as a parameter makes it easier to change rather than being tied up and hidden with the service definition:

  • YAML
  • XML
  • PHP
1
2
3
4
5
6
7
# config/services.yaml
parameters:
    mailer.transport: sendmail

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

Caution

The values between parameter tags in XML configuration files are not trimmed.

This means that the following configuration sample will have the value \n sendmail\n:

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

In some cases (for constants or class names), this could throw errors. In order to prevent this, you must always inline your parameters as follow:

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

Note

If you use a string that starts with @ or has % anywhere in it, you need to escape it by adding another @ or %:

  • YAML
  • XML
  • PHP
1
2
3
4
5
6
7
# config/services.yaml
parameters:
    # This will be parsed as string '@securepass'
    mailer_password: '@@securepass'

    # Parsed as http://symfony.com/?foo=%s&amp;bar=%d
    url_pattern: 'http://symfony.com/?foo=%%s&amp;bar=%%d'

Getting and Setting Container Parameters in PHP

Working with container parameters is straightforward using the container's accessor methods for parameters:

1
2
3
4
5
6
7
8
// checks if a parameter is defined (parameter names are case-sensitive)
$container->hasParameter('mailer.transport');

// gets value of a parameter
$container->getParameter('mailer.transport');

// adds a new parameter
$container->setParameter('mailer.transport', 'sendmail');

Caution

The used . notation is a Symfony convention to make parameters easier to read. Parameters are flat key-value elements, they can't be organized into a nested array

Note

You can only set a parameter before the container is compiled: not at run-time. To learn more about compiling the container see Compiling the Container.

Array Parameters

Parameters do not need to be flat strings, they can also contain array values. For the XML format, you need to use the type="collection" attribute for all parameters that are arrays.

  • YAML
  • XML
  • PHP
1
2
3
4
5
6
7
8
9
10
11
# config/services.yaml
parameters:
    my_mailer.gateways: [mail1, mail2, mail3]

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

Constants as Parameters

Setting PHP constants as parameters is also supported:

  • YAML
  • XML
  • PHP
1
2
3
4
# config/services.yaml
parameters:
    global.constant.value: !php/const GLOBAL_CONSTANT
    my_class.constant.value: !php/const My_Class::CONSTANT_NAME

Binary Values as Parameters

4.1

The support for binary values in container parameters was introduced in Symfony 4.1

If the value of a container parameter is a binary value, set it as a base64 encoded value in YAML and XML configs and use the escape sequences in PHP:

  • YAML
  • XML
  • PHP
1
2
3
# config/services.yaml
parameters:
    some_parameter: !!binary VGhpcyBpcyBhIEJlbGwgY2hhciAH

PHP Keywords in XML

By default, true, false and null in XML are converted to the PHP keywords (respectively true, false and 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
-->

To disable this behavior, use the string type:

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

This is not available for YAML and PHP, because they already have built-in support for the PHP keywords.

This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.