[DependencyInjection][Routing] Handle declaring services and routes using PHP arrays that follow the same shape as corresponding yaml files

Author: nicolas-grekas

CHANGELOG.md

@@ -11,6 +11,7 @@ CHANGELOG
  * Deprecate registering a service without a class when its id is a non-existing FQCN
  * Allow multiple `#[AsDecorator]` attributes
  * Handle returning arrays and config-builders from config files
+ * Handle declaring services using PHP arrays that follow the same shape as corresponding yaml files
  * Deprecate using `$this` or its internal scope from PHP config files; use the `$loader` variable instead
 
 7.3

Loader/FileLoader.php

@@ -259,8 +259,25 @@ public function registerAliasesForSinglyImplementedInterfaces(): void
         $this->interfaces = $this->singlyImplemented = $this->aliases = [];
     }
 
-    final protected function loadExtensionConfig(string $namespace, array $config): void
+    final protected function loadExtensionConfig(string $namespace, array $config, string $file = '?'): void
     {
+        if (\in_array($namespace, ['imports', 'services', 'parameters'], true)) {
+            $yamlLoader = new YamlFileLoader($this->container, $this->locator, $this->env, $this->prepend);
+            $loadContent = new \ReflectionMethod(YamlFileLoader::class, 'loadContent');
+            $loadContent->invoke($yamlLoader, [$namespace => $config], $file);
+
+            if ($this->env && isset($config['when@'.$this->env])) {
+                if (!\is_array($config['when@'.$this->env])) {
+                    throw new InvalidArgumentException(\sprintf('The "when@%s" key should contain an array in "%s".', $this->env, $file));
+                }
+
+                $yamlLoader->env = null;
+                $loadContent->invoke($yamlLoader, [$namespace => $config['when@'.$this->env]], $file);
+            }
+
+            return;
+        }
+
         if (!$this->prepend) {
             $this->container->loadFromExtension($namespace, $config);
 

Loader/PhpFileLoader.php

@@ -83,25 +83,25 @@ class_exists(ContainerConfigurator::class);
             }
 
             if (\is_object($result) && \is_callable($result)) {
-                $result = $this->executeCallback($result, new ContainerConfigurator($this->container, $this, $this->instanceof, $path, $resource, $this->env), $path);
+                $result = $this->callConfigurator($result, new ContainerConfigurator($this->container, $this, $this->instanceof, $path, $resource, $this->env), $path);
             }
             if ($result instanceof ConfigBuilderInterface) {
-                $this->loadExtensionConfig($result->getExtensionAlias(), ContainerConfigurator::processValue($result->toArray()));
+                $this->loadExtensionConfig($result->getExtensionAlias(), ContainerConfigurator::processValue($result->toArray()), $path);
             } elseif (is_iterable($result)) {
                 foreach ($result as $key => $config) {
                     if ($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));
                         }
-                        $this->loadExtensionConfig($config->getExtensionAlias(), ContainerConfigurator::processValue($config->toArray()));
+                        $this->loadExtensionConfig($config->getExtensionAlias(), ContainerConfigurator::processValue($config->toArray()), $path);
                     } elseif (!\is_string($key) || !\is_array($config)) {
                         throw new InvalidArgumentException(\sprintf('The configuration returned in file "%s" must yield only string-keyed arrays or ConfigBuilderInterface values.', $path));
                     } else {
-                        $this->loadExtensionConfig($key, ContainerConfigurator::processValue($config));
+                        $this->loadExtensionConfig($key, ContainerConfigurator::processValue($config), $path);
                     }
                 }
             } elseif (null !== $result) {
-                throw new InvalidArgumentException(\sprintf('The return value in config file "%s" is invalid.', $path));
+                throw new InvalidArgumentException(\sprintf('The return value in config file "%s" is invalid: "%s" given.', $path, get_debug_type($result)));
             }
 
             $this->loadExtensionConfigs();
@@ -129,7 +129,7 @@ public function supports(mixed $resource, ?string $type = null): bool
     /**
      * Resolve the parameters to the $callback and execute it.
      */
-    private function executeCallback(callable $callback, ContainerConfigurator $containerConfigurator, string $path): mixed
+    private function callConfigurator(callable $callback, ContainerConfigurator $containerConfigurator, string $path): mixed
     {
         $callback = $callback(...);
         $arguments = [];
@@ -202,7 +202,9 @@ private function executeCallback(callable $callback, ContainerConfigurator $cont
 
         ++$this->importing;
         try {
-            return $callback(...$arguments);
+            $result = $callback(...$arguments);
+
+            return \in_array($result, $configBuilders, true) ? null : $result;
         } catch (\Throwable $e) {
             $configBuilders = [];
             throw $e;

Tests/Fixtures/config/array_config.expected.yml

@@ -0,0 +1,15 @@
+parameters:
+    foo: bar
+
+services:
+    service_container:
+        class: Symfony\Component\DependencyInjection\ContainerInterface
+        public: true
+        synthetic: true
+    Symfony\Component\DependencyInjection\Tests\Fixtures\Bar:
+        class: Symfony\Component\DependencyInjection\Tests\Fixtures\Bar
+        public: true
+    my_service:
+        class: Symfony\Component\DependencyInjection\Tests\Fixtures\Bar
+        public: true
+        arguments: [bar]

Tests/Fixtures/config/array_config.php

@@ -0,0 +1,19 @@
+<?php
+
+use Symfony\Component\DependencyInjection\Tests\Fixtures\Bar;
+
+return [
+    'parameters' => [
+        'foo' => 'bar',
+    ],
+    'services' => [
+        '_defaults' => [
+            'public' => true,
+        ],
+        Bar::class => null,
+        'my_service' => [
+            'class' => Bar::class,
+            'arguments' => ['%foo%'],
+        ],
+    ],
+];

Tests/Loader/PhpFileLoaderTest.php

@@ -144,6 +144,7 @@ public static function provideConfig()
         yield ['closure'];
         yield ['from_callable'];
         yield ['env_param'];
+        yield ['array_config'];
     }
 
     public function testResourceTags()