Rename to addValueObjectTag and add $autoExclude

GromNaN · GromNaN · commit 1b3d41ad4f2b · 2025-02-06T11:52:55.000+01:00
diff --git a/src/Symfony/Component/DependencyInjection/CHANGELOG.md b/src/Symfony/Component/DependencyInjection/CHANGELOG.md
@@ -6,7 +6,7 @@ CHANGELOG
 
  * Make `#[AsTaggedItem]` repeatable
  * Support `@>` as a shorthand for `!service_closure` in yaml files
- * Add `Definition::tagAsValueObject()` and `ContainerBuilder::findTaggedValueObjects()` for auto-discovering value-objects
+ * Add `Definition::addValueObjectTag()` and `ContainerBuilder::findTaggedValueObjects()` for auto-discovering value-objects
 
 7.2
 ---
diff --git a/src/Symfony/Component/DependencyInjection/ContainerBuilder.php b/src/Symfony/Component/DependencyInjection/ContainerBuilder.php
@@ -1356,12 +1356,16 @@ public function findTaggedServiceIds(string $name, bool $throwOnAbstract = false
      *
      * @return array<string, array> An array of tags with the tagged class as key, holding a list of attribute arrays
      */
-    public function findTaggedValueObject(string $name): array
+    public function findTaggedValueObject(string $name, bool $autoExclude = true): array
     {
         $this->usedTags[] = $name;
         $tags = [];
         foreach ($this->getDefinitions() as $id => $definition) {
             if ($definition->hasTag($name)) {
+                if ($autoExclude && !$definition->hasTag('container.excluded')) {
+                    $definition->setAbstract(true)
+                        ->addTag('container.excluded', ['source' => \sprintf('by tag "%s"', $name)]);
+                }
                 $tags[$id] = $definition->getTag($name);
             }
         }
diff --git a/src/Symfony/Component/DependencyInjection/Definition.php b/src/Symfony/Component/DependencyInjection/Definition.php
@@ -460,7 +460,7 @@ public function addTag(string $name, array $attributes = []): static
      *
      * @return $this
      */
-    public function tagAsValueObject(string $name, array $attributes = []): static
+    public function addValueObjectTag(string $name, array $attributes = []): static
     {
         return $this->addTag($name, $attributes)
             ->addTag('container.excluded', ['source' => \sprintf('by tag "%s"', $name)])
diff --git a/src/Symfony/Component/DependencyInjection/Tests/ContainerBuilderTest.php b/src/Symfony/Component/DependencyInjection/Tests/ContainerBuilderTest.php
@@ -1094,13 +1094,18 @@ public function testFindTaggedValueObject()
         $builder = new ContainerBuilder();
         $builder
             ->register('foo', 'Bar\FooClass')
-            ->tagAsValueObject('foo', ['foo' => 'foo'])
+            ->addTag('foo', ['foo' => 'foo'])
             ->addTag('bar', ['bar' => 'bar'])
             ->addTag('foo', ['foofoo' => 'foofoo'])
         ;
 
         $expected = ['foo' => [['foo' => 'foo'], ['foofoo' => 'foofoo']]];
+        $this->assertSame($expected, $builder->findTaggedValueObject('foo', false));
+        $this->assertFalse($builder->getDefinition('foo')->hasTag('container.excluded'));
+        $this->assertFalse($builder->getDefinition('foo')->isAbstract());
         $this->assertSame($expected, $builder->findTaggedValueObject('foo'));
+        $this->assertTrue($builder->getDefinition('foo')->hasTag('container.excluded'));
+        $this->assertTrue($builder->getDefinition('foo')->isAbstract());
     }
 
     public function testFindUnusedTags()
diff --git a/src/Symfony/Component/DependencyInjection/Tests/DefinitionTest.php b/src/Symfony/Component/DependencyInjection/Tests/DefinitionTest.php
@@ -258,10 +258,10 @@ public function testTags()
         ], $def->getTags(), '->getTags() returns all tags');
     }
 
-    public function testTagAsValueObject()
+    public function testAddValueObjectTag()
     {
         $def = new Definition('stdClass');
-        $def->tagAsValueObject('foo', ['bar' => true]);
+        $def->addValueObjectTag('foo', ['bar' => true]);
         $this->assertSame([['bar' => true]], $def->getTag('foo'));
         $this->assertTrue($def->isAbstract());
         $this->assertSame([['source' => 'by tag "foo"']], $def->getTag('container.excluded'));

Original file line number	Diff line number	Diff line change
`@@ -1356,12 +1356,16 @@ public function findTaggedServiceIds(string $name, bool $throwOnAbstract = false`
`1356`	`1356`	`*`
`1357`	`1357`	`* @return array<string, array> An array of tags with the tagged class as key, holding a list of attribute arrays`
`1358`	`1358`	`*/`
`1359`		`- public function findTaggedValueObject(string $name): array`
	`1359`	`+ public function findTaggedValueObject(string $name, bool $autoExclude = true): array`
`1360`	`1360`	`{`
`1361`	`1361`	`$this->usedTags[] = $name;`
`1362`	`1362`	`$tags = [];`
`1363`	`1363`	`foreach ($this->getDefinitions() as $id => $definition) {`
`1364`	`1364`	`if ($definition->hasTag($name)) {`
	`1365`	`+ if ($autoExclude && !$definition->hasTag('container.excluded')) {`
	`1366`	`+ $definition->setAbstract(true)`
	`1367`	`+ ->addTag('container.excluded', ['source' => \sprintf('by tag "%s"', $name)]);`
	`1368`	`+ }`
`1365`	`1369`	`$tags[$id] = $definition->getTag($name);`
`1366`	`1370`	`}`
`1367`	`1371`	`}`
Original file line number	Diff line number	Diff line change
`@@ -460,7 +460,7 @@ public function addTag(string $name, array $attributes = []): static`
`460`	`460`	`*`
`461`	`461`	`* @return $this`
`462`	`462`	`*/`
`463`		`- public function tagAsValueObject(string $name, array $attributes = []): static`
	`463`	`+ public function addValueObjectTag(string $name, array $attributes = []): static`
`464`	`464`	`{`
`465`	`465`	`return $this->addTag($name, $attributes)`
`466`	`466`	`->addTag('container.excluded', ['source' => \sprintf('by tag "%s"', $name)])`
Original file line number	Diff line number	Diff line change
`@@ -258,10 +258,10 @@ public function testTags()`
`258`	`258`	`], $def->getTags(), '->getTags() returns all tags');`
`259`	`259`	`}`
`260`	`260`
`261`		`- public function testTagAsValueObject()`
	`261`	`+ public function testAddValueObjectTag()`
`262`	`262`	`{`
`263`	`263`	`$def = new Definition('stdClass');`
`264`		`- $def->tagAsValueObject('foo', ['bar' => true]);`
	`264`	`+ $def->addValueObjectTag('foo', ['bar' => true]);`
`265`	`265`	`$this->assertSame([['bar' => true]], $def->getTag('foo'));`
`266`	`266`	`$this->assertTrue($def->isAbstract());`
`267`	`267`	`$this->assertSame([['source' => 'by tag "foo"']], $def->getTag('container.excluded'));`