[DependencyInjection] Add support for Exclude attribute

lyrixx · nicolas-grekas · commit cd64c67b4c0d · 2023-02-23T10:27:01.000+01:00
diff --git a/src/Symfony/Component/DependencyInjection/Attribute/Exclude.php b/src/Symfony/Component/DependencyInjection/Attribute/Exclude.php
@@ -0,0 +1,22 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\DependencyInjection\Attribute;
+
+/**
+ * An attribute to tell the class should not be registered as service.
+ *
+ * @author Grégoire Pineau <lyrixx@lyrixx.info>
+ */
+#[\Attribute(\Attribute::TARGET_CLASS)]
+class Exclude
+{
+}
diff --git a/src/Symfony/Component/DependencyInjection/CHANGELOG.md b/src/Symfony/Component/DependencyInjection/CHANGELOG.md
@@ -14,6 +14,7 @@ CHANGELOG
  * Add `#[AsAlias]` attribute to tell under which alias a service should be registered or to use the implemented interface if no parameter is given
  * Allow to trim XML service parameters value by using `trim="true"` attribute
  * Allow extending the `Autowire` attribute
+ * Add `#[Exclude]` to skip autoregistering a class
 
 6.2
 ---
diff --git a/src/Symfony/Component/DependencyInjection/Loader/FileLoader.php b/src/Symfony/Component/DependencyInjection/Loader/FileLoader.php
@@ -19,6 +19,7 @@
 use Symfony\Component\Config\Resource\GlobResource;
 use Symfony\Component\DependencyInjection\Alias;
 use Symfony\Component\DependencyInjection\Attribute\AsAlias;
+use Symfony\Component\DependencyInjection\Attribute\Exclude;
 use Symfony\Component\DependencyInjection\Attribute\When;
 use Symfony\Component\DependencyInjection\ChildDefinition;
 use Symfony\Component\DependencyInjection\Compiler\RegisterAutoconfigureAttributesPass;
@@ -122,18 +123,23 @@ public function registerClasses(Definition $prototype, string $namespace, string
         $serializedPrototype = serialize($prototype);
 
         foreach ($classes as $class => $errorMessage) {
-            if (null === $errorMessage && $autoconfigureAttributes && $this->env) {
+            if (null === $errorMessage && $autoconfigureAttributes) {
                 $r = $this->container->getReflectionClass($class);
-                $attribute = null;
-                foreach ($r->getAttributes(When::class, \ReflectionAttribute::IS_INSTANCEOF) as $attribute) {
-                    if ($this->env === $attribute->newInstance()->env) {
-                        $attribute = null;
-                        break;
-                    }
-                }
-                if (null !== $attribute) {
+                if ($r->getAttributes(Exclude::class)[0] ?? null) {
                     continue;
                 }
+                if ($this->env) {
+                    $attribute = null;
+                    foreach ($r->getAttributes(When::class, \ReflectionAttribute::IS_INSTANCEOF) as $attribute) {
+                        if ($this->env === $attribute->newInstance()->env) {
+                            $attribute = null;
+                            break;
+                        }
+                    }
+                    if (null !== $attribute) {
+                        continue;
+                    }
+                }
             }
 
             if (interface_exists($class, false)) {
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Fixtures/Utils/NotAService.php b/src/Symfony/Component/DependencyInjection/Tests/Fixtures/Utils/NotAService.php
@@ -0,0 +1,10 @@
+<?php
+
+namespace Symfony\Component\DependencyInjection\Tests\Fixtures\Utils;
+
+use Symfony\Component\DependencyInjection\Attribute\Exclude;
+
+#[Exclude]
+class NotAService
+{
+}
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Loader/FileLoaderTest.php b/src/Symfony/Component/DependencyInjection/Tests/Loader/FileLoaderTest.php
@@ -40,6 +40,7 @@
 use Symfony\Component\DependencyInjection\Tests\Fixtures\PrototypeAsAlias\WithAsAliasIdMultipleInterface;
 use Symfony\Component\DependencyInjection\Tests\Fixtures\PrototypeAsAlias\WithAsAliasInterface;
 use Symfony\Component\DependencyInjection\Tests\Fixtures\PrototypeAsAlias\WithAsAliasMultiple;
+use Symfony\Component\DependencyInjection\Tests\Fixtures\Utils\NotAService;
 
 class FileLoaderTest extends TestCase
 {
@@ -145,6 +146,24 @@ public function testRegisterClassesWithExclude()
         );
     }
 
+    /**
+     * @testWith [true]
+     *           [false]
+     */
+    public function testRegisterClassesWithExcludeAttribute(bool $autoconfigure)
+    {
+        $container = new ContainerBuilder();
+        $loader = new TestFileLoader($container, new FileLocator(self::$fixturesPath.'/Fixtures'));
+
+        $loader->registerClasses(
+            (new Definition())->setAutoconfigured($autoconfigure),
+            'Symfony\Component\DependencyInjection\Tests\Fixtures\Utils\\',
+            'Utils/*',
+        );
+
+        $this->assertSame(!$autoconfigure, $container->hasDefinition(NotAService::class));
+    }
+
     public function testRegisterClassesWithExcludeAsArray()
     {
         $container = new ContainerBuilder();
