bug #62558 [DependencyInjection] Don't add empty .container.known_envs in XML loader (GromNaN)

nicolas-grekas · nicolas-grekas · commit 5cf2616b6c20 · 2025-12-01T20:59:37.000+01:00
This PR was merged into the 7.4 branch. Discussion ---------- [DependencyInjection] Don't add empty `.container.known_envs` in XML loader | Q | A | ------------- | --- | Branch? | 7.4 | Bug fix? | yes | New feature? | no | Deprecations? | no | Issues | - | License | MIT The XML loader is the only one that creates the `.container.known_envs` parameter even if there is no `<when env="...">` in the file. The PHP and Yaml loaders read and update this parameter only when they find a `when@<env>` key. https://github.com/symfony/symfony/blob/1aa580f49841d479754c34102e42d334d0ce1a5a/src/Symfony/Component/DependencyInjection/Loader/PhpFileLoader.php#L81-L85 https://github.com/symfony/symfony/blob/1aa580f49841d479754c34102e42d334d0ce1a5a/src/Symfony/Component/DependencyInjection/Loader/YamlFileLoader.php#L958-L962 This is causing an issue in [symfony-config-xml-to-php](https://github.com/GromNaN/symfony-config-xml-to-php) when comparing the result of loading equivalent PHP and XML config files. This key is added by the XML loader, not the PHP loader. Commits ------- c3fa63b [DependencyInjection] Don't add the .container.known_envs parameter when empty
diff --git a/src/Symfony/Component/DependencyInjection/Loader/XmlFileLoader.php b/src/Symfony/Component/DependencyInjection/Loader/XmlFileLoader.php
@@ -63,11 +63,10 @@ public function load(mixed $resource, ?string $type = null): mixed
                 $this->loadXml($xml, $path, $root);
             }
         }
-        $knownEnvs = $this->container->hasParameter('.container.known_envs') ? array_flip($this->container->getParameter('.container.known_envs')) : [];
         foreach ($xpath->query('//container:when') ?: [] as $root) {
-            $knownEnvs[$root->getAttribute('env')] = true;
+            $knownEnvs = $this->container->hasParameter('.container.known_envs') ? array_flip($this->container->getParameter('.container.known_envs')) : [];
+            $this->container->setParameter('.container.known_envs', array_keys($knownEnvs + [$root->getAttribute('env') => true]));
         }
-        $this->container->setParameter('.container.known_envs', array_keys($knownEnvs));
 
         return null;
     }
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Loader/XmlFileLoaderTest.php b/src/Symfony/Component/DependencyInjection/Tests/Loader/XmlFileLoaderTest.php
@@ -154,7 +154,6 @@ public function testLoadParameters()
             ],
             'mixedcase' => ['MixedCaseKey' => 'value'],
             'constant' => \PHP_EOL,
-            '.container.known_envs' => [],
         ];
 
         $this->assertEquals($expected, $actual, '->load() converts XML values to PHP ones');
@@ -191,7 +190,6 @@ public function testLoadImports()
             ],
             'mixedcase' => ['MixedCaseKey' => 'value'],
             'constant' => \PHP_EOL,
-            '.container.known_envs' => [],
             'bar' => '%foo%',
             'imported_from_ini' => true,
             'imported_from_yaml' => true,

Original file line number	Diff line number	Diff line change
`@@ -63,11 +63,10 @@ public function load(mixed $resource, ?string $type = null): mixed`
`63`	`63`	`$this->loadXml($xml, $path, $root);`
`64`	`64`	`}`
`65`	`65`	`}`
`66`		`- $knownEnvs = $this->container->hasParameter('.container.known_envs') ? array_flip($this->container->getParameter('.container.known_envs')) : [];`
`67`	`66`	`foreach ($xpath->query('//container:when') ?: [] as $root) {`
`68`		`- $knownEnvs[$root->getAttribute('env')] = true;`
	`67`	`+ $knownEnvs = $this->container->hasParameter('.container.known_envs') ? array_flip($this->container->getParameter('.container.known_envs')) : [];`
	`68`	`+ $this->container->setParameter('.container.known_envs', array_keys($knownEnvs + [$root->getAttribute('env') => true]));`
`69`	`69`	`}`
`70`		`- $this->container->setParameter('.container.known_envs', array_keys($knownEnvs));`
`71`	`70`
`72`	`71`	`return null;`
`73`	`72`	`}`