Skip to content

Commit 72d72f6

Browse files
author
Anthony MARTIN
committed
[DI] change name to tag + add XMl support + adding yaml/xml tests
1 parent e53803c commit 72d72f6

17 files changed

+227
-14
lines changed

‎Argument/TaggedIteratorArgument.php‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,14 +22,21 @@ class TaggedIteratorArgument extends IteratorArgument
2222
private $indexAttribute;
2323
private $defaultIndexMethod;
2424

25+
/**
26+
* TaggedIteratorArgument constructor.
27+
*
28+
* @param string $tag The name of the tag identifying the target services
29+
* @param string|null $indexAttribute The name of the attribute that defines the key referencing each service in the tagged collection
30+
* @param string|null $defaultIndexMethod The static method that should be called to get each service's key when their tag doesn't define the previous attribute
31+
*/
2532
public function __construct(string $tag, string $indexAttribute = null, string $defaultIndexMethod = null)
2633
{
2734
parent::__construct([]);
2835

2936
$this->tag = $tag;
30-
$this->indexAttribute = $indexAttribute ?: null;
3137

3238
if ($indexAttribute) {
39+
$this->indexAttribute = $indexAttribute;
3340
$this->defaultIndexMethod = $defaultIndexMethod ?: ('getDefault'.str_replace(' ', '', ucwords(preg_replace('/[^a-zA-Z0-9\x7f-\xff]++/', ' ', $indexAttribute))).'Name');
3441
}
3542
}

‎CHANGELOG.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ CHANGELOG
99
* added `%env(nullable:...)%` processor to allow empty variables to be processed as null values
1010
* added support for deprecating aliases
1111
* made `ContainerParametersResource` final and not implement `Serializable` anymore
12+
* added ability to define an index for a tagged collection
1213

1314
4.2.0
1415
-----

‎Dumper/XmlDumper.php‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -286,6 +286,14 @@ private function convertParameters(array $parameters, $type, \DOMElement $parent
286286
} elseif ($value instanceof TaggedIteratorArgument) {
287287
$element->setAttribute('type', 'tagged');
288288
$element->setAttribute('tag', $value->getTag());
289+
290+
if (null !== $value->getIndexAttribute()) {
291+
$element->setAttribute('index-by', $value->getIndexAttribute());
292+
}
293+
294+
if (null !== $value->getDefaultIndexMethod()) {
295+
$element->setAttribute('default-index-method', $value->getDefaultIndexMethod());
296+
}
289297
} elseif ($value instanceof IteratorArgument) {
290298
$element->setAttribute('type', 'iterator');
291299
$this->convertParameters($value->getValues(), $type, $element, 'key');

‎Dumper/YamlDumper.php‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -233,6 +233,19 @@ private function dumpValue($value)
233233
}
234234
if ($value instanceof ArgumentInterface) {
235235
if ($value instanceof TaggedIteratorArgument) {
236+
if (null !== $value->getIndexAttribute()) {
237+
$taggedValueContent = [
238+
'tag' => $value->getTag(),
239+
'index_by' => $value->getIndexAttribute(),
240+
];
241+
242+
if (null !== $value->getDefaultIndexMethod()) {
243+
$taggedValueContent['default_index_method'] = $value->getDefaultIndexMethod();
244+
}
245+
246+
return new TaggedValue('tagged', $taggedValueContent);
247+
}
248+
236249
return new TaggedValue('tagged', $value->getTag());
237250
}
238251
if ($value instanceof IteratorArgument) {

‎Loader/XmlFileLoader.php‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -353,7 +353,7 @@ private function parseDefinition(\DOMElement $service, $file, array $defaults)
353353
continue;
354354
}
355355

356-
if (false !== strpos($name, '-') && false === strpos($name, '_') && !array_key_exists($normalizedName = str_replace('-', '_', $name), $parameters)) {
356+
if (false !== strpos($name, '-') && false === strpos($name, '_') && !\array_key_exists($normalizedName = str_replace('-', '_', $name), $parameters)) {
357357
$parameters[$normalizedName] = XmlUtils::phpize($node->nodeValue);
358358
}
359359
// keep not normalized key
@@ -537,7 +537,8 @@ private function getArgumentsAsPhp(\DOMElement $node, $name, $file, $lowercase =
537537
if (!$arg->getAttribute('tag')) {
538538
throw new InvalidArgumentException(sprintf('Tag "<%s>" with type="tagged" has no or empty "tag" attribute in "%s".', $name, $file));
539539
}
540-
$arguments[$key] = new TaggedIteratorArgument($arg->getAttribute('tag'));
540+
541+
$arguments[$key] = new TaggedIteratorArgument($arg->getAttribute('tag'), $arg->getAttribute('index-by') ?: null, $arg->getAttribute('default-index-method') ?: null);
541542
break;
542543
case 'binary':
543544
if (false === $value = base64_decode($arg->nodeValue)) {

‎Loader/YamlFileLoader.php‎

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -203,7 +203,7 @@ private function parseDefinitions(array $content, string $file)
203203
throw new InvalidArgumentException(sprintf('The "services" key should contain an array in %s. Check your YAML syntax.', $file));
204204
}
205205

206-
if (array_key_exists('_instanceof', $content['services'])) {
206+
if (\array_key_exists('_instanceof', $content['services'])) {
207207
$instanceof = $content['services']['_instanceof'];
208208
unset($content['services']['_instanceof']);
209209

@@ -235,7 +235,7 @@ private function parseDefinitions(array $content, string $file)
235235
*/
236236
private function parseDefaults(array &$content, string $file): array
237237
{
238-
if (!array_key_exists('_defaults', $content['services'])) {
238+
if (!\array_key_exists('_defaults', $content['services'])) {
239239
return [];
240240
}
241241
$defaults = $content['services']['_defaults'];
@@ -342,7 +342,7 @@ private function parseDefinition($id, $service, $file, array $defaults)
342342

343343
if (isset($service['alias'])) {
344344
$this->container->setAlias($id, $alias = new Alias($service['alias']));
345-
if (array_key_exists('public', $service)) {
345+
if (\array_key_exists('public', $service)) {
346346
$alias->setPublic($service['public']);
347347
} elseif (isset($defaults['public'])) {
348348
$alias->setPublic($defaults['public']);
@@ -430,7 +430,7 @@ private function parseDefinition($id, $service, $file, array $defaults)
430430
$definition->setAbstract($service['abstract']);
431431
}
432432

433-
if (array_key_exists('deprecated', $service)) {
433+
if (\array_key_exists('deprecated', $service)) {
434434
$definition->setDeprecated(true, $service['deprecated']);
435435
}
436436

@@ -545,11 +545,11 @@ private function parseDefinition($id, $service, $file, array $defaults)
545545
}
546546
}
547547

548-
if (array_key_exists('namespace', $service) && !array_key_exists('resource', $service)) {
548+
if (\array_key_exists('namespace', $service) && !\array_key_exists('resource', $service)) {
549549
throw new InvalidArgumentException(sprintf('A "resource" attribute must be set when the "namespace" attribute is set for service "%s" in %s. Check your YAML syntax.', $id, $file));
550550
}
551551

552-
if (array_key_exists('resource', $service)) {
552+
if (\array_key_exists('resource', $service)) {
553553
if (!\is_string($service['resource'])) {
554554
throw new InvalidArgumentException(sprintf('A "resource" attribute must be of type string for service "%s" in %s. Check your YAML syntax.', $id, $file));
555555
}
@@ -713,14 +713,16 @@ private function resolveServices($value, $file, $isParameter = false)
713713
if (\is_string($argument) && $argument) {
714714
return new TaggedIteratorArgument($argument);
715715
}
716-
if (\is_array($argument) && isset($argument['name']) && $argument['name']) {
717-
if (array_diff(array_keys($argument), ['name', 'index_by', 'default_index_method'])) {
718-
throw new InvalidArgumentException('"!tagged" tag contains unsupported keys. Supported are: "name, index_by, default_index_method".');
716+
717+
if (\is_array($argument) && isset($argument['tag']) && $argument['tag']) {
718+
if ($diff = array_diff(array_keys($argument), ['tag', 'index_by', 'default_index_method'])) {
719+
throw new InvalidArgumentException(sprintf('"!tagged" tag contains unsupported key "%s"; supported ones are "tag", "index_by" and "default_index_method".', implode('"", "', $diff)));
719720
}
720721

721-
return new TaggedIteratorArgument($argument['name'], $argument['index_by'] ?? null, $argument['default_index_method'] ?? null);
722+
return new TaggedIteratorArgument($argument['tag'], $argument['index_by'] ?? null, $argument['default_index_method'] ?? null);
722723
}
723-
throw new InvalidArgumentException(sprintf('"!tagged" tag only accepts a non empty string or an array with a key "name" in "%s".', $file));
724+
725+
throw new InvalidArgumentException(sprintf('"!tagged" tags only accept a non empty string or an array with a key "tag" in "%s".', $file));
724726
}
725727
if ('service' === $value->getTag()) {
726728
if ($isParameter) {

‎Loader/schema/dic/services/services-1.0.xsd‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -234,6 +234,8 @@
234234
<xsd:attribute name="index" type="xsd:integer" />
235235
<xsd:attribute name="on-invalid" type="invalid_sequence" />
236236
<xsd:attribute name="tag" type="xsd:string" />
237+
<xsd:attribute name="index-by" type="xsd:string" />
238+
<xsd:attribute name="default-index-method" type="xsd:string" />
237239
</xsd:complexType>
238240

239241
<xsd:complexType name="call">

‎Tests/Compiler/IntegrationTest.php‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,14 @@
1414
use PHPUnit\Framework\TestCase;
1515
use Symfony\Component\Config\FileLocator;
1616
use Symfony\Component\DependencyInjection\Alias;
17+
use Symfony\Component\DependencyInjection\Argument\TaggedIteratorArgument;
1718
use Symfony\Component\DependencyInjection\ContainerBuilder;
1819
use Symfony\Component\DependencyInjection\Loader\YamlFileLoader;
1920
use Symfony\Component\DependencyInjection\Reference;
2021
use Symfony\Component\DependencyInjection\ServiceSubscriberInterface;
22+
use Symfony\Component\DependencyInjection\Tests\Fixtures\BarTagClass;
23+
use Symfony\Component\DependencyInjection\Tests\Fixtures\FooBarTaggedClass;
24+
use Symfony\Component\DependencyInjection\Tests\Fixtures\FooTagClass;
2125

2226
/**
2327
* This class tests the integration of the different compiler passes.
@@ -234,6 +238,54 @@ public function getYamlCompileTests()
234238
$container,
235239
];
236240
}
241+
242+
public function testTaggedServiceWithIndexAttribute()
243+
{
244+
$container = new ContainerBuilder();
245+
$container->register(BarTagClass::class, BarTagClass::class)
246+
->setPublic(true)
247+
->addTag('foo_bar', ['foo' => 'bar'])
248+
;
249+
$container->register(FooTagClass::class, FooTagClass::class)
250+
->setPublic(true)
251+
->addTag('foo_bar')
252+
;
253+
$container->register(FooBarTaggedClass::class, FooBarTaggedClass::class)
254+
->addArgument(new TaggedIteratorArgument('foo_bar', 'foo'))
255+
->setPublic(true)
256+
;
257+
258+
$container->compile();
259+
260+
$s = $container->get(FooBarTaggedClass::class);
261+
262+
$param = iterator_to_array($s->getParam()->getIterator());
263+
$this->assertSame(['bar' => $container->get(BarTagClass::class), 'foo_tag_class' => $container->get(FooTagClass::class)], $param);
264+
}
265+
266+
public function testTaggedServiceWithIndexAttributeAndDefaultMethod()
267+
{
268+
$container = new ContainerBuilder();
269+
$container->register(BarTagClass::class, BarTagClass::class)
270+
->setPublic(true)
271+
->addTag('foo_bar')
272+
;
273+
$container->register(FooTagClass::class, FooTagClass::class)
274+
->setPublic(true)
275+
->addTag('foo_bar', ['foo' => 'foo'])
276+
;
277+
$container->register(FooBarTaggedClass::class, FooBarTaggedClass::class)
278+
->addArgument(new TaggedIteratorArgument('foo_bar', 'foo', 'getFooBar'))
279+
->setPublic(true)
280+
;
281+
282+
$container->compile();
283+
284+
$s = $container->get(FooBarTaggedClass::class);
285+
286+
$param = iterator_to_array($s->getParam()->getIterator());
287+
$this->assertSame(['bar_tab_class_with_defaultmethod' => $container->get(BarTagClass::class), 'foo' => $container->get(FooTagClass::class)], $param);
288+
}
237289
}
238290

239291
class ServiceSubscriberStub implements ServiceSubscriberInterface

‎Tests/Dumper/XmlDumperTest.php‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313

1414
use PHPUnit\Framework\TestCase;
1515
use Symfony\Component\Config\FileLocator;
16+
use Symfony\Component\DependencyInjection\Argument\TaggedIteratorArgument;
1617
use Symfony\Component\DependencyInjection\ContainerBuilder;
1718
use Symfony\Component\DependencyInjection\ContainerInterface;
1819
use Symfony\Component\DependencyInjection\Dumper\XmlDumper;
@@ -200,6 +201,19 @@ public function testDumpLoad()
200201
$this->assertStringEqualsFile(self::$fixturesPath.'/xml/services_dump_load.xml', $dumper->dump());
201202
}
202203

204+
public function testTaggedArgument()
205+
{
206+
$container = new ContainerBuilder();
207+
$container->register('foo', 'Foo')->addTag('foo_tag');
208+
$container->register('foo_tagged_iterator', 'Bar')
209+
->setPublic(true)
210+
->addArgument(new TaggedIteratorArgument('foo_tag', 'barfoo', 'foobar'))
211+
;
212+
213+
$dumper = new XmlDumper($container);
214+
$this->assertStringEqualsFile(self::$fixturesPath.'/xml/services_with_tagged_arguments.xml', $dumper->dump());
215+
}
216+
203217
public function testDumpAbstractServices()
204218
{
205219
$container = include self::$fixturesPath.'/containers/container_abstract.php';

‎Tests/Dumper/YamlDumperTest.php‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313

1414
use PHPUnit\Framework\TestCase;
1515
use Symfony\Component\Config\FileLocator;
16+
use Symfony\Component\DependencyInjection\Argument\TaggedIteratorArgument;
1617
use Symfony\Component\DependencyInjection\ContainerBuilder;
1718
use Symfony\Component\DependencyInjection\ContainerInterface;
1819
use Symfony\Component\DependencyInjection\Definition;
@@ -95,6 +96,16 @@ public function testInlineServices()
9596
$this->assertStringEqualsFile(self::$fixturesPath.'/yaml/services_inline.yml', $dumper->dump());
9697
}
9798

99+
public function testTaggedArgument()
100+
{
101+
$container = new ContainerBuilder();
102+
$container->register('foo_service', 'Foo')->addTag('foo');
103+
$container->register('foo_service_tagged', 'Bar')->addArgument(new TaggedIteratorArgument('foo', 'barfoo', 'foobar'));
104+
105+
$dumper = new YamlDumper($container);
106+
$this->assertStringEqualsFile(self::$fixturesPath.'/yaml/services_with_tagged_argument.yml', $dumper->dump());
107+
}
108+
98109
private function assertEqualYamlStructure($expected, $yaml, $message = '')
99110
{
100111
$parser = new Parser();

0 commit comments

Comments
 (0)