symfony · angelov · May 26, 2023 · May 26, 2023 · nicolas-grekas · Nov 20, 2023
diff --git a/src/Symfony/Component/DependencyInjection/CHANGELOG.md b/src/Symfony/Component/DependencyInjection/CHANGELOG.md
@@ -1,6 +1,11 @@
 CHANGELOG
 =========
 
+7.1
+---
+
+* Add support for excluding services with declared custom attribute (`ContainerBuilder::registerAttributeForExclusion`)
-* Add support for excluding services with declared custom attribute (`ContainerBuilder::registerAttributeForExclusion`)
+ * Add support for excluding services by attribute with `ContainerBuilder::registerAttributeForExclusion()`
-* Add support for excluding services with declared custom attribute (`ContainerBuilder::registerAttributeForExclusion`)
+ * Add support for excluding services by attribute with `ContainerBuilder::registerAttributeForExclusion()`
+
 7.0
 ---
 

diff --git a/src/Symfony/Component/DependencyInjection/ContainerBuilder.php b/src/Symfony/Component/DependencyInjection/ContainerBuilder.php
@@ -27,6 +27,7 @@
 use Symfony\Component\DependencyInjection\Argument\ServiceClosureArgument;
 use Symfony\Component\DependencyInjection\Argument\ServiceLocator;
 use Symfony\Component\DependencyInjection\Argument\ServiceLocatorArgument;
+use Symfony\Component\DependencyInjection\Attribute\Exclude;
 use Symfony\Component\DependencyInjection\Attribute\Target;
 use Symfony\Component\DependencyInjection\Compiler\Compiler;
 use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
@@ -131,6 +132,11 @@ class ContainerBuilder extends Container implements TaggedContainerInterface
      */
     private array $autoconfiguredAttributes = [];
 
+    /**
+     * @var array<class-string>
-     * @var array<class-string>
+     * @var array<class-string, true>
-     * @var array<class-string>
+     * @var array<class-string, true>
+     */
+    private array $exclusionAttributes = [Exclude::class];
+
     /**
      * @var array<string, bool>
      */
@@ -1341,6 +1347,20 @@ public function registerAttributeForAutoconfiguration(string $attributeClass, ca
         $this->autoconfiguredAttributes[$attributeClass] = $configurator;
     }
 
+    /**
+     * Registers an attribute that will be used for excluding all services from classes it is declared on.
+     *
+     * @param class-string $attributeClass
+     */
+    public function registerAttributeForExclusion(string $attributeClass): void
+    {
+        if (\in_array($attributeClass, $this->exclusionAttributes)) {
+            return;
+        }
+
+        $this->exclusionAttributes[] = $attributeClass;
+    }
+
     /**
      * Registers an autowiring alias that only binds to a specific argument name.
      *
@@ -1386,6 +1406,14 @@ public function getAutoconfiguredAttributes(): array
         return $this->autoconfiguredAttributes;
     }
 
+    /**
+     * @return array<class-string>
+     */
+    public function getExclusionAttributes(): array
+    {
+        return $this->exclusionAttributes;
+    }
+
     /**
      * Resolves env parameter placeholders in a string or an array.
      *

diff --git a/src/Symfony/Component/DependencyInjection/Loader/FileLoader.php b/src/Symfony/Component/DependencyInjection/Loader/FileLoader.php
@@ -140,10 +140,15 @@ public function registerClasses(Definition $prototype, string $namespace, string
         foreach ($classes as $class => $errorMessage) {
             if (null === $errorMessage && $autoconfigureAttributes) {
                 $r = $this->container->getReflectionClass($class);
-                if ($r->getAttributes(Exclude::class)[0] ?? null) {
-                    $this->addContainerExcludedTag($class, $source);
-                    continue;
+                $exclusionAttributes = $this->container->getExclusionAttributes();
+
+                foreach ($exclusionAttributes as $attribute) {
+                    if ($r->getAttributes($attribute)[0] ?? null) {
+                        $this->addContainerExcludedTag($class, $source);
+                        continue 2;
+                    }
                 }
+
                 if ($this->env) {
                     $attribute = null;
                     foreach ($r->getAttributes(When::class, \ReflectionAttribute::IS_INSTANCEOF) as $attribute) {

diff --git a/...y/Component/DependencyInjection/Tests/Fixtures/Utils/ServiceWithAttributeForExclusion.php b/...y/Component/DependencyInjection/Tests/Fixtures/Utils/ServiceWithAttributeForExclusion.php
@@ -0,0 +1,8 @@
+<?php
+
+namespace Symfony\Component\DependencyInjection\Tests\Fixtures\Utils;
+
+#[ToBeExcluded]
+class ServiceWithAttributeForExclusion
+{
+}
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Fixtures/Utils/ToBeExcluded.php b/src/Symfony/Component/DependencyInjection/Tests/Fixtures/Utils/ToBeExcluded.php
@@ -0,0 +1,8 @@
+<?php
+
+namespace Symfony\Component\DependencyInjection\Tests\Fixtures\Utils;
+
+#[\Attribute(\Attribute::TARGET_CLASS)]
+class ToBeExcluded
+{
+}
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Loader/FileLoaderTest.php b/src/Symfony/Component/DependencyInjection/Tests/Loader/FileLoaderTest.php
@@ -41,6 +41,8 @@
 use Symfony\Component\DependencyInjection\Tests\Fixtures\PrototypeAsAlias\WithAsAliasInterface;
 use Symfony\Component\DependencyInjection\Tests\Fixtures\PrototypeAsAlias\WithAsAliasMultiple;
 use Symfony\Component\DependencyInjection\Tests\Fixtures\Utils\NotAService;
+use Symfony\Component\DependencyInjection\Tests\Fixtures\Utils\ServiceWithAttributeForExclusion;
+use Symfony\Component\DependencyInjection\Tests\Fixtures\Utils\ToBeExcluded;
 
 class FileLoaderTest extends TestCase
 {
@@ -164,6 +166,27 @@ public function testRegisterClassesWithExcludeAttribute(bool $autoconfigure)
         $this->assertSame($autoconfigure, $container->getDefinition(NotAService::class)->hasTag('container.excluded'));
     }
 
+    /**
+     * @testWith [true]
+     *           [false]
+     */
+    public function testRegisterClassesWithAttributeMarkedForExclusion(bool $autoconfigure)
+    {
+        $container = new ContainerBuilder();
+
+        $container->registerAttributeForExclusion(ToBeExcluded::class);
+
+        $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->getDefinition(ServiceWithAttributeForExclusion::class)->hasTag('container.excluded'));
+    }
+
     public function testRegisterClassesWithExcludeAsArray()
     {
         $container = new ContainerBuilder();