feature #39806 [DependencyInjection] Add a remove() method to the PHP configurator (dunglas)

nicolas-grekas · nicolas-grekas · commit 49889c961adf · 2021-01-19T12:08:15.000+01:00
This PR was merged into the 5.3-dev branch. Discussion ---------- [DependencyInjection] Add a remove() method to the PHP configurator | Q | A | ------------- | --- | Branch? | 5.x | Bug fix? | no | New feature? | no  | Deprecations? | no  | License | MIT | Doc PR | todo This especially useful in the `configureContainer()` method of the kernel. It allows to not use a compiler pass to remove some services (for instance, in test mode). Commits ------- dcf75fa [DependencyInjection] Add a remove() method to the PHP configurator
diff --git a/src/Symfony/Component/DependencyInjection/CHANGELOG.md b/src/Symfony/Component/DependencyInjection/CHANGELOG.md
@@ -1,6 +1,11 @@
 CHANGELOG
 =========
 
+5.3
+---
+
+ * Add `ServicesConfigurator::remove()` in the PHP-DSL
+
 5.2.0
 -----
 
diff --git a/src/Symfony/Component/DependencyInjection/Loader/Configurator/AbstractServiceConfigurator.php b/src/Symfony/Component/DependencyInjection/Loader/Configurator/AbstractServiceConfigurator.php
@@ -81,6 +81,16 @@ final public function get(string $id): ServiceConfigurator
         return $this->parent->get($id);
     }
 
+    /**
+     * Removes an already defined service definition or alias.
+     */
+    final public function remove(string $id): ServicesConfigurator
+    {
+        $this->__destruct();
+
+        return $this->parent->remove($id);
+    }
+
     /**
      * Registers a stack of decorator services.
      *
diff --git a/src/Symfony/Component/DependencyInjection/Loader/Configurator/ServiceConfigurator.php b/src/Symfony/Component/DependencyInjection/Loader/Configurator/ServiceConfigurator.php
@@ -45,6 +45,7 @@ class ServiceConfigurator extends AbstractServiceConfigurator
     private $instanceof;
     private $allowParent;
     private $path;
+    private $destructed = false;
 
     public function __construct(ContainerBuilder $container, array $instanceof, bool $allowParent, ServicesConfigurator $parent, Definition $definition, $id, array $defaultTags, string $path = null)
     {
@@ -58,6 +59,11 @@ public function __construct(ContainerBuilder $container, array $instanceof, bool
 
     public function __destruct()
     {
+        if ($this->destructed) {
+            return;
+        }
+        $this->destructed = true;
+
         parent::__destruct();
 
         $this->container->removeBindings($this->id);
diff --git a/src/Symfony/Component/DependencyInjection/Loader/Configurator/ServicesConfigurator.php b/src/Symfony/Component/DependencyInjection/Loader/Configurator/ServicesConfigurator.php
@@ -96,6 +96,17 @@ final public function set(?string $id, string $class = null): ServiceConfigurato
         return null !== $class ? $configurator->class($class) : $configurator;
     }
 
+    /**
+     * Removes an already defined service definition or alias.
+     */
+    final public function remove(string $id): self
+    {
+        $this->container->removeDefinition($id);
+        $this->container->removeAlias($id);
+
+        return $this;
+    }
+
     /**
      * Creates an alias.
      */
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Fixtures/config/remove.expected.yml b/src/Symfony/Component/DependencyInjection/Tests/Fixtures/config/remove.expected.yml
@@ -0,0 +1,9 @@
+
+services:
+    service_container:
+        class: Symfony\Component\DependencyInjection\ContainerInterface
+        public: true
+        synthetic: true
+    baz:
+        class: Symfony\Component\DependencyInjection\Loader\Configurator\BazService
+        public: true
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Fixtures/config/remove.php b/src/Symfony/Component/DependencyInjection/Tests/Fixtures/config/remove.php
@@ -0,0 +1,17 @@
+<?php
+
+namespace Symfony\Component\DependencyInjection\Loader\Configurator;
+
+return function (ContainerConfigurator $c) {
+    $services = $c->services()->defaults()->public();
+
+    $services
+        ->set('foo', FooService::class)
+        ->remove('foo')
+
+        ->set('baz', BazService::class)
+        ->alias('baz-alias', 'baz')
+        ->remove('baz-alias')
+
+        ->remove('bat'); // noop
+};
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Loader/PhpFileLoaderTest.php b/src/Symfony/Component/DependencyInjection/Tests/Loader/PhpFileLoaderTest.php
@@ -80,6 +80,7 @@ public function provideConfig()
         yield ['php7'];
         yield ['anonymous'];
         yield ['lazy_fqcn'];
+        yield ['remove'];
     }
 
     public function testAutoConfigureAndChildDefinition()

Original file line number	Diff line number	Diff line change
`@@ -80,6 +80,7 @@ public function provideConfig()`
`80`	`80`	`yield ['php7'];`
`81`	`81`	`yield ['anonymous'];`
`82`	`82`	`yield ['lazy_fqcn'];`
	`83`	`+ yield ['remove'];`
`83`	`84`	`}`
`84`	`85`
`85`	`86`	`public function testAutoConfigureAndChildDefinition()`