[DependencyInjection] Add method priority for tagged services

alexandrunastase · alexandrunastase · commit 00fda26c5a78 · 2019-11-26T08:45:26.000+01:00
diff --git a/service_container/tags.rst b/service_container/tags.rst
@@ -570,47 +570,92 @@ application handlers::
         }
     }
 
-.. tip::
+Prioritizing tagged services
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The tagged services can be prioritized using the ``priority`` attribute:
+
+.. configuration-block::
+
+    .. code-block:: yaml
+
+        # config/services.yaml
+        services:
+            App\Handler\One:
+                tags:
+                    - { name: 'app.handler', priority: 20 }
+
+    .. code-block:: xml
+
+        <!-- config/services.xml -->
+        <?xml version="1.0" encoding="UTF-8" ?>
+        <container xmlns="http://symfony.com/schema/dic/services"
+            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+            xsi:schemaLocation="http://symfony.com/schema/dic/services
+                https://symfony.com/schema/dic/services/services-1.0.xsd">
+
+            <services>
+                <service id="App\Handler\One">
+                    <tag name="app.handler" priority="20"/>
+                </service>
+            </services>
+        </container>
+
+    .. code-block:: php
+
+        // config/services.php
+        $container->register(App\Handler\One::class)
+            ->addTag('app.handler', ['priority' => 20]);
 
-    The collected services can be prioritized using the ``priority`` attribute:
+Note that any other custom attributes will be ignored by this feature.
 
-    .. configuration-block::
 
-        .. code-block:: yaml
+Another option, which is particularly useful when using autoconfiguring tags, is to implement the ``getDefaultPriority`` static method on a collected class::
 
-            # config/services.yaml
-            services:
-                App\Handler\One:
-                    tags:
-                        - { name: 'app.handler', priority: 20 }
+    // src/App/Handler/One.php
+    namespace App/Handler;
 
-        .. code-block:: xml
+    class One
+    {
+        public static function getDefaultPriority(): int
+        {
+            return 3;
+        }
+    }
 
-            <!-- config/services.xml -->
-            <?xml version="1.0" encoding="UTF-8" ?>
-            <container xmlns="http://symfony.com/schema/dic/services"
-                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-                xsi:schemaLocation="http://symfony.com/schema/dic/services
-                    https://symfony.com/schema/dic/services/services-1.0.xsd">
+If you want to have another method defining the priority, can define it in the configuration of the collecting service:
 
-                <services>
-                    <service id="App\Handler\One">
-                        <tag name="app.handler" priority="20"/>
-                    </service>
-                </services>
-            </container>
+.. configuration-block::
 
-        .. code-block:: php
+    .. code-block:: yaml
 
-            // config/services.php
-            namespace Symfony\Component\DependencyInjection\Loader\Configurator;
+        # config/services.yaml
+        services:
+            App\HandlerCollection:
+                # inject all services tagged with app.handler as first argument
+                arguments:
+                    - !tagged_iterator { tag: app.handler, default_priority_method: getPriority }
 
-            return function(ContainerConfigurator $configurator) {
-                $services = $configurator->services();
+    .. code-block:: xml
 
-                $services->set(App\Handler\One::class)
-                    ->tag('app.handler', ['priority' => 20])
-                ;
-            };
+        <!-- config/services.xml -->
+        <?xml version="1.0" encoding="UTF-8" ?>
+        <container xmlns="http://symfony.com/schema/dic/services"
+            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+            xsi:schemaLocation="http://symfony.com/schema/dic/services
+                https://symfony.com/schema/dic/services/services-1.0.xsd">
+
+            <services>
+                <service id="App\HandlerCollection">
+                    <argument type="tagged" tag="app.handler" default_priority_method="getPriority"/>
+                </service>
+            </services>
+        </container>
+
+    .. code-block:: php
+
+        // config/services.php
+        use Symfony\Component\DependencyInjection\Argument\TaggedIteratorArgument;
 
-    Note that any other custom attributes will be ignored by this feature.
+        $container->register(App\HandlerCollection::class)
+            ->addArgument(new TaggedIteratorArgument('app.handler', null, null, false, 'getPriority'));
