bug #62088 [DependencyInjection][Routing] Fix nested config imports when returning PHP arrays (nicolas-grekas)

nicolas-grekas · nicolas-grekas · commit 46dafddd9206 · 2025-10-16T18:05:25.000+02:00
This PR was merged into the 7.4 branch. Discussion ---------- [DependencyInjection][Routing] Fix nested config imports when returning PHP arrays | Q | A | ------------- | --- | Branch? | 7.4 | Bug fix? | yes | New feature? | no | Deprecations? | no | Issues | - | License | MIT Commits ------- c8d98f9 [DependencyInjection][Routing] Fix nested config imports when returning PHP arrays
diff --git a/src/Symfony/Component/DependencyInjection/Loader/PhpFileLoader.php b/src/Symfony/Component/DependencyInjection/Loader/PhpFileLoader.php
@@ -15,6 +15,7 @@
 use Symfony\Component\Config\Builder\ConfigBuilderGeneratorInterface;
 use Symfony\Component\Config\Builder\ConfigBuilderInterface;
 use Symfony\Component\Config\FileLocatorInterface;
+use Symfony\Component\Config\Loader\LoaderResolver;
 use Symfony\Component\DependencyInjection\Attribute\When;
 use Symfony\Component\DependencyInjection\Attribute\WhenNot;
 use Symfony\Component\DependencyInjection\Container;
@@ -121,8 +122,14 @@ public function load(mixed $resource, ?string $type = null): mixed
                             throw new InvalidArgumentException(\sprintf('Invalid key "%s" returned for the "%s" config builder; none or "services" expected in file "%s".', $key, get_debug_type($config), $path));
                         }
                         $yamlLoader = new YamlFileLoader($this->container, $this->locator, $this->env, $this->prepend);
+                        $yamlLoader->setResolver(new LoaderResolver([$this]));
                         $loadContent = new \ReflectionMethod(YamlFileLoader::class, 'loadContent');
-                        $loadContent->invoke($yamlLoader, ContainerConfigurator::processValue((array) $config), $path);
+                        ++$this->importing;
+                        try {
+                            $loadContent->invoke($yamlLoader, ContainerConfigurator::processValue((array) $config), $path);
+                        } finally {
+                            --$this->importing;
+                        }
                     } elseif ($config instanceof ConfigBuilderInterface) {
                         if (\is_string($key) && $config->getExtensionAlias() !== $key) {
                             throw new InvalidArgumentException(\sprintf('The extension alias "%s" of the "%s" config builder does not match the key "%s" in file "%s".', $config->getExtensionAlias(), get_debug_type($config), $key, $path));
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Fixtures/config/config_builder.php b/src/Symfony/Component/DependencyInjection/Tests/Fixtures/config/config_builder.php
@@ -1,14 +1,14 @@
 <?php
 
-use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
 use Symfony\Component\DependencyInjection\Tests\Fixtures\AcmeConfig;
 
 if ('prod' !== $env) {
     return;
 }
 
-return function (AcmeConfig $config, ContainerConfigurator $c) {
-    $c->import('nested_config_builder.php');
-
-    $config->color('blue');
-};
+return [
+    'imports' => [
+        'nested_config_builder.php',
+    ],
+    new AcmeConfig(['color' => 'blue']),
+];
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Loader/PhpFileLoaderTest.php b/src/Symfony/Component/DependencyInjection/Tests/Loader/PhpFileLoaderTest.php
@@ -68,8 +68,8 @@ public function testPrependExtensionConfigWithLoadMethod()
         $container = new ContainerBuilder();
         $container->registerExtension(new \AcmeExtension());
         $container->prependExtensionConfig('acme', ['foo' => 'bar']);
-        $loader = new PhpFileLoader($container, new FileLocator(\dirname(__DIR__).'/Fixtures'), 'prod', new ConfigBuilderGenerator(sys_get_temp_dir()), true);
-        $loader->load('config/config_builder.php');
+        $loader = new PhpFileLoader($container, new FileLocator(\dirname(__DIR__).'/Fixtures/config'), 'prod', new ConfigBuilderGenerator(sys_get_temp_dir()), true);
+        $loader->load('config_builder.php');
 
         $expected = [
             ['color' => 'red'],
@@ -84,8 +84,8 @@ public function testPrependExtensionConfigWithImportMethod()
         $container = new ContainerBuilder();
         $container->registerExtension(new \AcmeExtension());
         $container->prependExtensionConfig('acme', ['foo' => 'bar']);
-        $loader = new PhpFileLoader($container, new FileLocator(\dirname(__DIR__).'/Fixtures'), 'prod', new ConfigBuilderGenerator(sys_get_temp_dir()), true);
-        $loader->import('config/config_builder.php');
+        $loader = new PhpFileLoader($container, new FileLocator(\dirname(__DIR__).'/Fixtures/config'), 'prod', new ConfigBuilderGenerator(sys_get_temp_dir()), true);
+        $loader->import('config_builder.php');
 
         $expected = [
             ['color' => 'red'],
diff --git a/src/Symfony/Component/Routing/Loader/PhpFileLoader.php b/src/Symfony/Component/Routing/Loader/PhpFileLoader.php
@@ -12,6 +12,7 @@
 namespace Symfony\Component\Routing\Loader;
 
 use Symfony\Component\Config\Loader\FileLoader;
+use Symfony\Component\Config\Loader\LoaderResolver;
 use Symfony\Component\Config\Resource\FileResource;
 use Symfony\Component\Routing\Exception\InvalidArgumentException;
 use Symfony\Component\Routing\Loader\Configurator\AliasConfigurator;
@@ -114,6 +115,7 @@ private function loadRoutes(RouteCollection $collection, mixed $routes, string $
         }
 
         $loader = new YamlFileLoader($this->locator, $this->env);
+        $loader->setResolver(new LoaderResolver([$this]));
 
         \Closure::bind(function () use ($collection, $routes, $path, $file) {
             foreach ($routes as $name => $config) {
@@ -148,7 +150,7 @@ private function loadRoutes(RouteCollection $collection, mixed $routes, string $
                     }
                 }
             }
-        }, $loader, $loader::class)();
+        }, $loader, YamlFileLoader::class)();
     }
 }
 
diff --git a/src/Symfony/Component/Routing/Tests/Fixtures/importer-php-returns-array-with-import.yml b/src/Symfony/Component/Routing/Tests/Fixtures/importer-php-returns-array-with-import.yml
@@ -0,0 +1,3 @@
+routes_from_php:
+    resource: validpattern.php
+    type: php
diff --git a/src/Symfony/Component/Routing/Tests/Fixtures/importer-php-returns-array.php b/src/Symfony/Component/Routing/Tests/Fixtures/importer-php-returns-array.php
@@ -0,0 +1,10 @@
+<?php
+
+return [
+    'blog_show' => [
+        'resource' => 'importer-php-returns-array-with-import.yml',
+    ],
+    'direct' => [
+        'path' => '/direct',
+    ],
+];
diff --git a/src/Symfony/Component/Routing/Tests/Loader/PhpFileLoaderTest.php b/src/Symfony/Component/Routing/Tests/Loader/PhpFileLoaderTest.php
@@ -392,6 +392,17 @@ public function testWhenEnvWithArray()
         $this->assertSame('/x', $routes->get('x')->getPath());
     }
 
+    public function testYamlImportsAreResolvedWhenProcessingPhpReturnedArrays()
+    {
+        $locator = new FileLocator([__DIR__.'/../Fixtures']);
+        $loader = new PhpFileLoader($locator);
+
+        $routes = $loader->load('importer-php-returns-array.php');
+
+        $this->assertSame('/blog/{slug}', $routes->get('blog_show')->getPath());
+        $this->assertSame('/direct', $routes->get('direct')->getPath());
+    }
+
     #[DataProvider('providePsr4ConfigFiles')]
     public function testImportAttributesWithPsr4Prefix(string $configFile)
     {
