feature #47906 [DependencyInjection] Allow injecting the current env into php config closures (HypeMC)

nicolas-grekas · nicolas-grekas · commit f0b2029ace9a · 2022-10-19T09:44:50.000+02:00
This PR was merged into the 6.2 branch. Discussion ---------- [DependencyInjection] Allow injecting the current env into php config closures | Q | A | ------------- | --- | Branch? | 6.2 | Bug fix? | no | New feature? | yes | Deprecations? | yes | Tickets | - | License | MIT | Doc PR | - The original idea of this PR was to allow injecting `string $env` into php config closures. Even though this can be done by injecting `ContainerConfigurator` & calling `env()` it seems kind of redundant when you don't need any features except the current env, eg when using the config builder classes: ```diff - return function (AcmeConfig $config, ContainerConfigurator $c) { + return function (AcmeConfig $config, string $env) { - if ('dev' === $c->env()) { + if ('dev' === $env) { // ... } }; ``` Injecting the `$env` variable looks a bit cleaner IMO. However, while working on this PR I discovered #41182 . Even though there's already an `$env` variable presets in the scope of php files which can be used for the same thing, it's not really IDE friendly: ![image](https://user-images.githubusercontent.com/2445045/196558741-8931a3d9-f74f-423e-9494-2d931cbac995.png) Since the original PR mentioned the that the `$env` variable was added for PHP <8 & Symfony 6.2 is >=8.1, it doesn't seem to be needed any more, so it can be deprecated. Commits ------- 4141975 [DependencyInjection] Allow injecting the current env into php config closures
diff --git a/src/Symfony/Component/DependencyInjection/CHANGELOG.md b/src/Symfony/Component/DependencyInjection/CHANGELOG.md
@@ -13,6 +13,7 @@ CHANGELOG
  * Deprecate calling `ContainerAwareTrait::setContainer()` without arguments
  * Deprecate using numeric parameter names
  * Add support for tagged iterators/locators `exclude` option to the xml and yaml loaders/dumpers
+ * Allow injecting `string $env` into php config closures
 
 6.1
 ---
diff --git a/src/Symfony/Component/DependencyInjection/Loader/PhpFileLoader.php b/src/Symfony/Component/DependencyInjection/Loader/PhpFileLoader.php
@@ -123,6 +123,12 @@ private function executeCallback(callable $callback, ContainerConfigurator $cont
                 case self::class:
                     $arguments[] = $this;
                     break;
+                case 'string':
+                    if (null !== $this->env && 'env' === $parameter->getName()) {
+                        $arguments[] = $this->env;
+                        break;
+                    }
+                    // no break
                 default:
                     try {
                         $configBuilder = $this->configBuilder($type);
@@ -163,7 +169,7 @@ private function configBuilder(string $namespace): ConfigBuilderInterface
             return new $namespace();
         }
 
-        // If it does not start with Symfony\Config\ we dont know how to handle this
+        // If it does not start with Symfony\Config\ we don't know how to handle this
         if (!str_starts_with($namespace, 'Symfony\\Config\\')) {
             throw new InvalidArgumentException(sprintf('Could not find or generate class "%s".', $namespace));
         }
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Fixtures/config/env_param.expected.yml b/src/Symfony/Component/DependencyInjection/Tests/Fixtures/config/env_param.expected.yml
@@ -0,0 +1,8 @@
+parameters:
+    acme.configs: [{ color: blue }]
+
+services:
+    service_container:
+        class: Symfony\Component\DependencyInjection\ContainerInterface
+        public: true
+        synthetic: true
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Fixtures/config/env_param.php b/src/Symfony/Component/DependencyInjection/Tests/Fixtures/config/env_param.php
@@ -0,0 +1,11 @@
+<?php
+
+use Symfony\Component\DependencyInjection\Tests\Fixtures\AcmeConfig;
+
+return function (AcmeConfig $config, string $env) {
+    if ('prod' === $env) {
+        $config->color('blue');
+    } else {
+        $config->color('red');
+    }
+};
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Loader/PhpFileLoaderTest.php b/src/Symfony/Component/DependencyInjection/Tests/Loader/PhpFileLoaderTest.php
@@ -99,6 +99,7 @@ public function provideConfig()
         yield ['config_builder'];
         yield ['expression_factory'];
         yield ['closure'];
+        yield ['env_param'];
     }
 
     public function testAutoConfigureAndChildDefinition()

Original file line number	Diff line number	Diff line change
`@@ -99,6 +99,7 @@ public function provideConfig()`
`99`	`99`	`yield ['config_builder'];`
`100`	`100`	`yield ['expression_factory'];`
`101`	`101`	`yield ['closure'];`
	`102`	`+ yield ['env_param'];`
`102`	`103`	`}`
`103`	`104`
`104`	`105`	`public function testAutoConfigureAndChildDefinition()`