minor #40808 [DependencyInjection][Routing] Access environment in PHP config (Nyholm)

nicolas-grekas · nicolas-grekas · commit 48ae511da84f · 2021-04-14T17:36:30.000+02:00
This PR was merged into the 5.3-dev branch. Discussion ---------- [DependencyInjection][Routing] Access environment in PHP config | Q | A | ------------- | --- | Branch? | 5.x | Bug fix? | no | New feature? | yes | Deprecations? | | Tickets | | License | MIT | Doc PR | This will allow me to write config like: ```php use Symfony\Config\FrameworkConfig; use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator; return static function (FrameworkConfig $framework, ContainerConfigurator $container) { if ('test' === $container->env()) { $framework->test(true); $framework->session()->storageFactoryId('session.storage.mock_file'); } }; ``` This PR will also revert parts of #40214. It is much simpler to maintain and write PHP config without `->when()`. Instead we add `ContainerConfigurator::env(): ?string` and `RoutingConfigurator::env(): ?string`. ```php use App\Controller\BlogController; use Symfony\Component\Routing\Loader\Configurator\RoutingConfigurator; return function (RoutingConfigurator $routes) { if ($routes->env() === 'dev') { $routes->add('debug-stats', '/blog-debyg') ->controller([BlogController::class, 'debug']) ; } $routes->add('blog_list', '/blog') ->controller([BlogController::class, 'list']) ; }; ``` Commits ------- 11dfaa4 [DependencyInjection][Routing] Access environment in PHP config
diff --git a/src/Symfony/Component/DependencyInjection/CHANGELOG.md b/src/Symfony/Component/DependencyInjection/CHANGELOG.md
@@ -10,11 +10,12 @@ CHANGELOG
  * Add `#[AsTaggedItem]` attribute for defining the index and priority of classes found in tagged iterators/locators
  * Add autoconfigurable attributes
  * Add support for autowiring tagged iterators and locators via attributes on PHP 8
- * Add support for per-env configuration in loaders
+ * Add support for per-env configuration in XML and Yaml loaders
  * Add `ContainerBuilder::willBeAvailable()` to help with conditional configuration
  * Add support an integer return value for default_index_method
  * Add `env()` and `EnvConfigurator` in the PHP-DSL
  * Add support for `ConfigBuilder` in the `PhpFileLoader`
+ * Add `ContainerConfigurator::env()` to get the current environment
 
 5.2.0
 -----
diff --git a/src/Symfony/Component/DependencyInjection/Loader/Configurator/ContainerConfigurator.php b/src/Symfony/Component/DependencyInjection/Loader/Configurator/ContainerConfigurator.php
@@ -74,20 +74,11 @@ final public function services(): ServicesConfigurator
     }
 
     /**
-     * @return static
+     * Get the current environment to be able to write conditional configuration.
      */
-    final public function when(string $env): self
+    final public function env(): ?string
     {
-        if ($env === $this->env) {
-            return clone $this;
-        }
-
-        $instanceof = $this->instanceof;
-        $clone = clone $this;
-        $clone->container = new ContainerBuilder(clone $this->container->getParameterBag());
-        $clone->instanceof = &$instanceof;
-
-        return $clone;
+        return $this->env;
     }
 
     /**
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Fixtures/config/when-env.php b/src/Symfony/Component/DependencyInjection/Tests/Fixtures/config/when-env.php
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Loader/PhpFileLoaderTest.php b/src/Symfony/Component/DependencyInjection/Tests/Loader/PhpFileLoaderTest.php
@@ -144,15 +144,6 @@ public function testStack()
         $this->assertEquals($expected, $container->get('stack_d'));
     }
 
-    public function testWhenEnv()
-    {
-        $container = new ContainerBuilder();
-        $loader = new PhpFileLoader($container, new FileLocator(realpath(__DIR__.'/../Fixtures').'/config'), 'some-env');
-        $loader->load('when-env.php');
-
-        $this->assertSame(['foo' => 234, 'bar' => 345], $container->getParameterBag()->all());
-    }
-
     public function testEnvConfigurator()
     {
         $container = new ContainerBuilder();
diff --git a/src/Symfony/Component/Routing/CHANGELOG.md b/src/Symfony/Component/Routing/CHANGELOG.md
@@ -5,8 +5,9 @@ CHANGELOG
 ---
 
  * Already encoded slashes are not decoded nor double-encoded anymore when generating URLs
- * Add support for per-env configuration in loaders
+ * Add support for per-env configuration in XML and Yaml loaders
  * Deprecate creating instances of the `Route` annotation class by passing an array of parameters
+ * Add `RoutingConfigurator::env()` to get the current environment
 
 5.2.0
 -----
diff --git a/src/Symfony/Component/Routing/Loader/Configurator/RoutingConfigurator.php b/src/Symfony/Component/Routing/Loader/Configurator/RoutingConfigurator.php
@@ -61,18 +61,11 @@ final public function collection(string $name = ''): CollectionConfigurator
     }
 
     /**
-     * @return static
+     * Get the current environment to be able to write conditional configuration.
      */
-    final public function when(string $env): self
+    final public function env(): ?string
     {
-        if ($env === $this->env) {
-            return clone $this;
-        }
-
-        $clone = clone $this;
-        $clone->collection = new RouteCollection();
-
-        return $clone;
+        return $this->env;
     }
 
     /**
diff --git a/src/Symfony/Component/Routing/Tests/Fixtures/when-env.php b/src/Symfony/Component/Routing/Tests/Fixtures/when-env.php
diff --git a/src/Symfony/Component/Routing/Tests/Loader/PhpFileLoaderTest.php b/src/Symfony/Component/Routing/Tests/Loader/PhpFileLoaderTest.php
@@ -284,14 +284,4 @@ public function testImportingRoutesWithSingleHostInImporter()
 
         $this->assertEquals($expectedRoutes('php'), $routes);
     }
-
-    public function testWhenEnv()
-    {
-        $loader = new PhpFileLoader(new FileLocator([__DIR__.'/../Fixtures']), 'some-env');
-        $routes = $loader->load('when-env.php');
-
-        $this->assertSame(['b', 'a'], array_keys($routes->all()));
-        $this->assertSame('/b', $routes->get('b')->getPath());
-        $this->assertSame('/a1', $routes->get('a')->getPath());
-    }
 }

Original file line number	Diff line number	Diff line change
`@@ -284,14 +284,4 @@ public function testImportingRoutesWithSingleHostInImporter()`
`284`	`284`
`285`	`285`	`$this->assertEquals($expectedRoutes('php'), $routes);`
`286`	`286`	`}`
`287`		`-`
`288`		`- public function testWhenEnv()`
`289`		`- {`
`290`		`- $loader = new PhpFileLoader(new FileLocator([__DIR__.'/../Fixtures']), 'some-env');`
`291`		`- $routes = $loader->load('when-env.php');`
`292`		`-`
`293`		`- $this->assertSame(['b', 'a'], array_keys($routes->all()));`
`294`		`- $this->assertSame('/b', $routes->get('b')->getPath());`
`295`		`- $this->assertSame('/a1', $routes->get('a')->getPath());`
`296`		`- }`
`297`	`287`	`}`