symfony · nicolas-grekas · Sep 28, 2017 · Mar 28, 2017 · stof · Oct 6, 2017
diff --git a/src/Symfony/Component/DependencyInjection/Argument/TaggedIteratorArgument.php b/src/Symfony/Component/DependencyInjection/Argument/TaggedIteratorArgument.php
@@ -0,0 +1,37 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\DependencyInjection\Argument;
+
+/**
+ * Represents a collection of services found by tag name to lazily iterate over.
+ *
+ * @author Roland Franssen <franssen.roland@gmail.com>
+ */
+class TaggedIteratorArgument extends IteratorArgument
+{
+    private $tag;
+
+    /**
+     * @param string $tag
+     */
+    public function __construct($tag)
+    {
+        parent::__construct(array());
+
+        $this->tag = (string) $tag;
+    }
+
+    public function getTag()
+    {
+        return $this->tag;
+    }
+}
diff --git a/src/Symfony/Component/DependencyInjection/CHANGELOG.md b/src/Symfony/Component/DependencyInjection/CHANGELOG.md
@@ -13,6 +13,7 @@ CHANGELOG
  * deprecated support for top-level anonymous services in XML
  * deprecated case insensitivity of parameter names
  * deprecated the `ResolveDefinitionTemplatesPass` class in favor of `ResolveChildDefinitionsPass`
+ * added `TaggedIteratorArgument` with YAML (`!tagged foo`) and XML (`<service type="tagged"/>`) support
 
 3.3.0
 -----

diff --git a/src/Symfony/Component/DependencyInjection/Compiler/PassConfig.php b/src/Symfony/Component/DependencyInjection/Compiler/PassConfig.php
@@ -61,6 +61,7 @@ public function __construct()
             new AutowireRequiredMethodsPass(),
             new ResolveBindingsPass(),
             new AutowirePass(false),
+            new ResolveTaggedIteratorArgumentPass(),
             new ResolveServiceSubscribersPass(),
             new ResolveReferencesToAliasesPass(),
             new ResolveInvalidReferencesPass(),

diff --git a/src/Symfony/Component/DependencyInjection/Compiler/ResolveTaggedIteratorArgumentPass.php b/src/Symfony/Component/DependencyInjection/Compiler/ResolveTaggedIteratorArgumentPass.php
@@ -0,0 +1,38 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\DependencyInjection\Compiler;
+
+use Symfony\Component\DependencyInjection\Argument\TaggedIteratorArgument;
+
+/**
+ * Resolves all TaggedIteratorArgument arguments.
+ *
+ * @author Roland Franssen <franssen.roland@gmail.com>
+ */
+class ResolveTaggedIteratorArgumentPass extends AbstractRecursivePass
+{
+    use PriorityTaggedServiceTrait;
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function processValue($value, $isRoot = false)
+    {
+        if (!$value instanceof TaggedIteratorArgument) {
+            return parent::processValue($value, $isRoot);
+        }
+
+        $value->setValues($this->findAndSortTaggedServices($value->getTag(), $this->container));
+
+        return $value;
+    }
+}
diff --git a/src/Symfony/Component/DependencyInjection/Dumper/XmlDumper.php b/src/Symfony/Component/DependencyInjection/Dumper/XmlDumper.php
@@ -13,6 +13,7 @@
 
 use Symfony\Component\DependencyInjection\Argument\IteratorArgument;
 use Symfony\Component\DependencyInjection\Argument\ServiceClosureArgument;
+use Symfony\Component\DependencyInjection\Argument\TaggedIteratorArgument;
 use Symfony\Component\DependencyInjection\ContainerInterface;
 use Symfony\Component\DependencyInjection\Parameter;
 use Symfony\Component\DependencyInjection\Reference;
@@ -298,6 +299,9 @@ private function convertParameters(array $parameters, $type, \DOMElement $parent
             if (is_array($value)) {
                 $element->setAttribute('type', 'collection');
                 $this->convertParameters($value, $type, $element, 'key');
+            } elseif ($value instanceof TaggedIteratorArgument) {
+                $element->setAttribute('type', 'tagged');
+                $element->setAttribute('tag', $value->getTag());
             } elseif ($value instanceof IteratorArgument) {
                 $element->setAttribute('type', 'iterator');
                 $this->convertParameters($value->getValues(), $type, $element, 'key');

diff --git a/src/Symfony/Component/DependencyInjection/Dumper/YamlDumper.php b/src/Symfony/Component/DependencyInjection/Dumper/YamlDumper.php
@@ -19,6 +19,7 @@
 use Symfony\Component\DependencyInjection\Argument\ArgumentInterface;
 use Symfony\Component\DependencyInjection\Argument\IteratorArgument;
 use Symfony\Component\DependencyInjection\Argument\ServiceClosureArgument;
+use Symfony\Component\DependencyInjection\Argument\TaggedIteratorArgument;
 use Symfony\Component\DependencyInjection\ContainerInterface;
 use Symfony\Component\DependencyInjection\Definition;
 use Symfony\Component\DependencyInjection\Parameter;
@@ -263,6 +264,9 @@ private function dumpValue($value)
             $value = $value->getValues()[0];
         }
         if ($val
8000
ue instanceof ArgumentInterface) {
+            if ($value instanceof TaggedIteratorArgument) {
+                return new TaggedValue('tagged', $value->getTag());
+            }
             if ($value instanceof IteratorArgument) {
                 $tag = 'iterator';
             } else {

diff --git a/src/Symfony/Component/DependencyInjection/Loader/Configurator/ContainerConfigurator.php b/src/Symfony/Component/DependencyInjection/Loader/Configurator/ContainerConfigurator.php
@@ -12,6 +12,7 @@
 namespace Symfony\Component\DependencyInjection\Loader\Configurator;
 
 use Symfony\Component\DependencyInjection\Argument\IteratorArgument;
+use Symfony\Component\DependencyInjection\Argument\TaggedIteratorArgument;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Definition;
 use Symfony\Component\DependencyInjection\Exception\InvalidArgumentException;
@@ -115,6 +116,18 @@ function iterator(array $values)
     return new IteratorArgument(AbstractConfigurator::processValue($values, true));
 }
 
+/**
+ * Creates a lazy iterator by tag name.
+ *
+ * @param string $tag
+ *
+ * @return TaggedIteratorArgument
+ */
+function tagged($tag)
+{
+    return new TaggedIteratorArgument($tag);
+}
+
 /**
  * Creates an expression.
  *

diff --git a/src/Symfony/Component/DependencyInjection/Loader/XmlFileLoader.php b/src/Symfony/Component/DependencyInjection/Loader/XmlFileLoader.php
@@ -12,6 +12,7 @@
 namespace Symfony\Component\DependencyInjection\Loader;
 
 use Symfony\Component\Config\Util\XmlUtils;
+use Symfony\Component\DependencyInjection\Argument\TaggedIteratorArgument;
 use Symfony\Component\DependencyInjection\ContainerInterface;
 use Symfony\Component\DependencyInjection\Alias;
 use Symfony\Component\DependencyInjection\Argument\BoundArgument;
@@ -518,6 +519,12 @@ private function getArgumentsAsPhp(\DOMElement $node, $name, $file, $lowercase =
                         throw new InvalidArgumentException(sprintf('Tag "<%s>" with type="iterator" only accepts collections of type="service" references in "%s".', $name, $file));
                     }
                     break;
+                case 'tagged':
+                    if (!$arg->getAttribute('tag')) {
+                        throw new InvalidArgumentException(sprintf('Tag "<%s>" with type="tagged" has no or empty "tag" attribute in "%s".', $name, $file));
+                    }
+                    $arguments[$key] = new TaggedIteratorArgument($arg->getAttribute('tag'));
+                    break;
                 case 'string':
                     $arguments[$key] = $arg->nodeValue;
                     break;

diff --git a/src/Symfony/Component/DependencyInjection/Loader/YamlFileLoader.php b/src/Symfony/Component/DependencyInjection/Loader/YamlFileLoader.php
@@ -15,6 +15,7 @@
 use Symfony\Component\DependencyInjection\Argument\ArgumentInterface;
 use Symfony\Component\DependencyInjection\Argument\BoundArgument;
 use Symfony\Component\DependencyInjection\Argument\IteratorArgument;
+use Symfony\Component\DependencyInjection\Argument\TaggedIteratorArgument;
 use Symfony\Component\DependencyInjection\ChildDefinition;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\ContainerInterface;
@@ -726,6 +727,13 @@ private function resolveServices($value, $file, $isParameter = false)
                     throw new InvalidArgumentException(sprintf('"!iterator" tag only accepts arrays of "@service" references in "%s".', $file));
                 }
             }
+            if ('tagged' === $value->getTag()) {
+                if (!is_string($argument) || !$argument) {
+                    throw new InvalidArgumentException(sprintf('"!tagged" tag only accepts non empty string in "%s".', $file));
+                }
+
+                return new TaggedIteratorArgument($argument);
+            }
             if ('service' === $value->getTag()) {
                 if ($isParameter) {
                     throw new InvalidArgumentException(sprintf('Using an anonymous service in a parameter is not allowed in "%s".', $file));

diff --git a/src/Symfony/Component/DependencyInjection/Loader/schema/dic/services/services-1.0.xsd b/src/Symfony/Component/DependencyInjection/Loader/schema/dic/services/services-1.0.xsd
@@ -208,6 +208,7 @@
     <xsd:attribute name="name" type="xsd:string" />
     <xsd:attribute name="on-invalid" type="invalid_sequence" />
     <xsd:attribute name="strict" type="boolean" />
+    <xsd:attribute name="tag" type="xsd:string" />
   </xsd:complexType>
 
   <xsd:complexType name="bind" mixed="true">
@@ -233,6 +234,7 @@
     <xsd:attribute name="index" type="xsd:integer" />
     <xsd:attribute name="on-invalid" type="invalid_sequence" />
     <xsd:attribute name="strict" type="boolean" />
+    <xsd:attribute name="tag" type="xsd:string" />
   </xsd:complexType>
 
   <xsd:complexType name="call">
@@ -258,6 +260,7 @@
       <xsd:enumeration value="string" />
       <xsd:enumeration value="constant" />
       <xsd:enumeration value="iterator" />
+      <xsd:enumeration value="tagged" />
     </xsd:restriction>
   </xsd:simpleType>
 

diff --git a/...ny/Component/DependencyInjection/Tests/Compiler/ResolveTaggedIteratorArgumentPassTest.php b/...ny/Component/DependencyInjection/Tests/Compiler/ResolveTaggedIteratorArgumentPassTest.php
@@ -0,0 +1,40 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\DependencyInjection\Tests\Compiler;
+
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\DependencyInjection\Argument\TaggedIteratorArgument;
+use Symfony\Component\DependencyInjection\Compiler\ResolveTaggedIteratorArgumentPass;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Reference;
+
+/**
+ * @author Roland Franssen <franssen.roland@gmail.com>
+ */
+class ResolveTaggedIteratorArgumentPassTest extends TestCase
+{
+    public function testProcess()
+    {
+        $container = new ContainerBuilder();
+        $container->register('a', 'stdClass')->addTag('foo');
+        $container->register('b', 'stdClass')->addTag('foo', array('priority' => 20));
+        $container->register('c', 'stdClass')->addTag('foo', array('priority' => 10));
+        $container->register('d', 'stdClass')->setProperty('foos', new TaggedIteratorArgument('foo'));
+
+        (new ResolveTaggedIteratorArgumentPass())->process($container);
+
+        $properties = $container->getDefinition('d')->getProperties();
+        $expected = new TaggedIteratorArgument('foo');
+        $expected->setValues(array(new Reference('b'), new Reference('c'), new Reference('a')));
+        $this->assertEquals($expected, $properties['foos']);
+    }
+}
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Fixtures/config/basic.php b/src/Symfony/Component/DependencyInjection/Tests/Fixtures/config/basic.php
@@ -5,9 +5,7 @@
 use App\BarService;
 
 return function (ContainerConfigurator $c) {
-
     $s = $c->services();
     $s->set(BarService::class)
         ->args(array(inline('FooClass')));
-
 };
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Fixtures/config/child.php b/src/Symfony/Component/DependencyInjection/Tests/Fixtures/config/child.php
@@ -5,7 +5,6 @@
 use App\BarService;
 
 return function (ContainerConfigurator $c) {
-
     $c->services()
         ->set('bar', 'Class1')
         ->set(BarService::class)
@@ -20,5 +19,4 @@
             ->parent('bar')
             ->parent(BarService::class)
     ;
-
 };
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Fixtures/config/defaults.php b/src/Symfony/Component/DependencyInjection/Tests/Fixtures/config/defaults.php
@@ -5,7 +5,6 @@
 use Symfony\Component\DependencyInjection\Tests\Fixtures\Prototype\Foo;
 
 return function (ContainerConfigurator $c) {
-
     $c->import('basic.php');
 
     $s = $c->services()->defaults()
@@ -19,5 +18,4 @@
 
     $s->set(Foo::class)->args(array(ref('bar')))->public();
     $s->set('bar', Foo::class)->call('setFoo')->autoconfigure(false);
-
 };
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Fixtures/config/instanceof.php b/src/Symfony/Component/DependencyInjection/Tests/Fixtures/config/instanceof.php
@@ -6,7 +6,6 @@
 use Symfony\Component\DependencyInjection\Tests\Fixtures\Prototype;
 
 return function (ContainerConfigurator $c) {
-
     $s = $c->services();
     $s->instanceof(Prototype\Foo::class)
         ->property('p', 0)
@@ -20,5 +19,4 @@
     $s->load(Prototype::class.'\\', '../Prototype')->exclude('../Prototype/*/*');
 
     $s->set('foo', FooService::class);
-
 };
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Fixtures/config/php7.php b/src/Symfony/Component/DependencyInjection/Tests/Fixtures/config/php7.php
@@ -5,7 +5,6 @@
 use Symfony\Component\DependencyInjection\Tests\Fixtures\Prototype\Foo;
 
 return function (ContainerConfigurator $c) {
-
     $c->parameters()
         ('foo', 'Foo')
         ('bar', 'Bar')
@@ -17,5 +16,4 @@
         ('bar', Foo::class)
             ->call('setFoo')
     ;
-
 };
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Fixtures/config/prototype.php b/src/Symfony/Component/DependencyInjection/Tests/Fixtures/config/prototype.php
@@ -5,7 +5,6 @@
 use Symfony\Component\DependencyInjection\Tests\Fixtures\Prototype;
 
 return function (ContainerConfigurator $c) {
-
     $di = $c->services()->defaults()
         ->tag('baz');
     $di->load(Prototype::class.'\\', '../Prototype')
@@ -20,5 +19,4 @@
         ->parent('foo');
     $di->set('foo')->lazy()->abstract();
     $di->get(Prototype\Foo::class)->lazy(false);
-
 };
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Fixtures/config/services9.php b/src/Symfony/Component/DependencyInjection/Tests/Fixtures/config/services9.php
@@ -9,7 +9,6 @@
 require_once __DIR__.'/../includes/foo.php';
 
 return function (ContainerConfigurator $c) {
-
     $p = $c->parameters();
     $p->set('baz_class', 'BazClass');
     $p->set('foo_class', FooClass::class)
@@ -119,4 +118,11 @@
     $s->set('lazy_context_ignore_invalid_ref', 'LazyContext')
         ->args(array(iterator(array(ref('foo.baz'), ref('invalid')->ignoreOnInvalid())), iterator(array())));
 
+    $s->set('tagged_iterator_foo', 'Bar')
+        ->private()
+        ->tag('foo');
+
+    $s->set('tagged_iterator', 'Bar')
+        ->public()
+        ->args(array(tagged('foo')));
 };
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Fixtures/containers/container9.php b/src/Symfony/Component/DependencyInjection/Tests/Fixtures/containers/container9.php
@@ -4,6 +4,7 @@
 require_once __DIR__.'/../includes/foo.php';
 
 use Symfony\Component\DependencyInjection\Argument\IteratorArgument;
+use Symfony\Component\DependencyInjection\Argument\TaggedIteratorArgument;
 use Symfony\Component\DependencyInjection\ContainerInterface;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Reference;
@@ -161,5 +162,15 @@
     ->setArguments(array(new IteratorArgument(array(new Reference('foo.baz'), new Reference('invalid', ContainerInterface::IGNORE_ON_INVALID_REFERENCE))), new IteratorArgument(array())))
     ->setPublic(true)
 ;
+$container
+    ->register('tagged_iterator_foo', 'Bar')
+    ->addTag('foo')
+    ->setPublic(false)
+;
+$container
+    ->register('tagged_iterator', 'Bar')
+    ->addArgument(new TaggedIteratorArgument('foo'))
+    ->setPublic(true)
+;
 
 return $container;
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Fixtures/graphviz/services9.dot b/src/Symfony/Component/DependencyInjection/Tests/Fixtures/graphviz/services9.dot
@@ -29,6 +29,8 @@ digraph sc {
   node_factory_service_simple [label="factory_service_simple\nBar\n", shape=record, fillcolor="#eeeeee", style="filled"];
   node_lazy_context [label="lazy_context\nLazyContext\n", shape=record, fillcolor="#eeeeee", style="filled"];
   node_lazy_context_ignore_invalid_ref [label="lazy_context_ignore_invalid_ref\nLazyContext\n", shape=record, fillcolor="#eeeeee", style="filled"];
+  node_tagged_iterator_foo [label="tagged_iterator_foo\nBar\n", shape=record, fillcolor="#eeeeee", style="filled"];
+  node_tagged_iterator [label="tagged_iterator\nBar\n", shape=record, fillcolor="#eeeeee", style="filled"];
   node_foo2 [label="foo2\n\n", shape=record, fillcolor="#ff9999", style="filled"];
   node_foo3 [label="foo3\n\n", shape=record, fillcolor="#ff9999", style="filled"];
   node_foobaz [label="foobaz\n\n", shape=record, fillcolor="#ff9999", style="filled"];