Using Parameters within a Dependency Injection Class
Warning: You are browsing the documentation for Symfony 4.x, which is no longer maintained.
Read the updated version of this page for Symfony 7.1 (the current stable version).
You have seen how to use configuration parameters within
Symfony service containers.
There are special cases such as when you want, for instance, to use the
%kernel.debug%
parameter to make the services in your bundle enter
debug mode. For this case there is more work to do in order
to make the system understand the parameter value. By default,
your parameter %kernel.debug%
will be treated as a string. Consider the
following example:
1 2 3 4 5 6 7 8 9 10 11
// inside Configuration class
$rootNode
->children()
->booleanNode('logging')->defaultValue('%kernel.debug%')->end()
// ...
->end()
;
// inside the Extension class
$config = $this->processConfiguration($configuration, $configs);
var_dump($config['logging']);
Now, examine the results to see this closely:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
my_bundle:
logging: true
# true, as expected
my_bundle:
logging: '%kernel.debug%'
# true/false (depends on 2nd argument of the Kernel class),
# as expected, because %kernel.debug% inside configuration
# gets evaluated before being passed to the extension
my_bundle: ~
# passes the string "%kernel.debug%".
# Which is always considered as true.
# The Configurator does not know anything about
# "%kernel.debug%" being a parameter.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
xmlns:my-bundle="http://example.org/schema/dic/my_bundle"
xsi:schemaLocation="http://symfony.com/schema/dic/services
https://symfony.com/schema/dic/services/services-1.0.xsd
http://example.org/schema/dic/my_bundle
https://example.org/schema/dic/my_bundle/my_bundle-1.0.xsd">
<my-bundle:config logging="true"/>
<!-- true, as expected -->
<my-bundle:config logging="%kernel.debug%"/>
<!-- true/false (depends on 2nd parameter of Kernel),
as expected, because %kernel.debug% inside configuration
gets evaluated before being passed to the extension -->
<my-bundle:config/>
<!-- passes the string "%kernel.debug%".
Which is always considered as true.
The Configurator does not know anything about
"%kernel.debug%" being a parameter. -->
</container>
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
$container->loadFromExtension('my_bundle', [
'logging' => true,
// true, as expected
]
);
$container->loadFromExtension('my_bundle', [
'logging' => "%kernel.debug%",
// true/false (depends on 2nd parameter of Kernel),
// as expected, because %kernel.debug% inside configuration
// gets evaluated before being passed to the extension
]
);
$container->loadFromExtension('my_bundle');
// passes the string "%kernel.debug%".
// Which is always considered as true.
// The Configurator does not know anything about
// "%kernel.debug%" being a parameter.
In order to support this use case, the Configuration
class has to
be injected with this parameter via the extension as follows:
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 27 28 29
namespace App\DependencyInjection;
use Symfony\Component\Config\Definition\Builder\TreeBuilder;
use Symfony\Component\Config\Definition\ConfigurationInterface;
class Configuration implements ConfigurationInterface
{
private $debug;
public function __construct($debug)
{
$this->debug = (bool) $debug;
}
public function getConfigTreeBuilder()
{
$treeBuilder = new TreeBuilder('my_bundle');
$treeBuilder->getRootNode()
->children()
// ...
->booleanNode('logging')->defaultValue($this->debug)->end()
// ...
->end()
;
return $treeBuilder;
}
}
And set it in the constructor of Configuration
via the Extension
class:
1 2 3 4 5 6 7 8 9 10 11 12 13 14
namespace App\DependencyInjection;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\HttpKernel\DependencyInjection\Extension;
class AppExtension extends Extension
{
// ...
public function getConfiguration(array $config, ContainerBuilder $container)
{
return new Configuration($container->getParameter('kernel.debug'));
}
}
Tip
There are some instances of %kernel.debug%
usage within a
Configurator
class for example in TwigBundle. However, this is because
the default parameter value is set by the Extension class.