[DependencyInjection] Add custom container configurators

unkind · unkind · commit 398cfdd1cafb · 2018-01-02T00:36:24.000+03:00
diff --git a/src/Symfony/Component/DependencyInjection/ContainerBuilder.php b/src/Symfony/Component/DependencyInjection/ContainerBuilder.php
@@ -26,6 +26,7 @@
 use Symfony\Component\DependencyInjection\Exception\ServiceCircularReferenceException;
 use Symfony\Component\DependencyInjection\Exception\ServiceNotFoundException;
 use Symfony\Component\DependencyInjection\Extension\ExtensionInterface;
+use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
 use Symfony\Component\DependencyInjection\ParameterBag\EnvPlaceholderParameterBag;
 use Symfony\Component\DependencyInjection\ParameterBag\ParameterBag;
 use Symfony\Component\Config\Resource\ClassExistenceResource;
@@ -123,6 +124,11 @@ class ContainerBuilder extends Container implements TaggedContainerInterface
     private $removedIds = array();
     private $alreadyLoading = array();
 
+    /**
+     * @var callable[] configurator class name => callable
+     */
+    private $containerConfiguratorFactories;
+
     public function __construct(ParameterBagInterface $parameterBag = null)
     {
         parent::__construct($parameterBag);
@@ -222,6 +228,36 @@ public function hasExtension($name)
         return isset($this->extensions[$name]) || isset($this->extensionsByNs[$name]);
     }
 
+    /**
+     * @param callable $factory function (ContainerConfigurator $c) { .... }
+     */
+    public function registerContainerConfiguratorFactory(string $configuratorClassName, callable $factory)
+    {
+        if (!class_exists($configuratorClassName)) {
+            throw new \LogicException(sprintf('Container configurator class %s does not exist.', $configuratorClassName));
+        }
+
+        if (isset($this->containerConfiguratorFactories[$configuratorClassName])) {
+            throw new \LogicException(sprintf('Container configurator factory for %s was already registered.', $configuratorClassName));
+        }
+
+        $this->containerConfiguratorFactories[$configuratorClassName] = $factory;
+    }
+
+    /**
+     * @param string $configuratorClassName
+     *
+     * @return mixed
+     */
+    public function getContainerConfigurator(string $configuratorClassName, ContainerConfigurator $configurator)
+    {
+        if (!isset($this->containerConfiguratorFactories[$configuratorClassName])) {
+            throw new \LogicException(sprintf('Container configurator factory for %s does not exist.', $configuratorClassName));
+        }
+
+        return call_user_func($this->containerConfiguratorFactories[$configuratorClassName], $configurator);
+    }
+
     /**
      * Returns an array of resources loaded to build this configuration.
      *
diff --git a/src/Symfony/Component/DependencyInjection/Loader/PhpFileLoader.php b/src/Symfony/Component/DependencyInjection/Loader/PhpFileLoader.php
@@ -44,7 +44,20 @@ public function load($resource, $type = null)
         $callback = $load($path);
 
         if ($callback instanceof \Closure) {
-            $callback(new ContainerConfigurator($this->container, $this, $this->instanceof, $path, $resource), $this->container, $this);
+            $method = new \ReflectionFunction($callback);
+
+            if (0 === $method->getNumberOfParameters()) {
+                throw new \LogicException('Closure in %s:%d must have at least 1 argument.', $path, $method->getStartLine());
+            }
+
+            $configurator = new ContainerConfigurator($this->container, $this, $this->instanceof, $path, $resource);
+            $configuratorClass = $method->getParameters()[0]->getClass()->name;
+
+            if (ContainerConfigurator::class !== $configuratorClass) {
+                $configurator = $this->container->getContainerConfigurator($configuratorClass, $configurator);
+            }
+
+            $callback($configurator, $this->container, $this);
         }
     }
 
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Fixtures/FooContainerConfigurator.php b/src/Symfony/Component/DependencyInjection/Tests/Fixtures/FooContainerConfigurator.php
@@ -0,0 +1,20 @@
+<?php
+
+namespace Symfony\Component\DependencyInjection\Tests\Fixtures;
+
+use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
+
+final class FooContainerConfigurator
+{
+    private $configurator;
+
+    public function __construct(ContainerConfigurator $configurator)
+    {
+        $this->configurator = $configurator;
+    }
+
+    public function foo()
+    {
+        $this->configurator->parameters()->set('foo', 'bar');
+    }
+}
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Fixtures/config/custom_configurator.php b/src/Symfony/Component/DependencyInjection/Tests/Fixtures/config/custom_configurator.php
@@ -0,0 +1,7 @@
+<?php
+
+use Symfony\Component\DependencyInjection\Tests\Fixtures\FooContainerConfigurator;
+
+return function (FooContainerConfigurator $c) {
+    $c->foo();
+};
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Loader/PhpFileLoaderTest.php b/src/Symfony/Component/DependencyInjection/Tests/Loader/PhpFileLoaderTest.php
@@ -15,8 +15,10 @@
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Dumper\PhpDumper;
 use Symfony\Component\DependencyInjection\Dumper\YamlDumper;
+use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
 use Symfony\Component\DependencyInjection\Loader\PhpFileLoader;
 use Symfony\Component\Config\FileLocator;
+use Symfony\Component\DependencyInjection\Tests\Fixtures\FooContainerConfigurator;
 
 class PhpFileLoaderTest extends TestCase
 {
@@ -74,6 +76,23 @@ public function provideConfig()
         yield array('php7');
     }
 
+    public function testCustomContainerConfigurator()
+    {
+        $container = new ContainerBuilder();
+        $container->registerContainerConfiguratorFactory(
+            FooContainerConfigurator::class,
+            function (ContainerConfigurator $c) {
+                return new FooContainerConfigurator($c);
+            }
+        );
+
+        $fixtures = realpath(__DIR__.'/../Fixtures');
+        $loader = new PhpFileLoader($container, new FileLocator());
+        $loader->load($fixtures.'/config/custom_configurator.php');
+
+        $this->assertEquals('bar', $container->getParameter('foo'));
+    }
+
     /**
      * @expectedException \Symfony\Component\DependencyInjection\Exception\InvalidArgumentException
      * @expectedExceptionMessage The service "child_service" cannot have a "parent" and also have "autoconfigure". Try disabling autoconfiguration for the service.
