.. index:: single: DependencyInjection; 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.
Working with container parameters is straightforward using the container's accessor methods for parameters. You can check if a parameter has been defined in the container with:
$container->hasParameter('mailer.transport');
You can retrieve a parameter set in the container with:
$container->getParameter('mailer.transport');
and set a parameter in the container with:
$container->setParameter('mailer.transport', 'sendmail');
Caution!
The used . notation is just a
:ref:`Symfony convention <service-naming-conventions>` to make parameters
easier to read. Parameters are just 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. To learn more about compiling the container see :doc:`/components/dependency_injection/compilation`.
You can also use the parameters section of a config file to set parameters:
.. configuration-block::
.. code-block:: yaml
parameters:
mailer.transport: sendmail
.. code-block:: 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 http://symfony.com/schema/dic/services/services-1.0.xsd">
<parameters>
<parameter key="mailer.transport">sendmail</parameter>
</parameters>
</container>
.. code-block:: php
$container->setParameter('mailer.transport', 'sendmail');
As well as retrieving the parameter values directly from the container you
can use them in the config files. You can refer to parameters elsewhere
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:
.. configuration-block::
.. code-block:: yaml
parameters:
mailer.transport: sendmail
services:
mailer:
class: Mailer
arguments: ['%mailer.transport%']
.. code-block:: 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 http://symfony.com/schema/dic/services/services-1.0.xsd">
<parameters>
<parameter key="mailer.transport">sendmail</parameter>
</parameters>
<services>
<service id="mailer" class="Mailer">
<argument>%mailer.transport%</argument>
</service>
</services>
</container>
.. code-block:: php
use Symfony\Component\DependencyInjection\Reference;
$container->setParameter('mailer.transport', 'sendmail');
$container
->register('mailer', 'Mailer')
->addArgument('%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:
<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:
<parameter key="mailer.transport">sendmail</parameter>If you were using this elsewhere as well, then you would only need to change the parameter value in one place if needed.
Note
The percent sign inside a parameter or argument, as part of the string, must be escaped with another percent sign:
.. configuration-block::
.. code-block:: yaml
arguments: ['http://symfony.com/?foo=%%s&bar=%%d']
.. code-block:: xml
<argument>http://symfony.com/?foo=%%s&bar=%%d</argument>
.. code-block:: php
->addArgument('http://symfony.com/?foo=%%s&bar=%%d');
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.
.. configuration-block::
.. code-block:: yaml
parameters:
my_mailer.gateways:
- mail1
- mail2
- mail3
my_multilang.language_fallback:
en:
- en
- fr
fr:
- fr
- en
.. code-block:: 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 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>
.. code-block:: php
$container->setParameter('my_mailer.gateways', array('mail1', 'mail2', 'mail3'));
$container->setParameter('my_multilang.language_fallback', array(
'en' => array('en', 'fr'),
'fr' => array('fr', 'en'),
));
The container also has support for setting PHP constants as parameters.
To take advantage of this feature, map the name of your constant to a parameter
key and define the type as constant.
.. configuration-block::
.. code-block:: 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 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>
.. code-block:: php
$container->setParameter('global.constant.value', GLOBAL_CONSTANT);
$container->setParameter('my_class.constant.value', My_Class::CONSTANT_NAME);
Note
This does not work for YAML configurations. If you're using YAML, you can import an XML file to take advantage of this functionality:
imports:
- { resource: parameters.xml }By default, true, false and null in XML are converted to the
PHP keywords (respectively true, false and null):
<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:
<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.