Using Parameters within a Dependency Injection Class

Using Parameters within a Dependency Injection Class

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. // inside Configuration class
  2. $rootNode
  3.     ->children()
  4.         ->booleanNode('logging')->defaultValue('%kernel.debug%')->end()
  5.         // ...
  6.     ->end()
  7. ;
  9. // inside the Extension class
  10. $config = $this->processConfiguration($configuration, $configs);
  11. var_dump($config['logging']);

Now, examine the results to see this closely:

  • YAML

    1. my_bundle:
    2.     logging: true
    3.     # true, as expected
    5. my_bundle:
    6.     logging: '%kernel.debug%'
    7.     # true/false (depends on 2nd argument of the Kernel class),
    8.     # as expected, because %kernel.debug% inside configuration
    9.     # gets evaluated before being passed to the extension
    11. my_bundle: ~
    12. # passes the string "%kernel.debug%".
    13. # Which is always considered as true.
    14. # The Configurator does not know anything about
    15. # "%kernel.debug%" being a parameter.

  • XML

    1. <?xml version="1.0" encoding="UTF-8" ?>
    2. <container xmlns="http://symfony.com/schema/dic/services"
    3.     xmlns:my-bundle="http://example.org/schema/dic/my_bundle"
    4.     xsi:schemaLocation="http://symfony.com/schema/dic/services
    5.         https://symfony.com/schema/dic/services/services-1.0.xsd
    6.         http://example.org/schema/dic/my_bundle
    7.         https://example.org/schema/dic/my_bundle/my_bundle-1.0.xsd">
    9.     <my-bundle:config logging="true"/>
    10.     <!-- true, as expected -->
    12.     <my-bundle:config logging="%kernel.debug%"/>
    13.     <!-- true/false (depends on 2nd parameter of Kernel),
    14.          as expected, because %kernel.debug% inside configuration
    15.          gets evaluated before being passed to the extension -->
    17.     <my-bundle:config/>
    18.     <!-- passes the string "%kernel.debug%".
    19.          Which is always considered as true.
    20.          The Configurator does not know anything about
    21.          "%kernel.debug%" being a parameter. -->
    22. </container>

  • PHP

    1. $container->loadFromExtension('my_bundle', [
    2.         'logging' => true,
    3.         // true, as expected
    4.     ]
    5. );
    7. $container->loadFromExtension('my_bundle', [
    8.         'logging' => "%kernel.debug%",
    9.         // true/false (depends on 2nd parameter of Kernel),
    10.         // as expected, because %kernel.debug% inside configuration
    11.         // gets evaluated before being passed to the extension
    12.     ]
    13. );
    15. $container->loadFromExtension('my_bundle');
    16. // passes the string "%kernel.debug%".
    17. // Which is always considered as true.
    18. // The Configurator does not know anything about
    19. // "%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. namespace App\DependencyInjection;
  3. use Symfony\Component\Config\Definition\Builder\TreeBuilder;
  4. use Symfony\Component\Config\Definition\ConfigurationInterface;
  6. class Configuration implements ConfigurationInterface
  7. {
  8.     private $debug;
  10.     public function __construct($debug)
  11.     {
  12.         $this->debug = (bool) $debug;
  13.     }
  15.     public function getConfigTreeBuilder()
  16.     {
  17.         $treeBuilder = new TreeBuilder('my_bundle');
  19.         $treeBuilder->getRootNode()
  20.             ->children()
  21.                 // ...
  22.                 ->booleanNode('logging')->defaultValue($this->debug)->end()
  23.                 // ...
  24.             ->end()
  25.         ;
  27.         return $treeBuilder;
  28.     }
  29. }

And set it in the constructor of Configuration via the Extension class:

  1. namespace App\DependencyInjection;
  3. use Symfony\Component\DependencyInjection\ContainerBuilder;
  4. use Symfony\Component\HttpKernel\DependencyInjection\Extension;
  6. class AppExtension extends Extension
  7. {
  8.     // ...
  10.     public function getConfiguration(array $config, ContainerBuilder $container)
  11.     {
  12.         return new Configuration($container->getParameter('kernel.debug'));
  13.     }
  14. }

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.

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