[DependencyInjection] Add ContainerBuilder::findTaggedValueClasses

GromNaN · GromNaN · commit 2cc8c75e5b24 · 2025-02-05T18:55:36.000+01:00
diff --git a/src/Symfony/Component/DependencyInjection/CHANGELOG.md b/src/Symfony/Component/DependencyInjection/CHANGELOG.md
@@ -6,6 +6,7 @@ CHANGELOG
 
  * Make `#[AsTaggedItem]` repeatable
  * Support `@>` as a shorthand for `!service_closure` in yaml files
+ * Add `ContainerBuilder::findTaggedValueClasses()` for auto-discovering value-object classes
 
 7.2
 ---
diff --git a/src/Symfony/Component/DependencyInjection/ContainerBuilder.php b/src/Symfony/Component/DependencyInjection/ContainerBuilder.php
@@ -1351,6 +1351,30 @@ public function findTaggedServiceIds(string $name, bool $throwOnAbstract = false
         return $tags;
     }
 
+    /**
+     * Find definitions of value-object classes by tag, and add the "container.excluded" tag to them.
+     *
+     * @param bool $autoExclude Adds the "container.excluded" tag to the returned definitions
+     *
+     * @return array<string, array> An array of tags with the tagged classes as key, holding a list of attribute arrays
+     */
+    public function findTaggedValueClasses(string $name, bool $autoExclude = true): array
+    {
+        $this->usedTags[] = $name;
+        $tags = [];
+        foreach ($this->getDefinitions() as $id => $definition) {
+            if ($definition->hasTag($name)) {
+                if ($autoExclude) {
+                    $definition->addTag('container.excluded', ['source' => \sprintf('by tag "%s"', $name)]);
+                }
+
+                $tags[$id] = $definition->getTag($name);
+            }
+        }
+
+        return $tags;
+    }
+
     /**
      * Returns all tags the defined services use.
      *
diff --git a/src/Symfony/Component/DependencyInjection/Tests/ContainerBuilderTest.php b/src/Symfony/Component/DependencyInjection/Tests/ContainerBuilderTest.php
@@ -1062,11 +1062,12 @@ public function testMergeLogicException()
         $container->merge(new ContainerBuilder());
     }
 
-    public function testfindTaggedServiceIds()
+    public function testFindTaggedServiceIds()
     {
         $builder = new ContainerBuilder();
         $builder
             ->register('foo', 'Bar\FooClass')
+            ->setAbstract(true)
             ->addTag('foo', ['foo' => 'foo'])
             ->addTag('bar', ['bar' => 'bar'])
             ->addTag('foo', ['foofoo' => 'foofoo'])
@@ -1083,6 +1084,34 @@ public function testfindTaggedServiceIds()
             ],
         ], $builder->findTaggedServiceIds('foo'), '->findTaggedServiceIds() returns an array of service ids and its tag attributes');
         $this->assertEquals([], $builder->findTaggedServiceIds('foobar'), '->findTaggedServiceIds() returns an empty array if there is annotated services');
+        $this->expectException(InvalidArgumentException::class);
+        $this->expectExceptionMessage('The service "foo" tagged "foo" must not be abstract.');
+        $builder->findTaggedServiceIds('foo', true);
+    }
+
+    public function testFindTaggedValueClasses()
+    {
+        $builder = new ContainerBuilder();
+        $builder
+            ->register('foo', 'Bar\FooClass')
+            ->setAbstract(true)
+            ->addTag('foo', ['foo' => 'foo'])
+            ->addTag('bar', ['bar' => 'bar'])
+            ->addTag('foo', ['foofoo' => 'foofoo'])
+        ;
+
+        $expected = [
+            'foo' => [
+                ['foo' => 'foo'],
+                ['foofoo' => 'foofoo'],
+            ],
+        ];
+
+        $this->assertEquals($expected, $builder->findTaggedValueClasses('foo', false));
+        $this->assertFalse($builder->getDefinition('foo')->hasTag('container.excluded'));
+
+        $this->assertEquals($expected, $builder->findTaggedValueClasses('foo'));
+        $this->assertTrue($builder->getDefinition('foo')->hasTag('container.excluded'));
     }
 
     public function testFindUnusedTags()
