8000 Rename to `Definition::addExcludeTag()` and `ContainerBuilder::findEx… · symfony/symfony@1fcd764 · GitHub
[go: up one dir, main page]
Skip to content
8000

Commit 1fcd764

Browse files
GromNaNGromNaN
committed
Rename to Definition::addExcludeTag() and ContainerBuilder::findExcludedServiceIds() 
1 parent 03c92d8 commit 1fcd764

File tree

5 files changed

+62
-33
lines changed

5 files changed

+62
-33
lines changed

‎src/Symfony/Component/DependencyInjection/CHANGELOG.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@ CHANGELOG
77
* Make `#[AsTaggedItem]` repeatable
88
* Support `@>` as a shorthand for `!service_closure` in yaml files
99
* Don't skip classes with private constructor when autodiscovering
10-
* Add `ContainerBuilder::findTaggedValueClasses()` for auto-discovering value-object classes
10+
* Add `Definition::addExcludeTag()` and `ContainerBuilder::findExcludedServiceIds()`
11+
for auto-configuration of classes excluded from the service container.
1112

1213
7.2
1314
---

‎src/Symfony/Component/DependencyInjection/ContainerBuilder.php

Lines changed: 19 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1352,21 +1352,31 @@ public function findTaggedServiceIds(string $name, bool $throwOnAbstract = false
13521352
}
13531353

13541354
/**
1355-
* Finds definitions of value-objects by tag.
1355+
* Returns service ids for a given tag, asserting they have the "container.excluded" tag.
13561356
*
1357-
* @return array<string, array> An array of tags with the tagged class as key, holding a list of attribute arrays
1357+
* Example:
1358+
*
1359+
* $container->register('foo')->addExcludeTag('my.tag', ['hello' => 'world'])
1360+
*
1361+
* $serviceIds = $container->findExcludedServiceIds('my.tag');
1362+
* foreach ($serviceIds as $serviceId => $tags) {
1363+
* foreach ($tags as $tag) {
1364+
* echo $tag['hello'];
1365+
* }
1366+
* }
1367+
*
1368+
* @return array<string, array> An array of tags with the tagged service as key, holding a list of attribute arrays
13581369
*/
1359-
public function findTaggedValueObjects(string $name, bool $autoExclude = true): array
1370+
public function findExcludedServiceIds(string $tagName): array
13601371
{
1361-
$this->usedTags[] = $name;
1372+
$this->usedTags[] = $tagName;
13621373
$tags = [];
13631374
foreach ($this->getDefinitions() as $id => $definition) {
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)]);
1375+
if ($definition->hasTag($tagName)) {
1376+
if (!$definition->hasTag('container.excluded')) {
1377+
throw new InvalidArgumentException(\sprintf('The service "%s" tagged "%s" must have the "container.excluded" tag.', $id, $tagName));
13681378
}
1369-
$tags[$id] = $definition->getTag($name);
1379+
$tags[$id] = $definition->getTag($tagName);
13701380
}
13711381
}
13721382

‎src/Symfony/Component/DependencyInjection/Definition.php

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -456,11 +456,13 @@ public function addTag(string $name, array $attributes = []): static
456456
}
457457

458458
/**
459-
* Adds a tag to the definition and marks it as a value object.
459+
* Adds a tag to the definition and marks it as excluded.
460+
*
461+
* This definitions must be processed using {@see ContainerBuilder::findExcludedServiceIds()}
460462
*
461463
* @return $this
462464
*/
463-
public function addValueObjectTag(string $name, array $attributes = []): static
465+
public function addExcludeTag(string $name, array $attributes = []): static
464466
{
465467
return $this->addTag($name, $attributes)
466468
->addTag('container.excluded', ['source' => \sprintf('by tag "%s"', $name)])

‎src/Symfony/Component/DependencyInjection/Tests/ContainerBuilderTest.php

Lines changed: 34 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@
3434
use Symfony\Component\DependencyInjection\Exception\BadMethodCallException;
3535
use Symfony\Component\DependencyInjection\Exception\EnvNotFoundException;
3636
use Symfony\Component\DependencyInjection\Exception\InvalidArgumentException;
37+
use Symfony\Component\DependencyInjection\Exception\LogicException;
3738
use Symfony\Component\DependencyInjection\Exception\ParameterCircularReferenceException;
3839
use Symfony\Component\DependencyInjection\Exception\ParameterNotFoundException;
3940
use Symfony\Component\DependencyInjection\Exception\RuntimeException;
@@ -1065,47 +1066,61 @@ public function testMergeLogicException()
10651066
public function testFindTaggedServiceIds()
10661067
{
10671068
$builder = new ContainerBuilder();
1068-
$builder
1069-
->register('foo', 'Bar\FooClass')
1069+
$builder->register('foo', 'Bar\FooClass')
10701070
->setAbstract(true)
10711071
->addTag('foo', ['foo' => 'foo'])
10721072
->addTag('bar', ['bar' => 'bar'])
1073-
->addTag('foo', ['foofoo' => 'foofoo'])
1074-
;
1075-
$builder
1076-
->register('bar', 'Bar\FooClass')
1073+
->addTag('foo', ['foofoo' => 'foofoo']);
1074+
$builder->register('bar', 'Bar\FooClass')
10771075
->addTag('foo')
1078-
->addTag('container.excluded')
1079-
;
1076+
->addTag('container.excluded');
1077+
10801078
$this->assertEquals([
10811079
'foo' => [
10821080
['foo' => 'foo'],
10831081
['foofoo' => 'foofoo'],
10841082
],
10851083
], $builder->findTaggedServiceIds('foo'), '->findTaggedServiceIds() returns an array of service ids and its tag attributes');
1084+
}
1085+
1086+
public function testFindTaggedServiceIdsThrowsWhenAbstract()
1087+
{
1088+
$builder = new ContainerBuilder();
1089+
$builder->register('foo', 'Bar\FooClass')
1090+
->setAbstract(true)
1091+
->addTag('foo', ['foo' => 'foo']);
1092+
10861093
$this->assertEquals([], $builder->findTaggedServiceIds('foobar'), '->findTaggedServiceIds() returns an empty array if there is annotated services');
10871094
$this->expectException(InvalidArgumentException::class);
10881095
$this->expectExceptionMessage('The service "foo" tagged "foo" must not be abstract.');
10891096
$builder->findTaggedServiceIds('foo', true);
10901097
}
10911098

1092-
public function testFindTaggedValueObjects()
1099+
public function testFindExcludedServiceIds()
10931100
{
10941101
$builder = new ContainerBuilder();
1095-
$builder
1096-
->register('foo', 'Bar\FooClass')
1102+
$builder->register('myservice', 'Bar\FooClass')
10971103
->addTag('foo', ['foo' => 'foo'])
10981104
->addTag('bar', ['bar' => 'bar'])
10991105
->addTag('foo', ['foofoo' => 'foofoo'])
1100-
;
1106 D7AE +
->addExcludeTag('container.excluded');
1107+
1108+
$expected = ['myservice' => [['foo' => 'foo'], ['foofoo' => 'foofoo']]];
1109+
$this->assertSame($expected, $builder->findExcludedServiceIds('foo'));
1110+
$this->assertSame([], $builder->findExcludedServiceIds('foofoo'));
1111+
}
11011112

1102-
$expected = ['foo' => [['foo' => 'foo'], ['foofoo' => 'foofoo']]];
1103-
$this->assertSame($expected, $builder->findTaggedValueObjects('foo', false));
1104-
$this->assertFalse($builder->getDefinition('foo')->hasTag('container.excluded'));
1105-
$this->assertFalse($builder->getDefinition('foo')->isAbstract());
1106-
$this->assertSame($expected, $builder->findTaggedValueObjects('foo'));
1107-
$this->assertTrue($builder->getDefinition('foo')->hasTag('container.excluded'));
1108-
$this->assertTrue($builder->getDefinition('foo')->isAbstract());
1113+
public function testFindExcludedServiceIdsThrowsWhenNotExcluded()
1114+
{
1115+
$builder = new ContainerBuilder();
1116+
$builder->register('myservice', 'Bar\FooClass')
1117+
->addTag('foo', ['foo' => 'foo'])
1118+
->addTag('bar', ['bar' => 'bar'])
1119+
->addTag('foo', ['foofoo' => 'foofoo']);
1120+
1121+
$this->expectException(InvalidArgumentException::class);
1122+
$this->expectExceptionMessage('The service "myservice" tagged "foo" must have the "container.excluded" tag.');
1123+
$builder->findExcludedServiceIds('foo', true);
11091124
}
11101125

11111126
public function testFindUnusedTags()

‎src/Symfony/Component/DependencyInjection/Tests/DefinitionTest.php

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -258,10 +258,11 @@ public function testTags()
258258
], $def->getTags(), '->getTags() returns all tags');
259259
}
260260

261-
public function testAddValueObjectTag()
261+
public function testAddExcludeTag()
262262
{
263263
$def = new Definition('stdClass');
264-
$def->addValueObjectTag('foo', ['bar' => true]);
264+
$def->addExcludeTag('foo', ['bar' => true]);
265+
265266
$this->assertSame([['bar' => true]], $def->getTag('foo'));
266267
$this->assertTrue($def->isAbstract());
267268
$this->assertSame([['source' => 'by tag "foo"']], $def->getTag('container.excluded'));

0 commit comments

Comments
 (0)
0