[DI] deprecates tag tagged in favor of tagged_iterator

jschaedl · jschaedl · commit fad0d1170497 · 2019-04-30T11:14:14.000+02:00
diff --git a/src/Symfony/Component/DependencyInjection/CHANGELOG.md b/src/Symfony/Component/DependencyInjection/CHANGELOG.md
@@ -16,7 +16,8 @@ CHANGELOG
  * made `ServiceLocator` implement `ServiceProviderInterface`
  * deprecated support for non-string default env() parameters
  * added `%env(require:...)%` processor to `require()` a PHP file and use the value returned from it
-
+ * deprecated tag `tagged` in favour of `tagged_iterator`
+ 
 4.2.0
 -----
 
diff --git a/src/Symfony/Component/DependencyInjection/Dumper/XmlDumper.php b/src/Symfony/Component/DependencyInjection/Dumper/XmlDumper.php
@@ -287,7 +287,7 @@ private function convertParameters(array $parameters, $type, \DOMElement $parent
                 $element->setAttribute('type', 'collection');
                 $this->convertParameters($value, $type, $element, 'key');
             } elseif ($value instanceof TaggedIteratorArgument || ($value instanceof ServiceLocatorArgument && $tag = $value->getTaggedIteratorArgument())) {
-                $element->setAttribute('type', $value instanceof TaggedIteratorArgument ? 'tagged' : 'tagged_locator');
+                $element->setAttribute('type', $value instanceof TaggedIteratorArgument ? 'tagged_iterator' : 'tagged_locator');
                 $element->setAttribute('tag', $tag->getTag());
 
                 if (null !== $tag->getIndexAttribute()) {
diff --git a/src/Symfony/Component/DependencyInjection/Dumper/YamlDumper.php b/src/Symfony/Component/DependencyInjection/Dumper/YamlDumper.php
@@ -248,7 +248,7 @@ private function dumpValue($value)
                     }
                 }
 
-                return new TaggedValue($value instanceof TaggedIteratorArgument ? 'tagged' : 'tagged_locator', $content);
+                return new TaggedValue($value instanceof TaggedIteratorArgument ? 'tagged_iterator' : 'tagged_locator', $content);
             }
 
             if ($value instanceof IteratorArgument) {
diff --git a/src/Symfony/Component/DependencyInjection/Loader/Configurator/ContainerConfigurator.php b/src/Symfony/Component/DependencyInjection/Loader/Configurator/ContainerConfigurator.php
@@ -117,6 +117,16 @@ function iterator(array $values): IteratorArgument
  * Creates a lazy iterator by tag name.
  */
 function tagged(string $tag, string $indexAttribute = null, string $defaultIndexMethod = null): TaggedIteratorArgument
+{
+    @trigger_error('"tagged" tag is deprecated and will be removed in Symfony 5. Please use "tagged_iterator"', E_USER_DEPRECATED);
+
+    return new TaggedIteratorArgument($tag, $indexAttribute, $defaultIndexMethod);
+}
+
+/**
+ * Creates a lazy iterator by tag name.
+ */
+function tagged_iterator(string $tag, string $indexAttribute = null, string $defaultIndexMethod = null): TaggedIteratorArgument
 {
     return new TaggedIteratorArgument($tag, $indexAttribute, $defaultIndexMethod);
 }
diff --git a/src/Symfony/Component/DependencyInjection/Loader/XmlFileLoader.php b/src/Symfony/Component/DependencyInjection/Loader/XmlFileLoader.php
@@ -545,8 +545,14 @@ private function getArgumentsAsPhp(\DOMElement $node, $name, $file, $lowercase =
                     }
                     break;
                 case 'tagged':
+                case 'tagged_iterator':
                 case 'tagged_locator':
                     $type = $arg->getAttribute('type');
+
+                    if ('tagged' === $type) {
+                        @trigger_error(sprintf('Type "%s" of Tag <%s> in "%s" is deprecated and will be removed in Symfony 5. Please use "tagged_iterator"', $type, $name, $file), E_USER_DEPRECATED);
+                    }
+
                     $forLocator = 'tagged_locator' === $type;
 
                     if (!$arg->getAttribute('tag')) {
diff --git a/src/Symfony/Component/DependencyInjection/Loader/YamlFileLoader.php b/src/Symfony/Component/DependencyInjection/Loader/YamlFileLoader.php
@@ -724,7 +724,11 @@ private function resolveServices($value, $file, $isParameter = false)
                     throw new InvalidArgumentException(sprintf('"!service_locator" tag only accepts maps of "@service" references in "%s".', $file));
                 }
             }
-            if (\in_array($value->getTag(), ['tagged', 'tagged_locator'], true)) {
+            if (\in_array($value->getTag(), ['tagged', 'tagged_iterator', 'tagged_locator'], true)) {
+                if ('tagged' === $value->getTag()) {
+                    @trigger_error('"!tagged" tag is deprecated and will be removed in Symfony 5. Please use "!tagged_iterator"', E_USER_DEPRECATED);
+                }
+
                 $forLocator = 'tagged_locator' === $value->getTag();
 
                 if (\is_string($argument) && $argument) {
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
@@ -265,6 +265,7 @@
       <xsd:enumeration value="iterator" />
       <xsd:enumeration value="service_locator" />
       <xsd:enumeration value="tagged" />
+      <xsd:enumeration value="tagged_iterator" />
       <xsd:enumeration value="tagged_locator" />
     </xsd:restriction>
   </xsd:simpleType>
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Fixtures/config/anonymous.expected.yml b/src/Symfony/Component/DependencyInjection/Tests/Fixtures/config/anonymous.expected.yml
@@ -7,7 +7,7 @@ services:
     listener_aggregator:
         class: Bar\FooClass
         public: true
-        arguments: [!tagged listener]
+        arguments: [!tagged_iterator listener]
     .2_stdClass~%s:
         class: stdClass
         public: false
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Fixtures/config/services9.php b/src/Symfony/Component/DependencyInjection/Tests/Fixtures/config/services9.php
@@ -128,7 +128,7 @@
 
     $s->set('tagged_iterator', 'Bar')
         ->public()
-        ->args([tagged('foo')]);
+        ->args([tagged_iterator('foo')]);
 
     $s->set('runtime_error', 'stdClass')
         ->args([new Reference('errored_definition', ContainerInterface::RUNTIME_EXCEPTION_ON_INVALID_REFERENCE)])
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Fixtures/xml/services9.xml b/src/Symfony/Component/DependencyInjection/Tests/Fixtures/xml/services9.xml
@@ -142,7 +142,7 @@
       <tag name="foo"/>
     </service>
     <service id="tagged_iterator" class="Bar" public="true">
-      <argument type="tagged" tag="foo"/>
+      <argument type="tagged_iterator" tag="foo"/>
     </service>
     <service id="runtime_error" class="stdClass" public="true">
       <argument type="service" id="errored_definition"/>
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Fixtures/xml/services_with_tagged_arguments.xml b/src/Symfony/Component/DependencyInjection/Tests/Fixtures/xml/services_with_tagged_arguments.xml
@@ -6,7 +6,7 @@
       <tag name="foo_tag"/>
     </service>
     <service id="foo_tagged_iterator" class="Bar" public="true">
-      <argument type="tagged" tag="foo_tag" index-by="barfoo" default-index-method="foobar"/>
+      <argument type="tagged_iterator" tag="foo_tag" index-by="barfoo" default-index-method="foobar"/>
     </service>
     <service id="foo_tagged_locator" class="Bar" public="true">
       <argument type="tagged_locator" tag="foo_tag" index-by="barfoo" default-index-method="foobar"/>
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Fixtures/yaml/service_instanceof_factory.yml b/src/Symfony/Component/DependencyInjection/Tests/Fixtures/yaml/service_instanceof_factory.yml
@@ -8,7 +8,7 @@ services:
         public: true
 
     Symfony\Component\DependencyInjection\Tests\Fixtures\BarFactory:
-        arguments: [!tagged 'bar']
+        arguments: [!tagged_iterator 'bar']
 
     Symfony\Component\DependencyInjection\Tests\Fixtures\BarInterface:
         factory: ['@Symfony\Component\DependencyInjection\Tests\Fixtures\BarFactory', 'getDefaultBar']
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Fixtures/yaml/services9.yml b/src/Symfony/Component/DependencyInjection/Tests/Fixtures/yaml/services9.yml
@@ -157,7 +157,7 @@ services:
     tagged_iterator:
         class: Bar
         arguments:
-            - !tagged foo
+            - !tagged_iterator foo
         public: true
     Psr\Container\ContainerInterface:
         alias: service_container
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Fixtures/yaml/services_with_tagged_argument.yml b/src/Symfony/Component/DependencyInjection/Tests/Fixtures/yaml/services_with_tagged_argument.yml
@@ -10,7 +10,7 @@ services:
             - { name: foo }
     foo_service_tagged_iterator:
         class: Bar
-        arguments: [!tagged { tag: foo, index_by: barfoo, default_index_method: foobar }]
+        arguments: [!tagged_iterator { tag: foo, index_by: barfoo, default_index_method: foobar }]
     foo_service_tagged_locator:
         class: Bar
         arguments: [!tagged_locator { tag: foo, index_by: barfoo, default_index_method: foobar }]

Original file line number	Diff line number	Diff line change
`@@ -248,7 +248,7 @@ private function dumpValue($value)`
`248`	`248`	`}`
`249`	`249`	`}`
`250`	`250`
`251`		`- return new TaggedValue($value instanceof TaggedIteratorArgument ? 'tagged' : 'tagged_locator', $content);`
	`251`	`+ return new TaggedValue($value instanceof TaggedIteratorArgument ? 'tagged_iterator' : 'tagged_locator', $content);`
`252`	`252`	`}`
`253`	`253`
`254`	`254`	`if ($value instanceof IteratorArgument) {`
Original file line number	Diff line number	Diff line change
`@@ -724,7 +724,11 @@ private function resolveServices($value, $file, $isParameter = false)`
`724`	`724`	`throw new InvalidArgumentException(sprintf('"!service_locator" tag only accepts maps of "@service" references in "%s".', $file));`
`725`	`725`	`}`
`726`	`726`	`}`
`727`		`- if (\in_array($value->getTag(), ['tagged', 'tagged_locator'], true)) {`
	`727`	`+ if (\in_array($value->getTag(), ['tagged', 'tagged_iterator', 'tagged_locator'], true)) {`
	`728`	`+ if ('tagged' === $value->getTag()) {`
	`729`	`+ @trigger_error('"!tagged" tag is deprecated and will be removed in Symfony 5. Please use "!tagged_iterator"', E_USER_DEPRECATED);`
	`730`	`+ }`
	`731`	`+`
`728`	`732`	`$forLocator = 'tagged_locator' === $value->getTag();`
`729`	`733`
`730`	`734`	`if (\is_string($argument) && $argument) {`