minor #13239 Bus restricting with Interfaces (CvekCoding)

This PR was submitted for the 5.0 branch but it was merged into the 4.4 branch instead.

Discussion
----------

Bus restricting with Interfaces

Proposed more flexible way to restrict handlers with buses - use interfaces for this.

<!--

If your pull request fixes a BUG, use the oldest maintained branch that contains
the bug (see https://symfony.com/roadmap for the list of maintained branches).

If your pull request documents a NEW FEATURE, use the same Symfony branch where
the feature was introduced (and `master` for features of unreleased versions).

-->

Commits
-------

d291a99 Bus restricting with Interfaces

Author: wouterj

messenger/multiple_buses.rst

@@ -150,30 +150,30 @@ you can restrict each handler to a specific bus using the ``messenger.message_ha
 This way, the ``App\MessageHandler\SomeCommandHandler`` handler will only be
 known by the ``command.bus`` bus.
 
-You can also automatically add this tag to a number of classes by following
-a naming convention and registering all of the handler services by name with
-the correct tag:
+You can also automatically add this tag to a number of classes by using
+the :ref:`_instanceof service configuration <di-instanceof>`. Using this,
+you can determine the message bus based on an implemented interface:
 
 .. configuration-block::
 
     .. code-block:: yaml
 
         # config/services.yaml
+        services:
+            # ...
+
+            _instanceof:
+                # all services implementing the CommandHandlerInterface
+                # will be registered on the command.bus bus
+                App\MessageHandler\CommandHandlerInterface:
+                    tags:
+                        - { name: messenger.message_handler, bus: command.bus }
 
-        # put this after the "App\" line that registers all your services
-        command_handlers:
-            namespace: App\MessageHandler\
-            resource: '%kernel.project_dir%/src/MessageHandler/*CommandHandler.php'
-            autoconfigure: false
-            tags:
-                - { name: messenger.message_handler, bus: command.bus }
-
-        query_handlers:
-            namespace: App\MessageHandler\
-            resource: '%kernel.project_dir%/src/MessageHandler/*QueryHandler.php'
-            autoconfigure: false
-            tags:
-                - { name: messenger.message_handler, bus: query.bus }
+                # while those implementing QueryHandlerInterface will be
+                # registered on the query.bus bus
+                App\MessageHandler\QueryHandlerInterface:
+                    tags:
+                        - { name: messenger.message_handler, bus: query.bus }
 
     .. code-block:: xml
 
@@ -185,32 +185,45 @@ the correct tag:
                 https://symfony.com/schema/dic/services/services-1.0.xsd">
 
             <services>
-                <!-- command handlers -->
-                <prototype namespace="App\MessageHandler\" resource="%kernel.project_dir%/src/MessageHandler/*CommandHandler.php" autoconfigure="false">
+                <!-- ... -->
+
+                <!-- all services implementing the CommandHandlerInterface
+                     will be registered on the command.bus bus -->
+                <instanceof id="App\MessageHandler\CommandHandlerInterface">
                     <tag name="messenger.message_handler" bus="command.bus"/>
-                </prototype>
-                <!-- query handlers -->
-                <prototype namespace="App\MessageHandler\" resource="%kernel.project_dir%/src/MessageHandler/*QueryHandler.php" autoconfigure="false">
+                </instanceof>
+
+                <!-- while those implementing QueryHandlerInterface will be
+                     registered on the query.bus bus -->
+                <instanceof id="App\MessageHandler\QueryHandlerInterface">
                     <tag name="messenger.message_handler" bus="query.bus"/>
-                </prototype>
+                </instanceof>
             </services>
         </container>
 
     .. code-block:: php
 
         // config/services.php
+        namespace Symfony\Component\DependencyInjection\Loader\Configurator;
 
-        // Command handlers
-        $container->services()
-            ->load('App\MessageHandler\\', '%kernel.project_dir%/src/MessageHandler/*CommandHandler.php')
-            ->autoconfigure(false)
-            ->tag('messenger.message_handler', ['bus' => 'command.bus']);
+        use App\MessageHandler\CommandHandlerInterface;
+        use App\MessageHandler\QueryHandlerInterface;
 
-        // Query handlers
-        $container->services()
-            ->load('App\MessageHandler\\', '%kernel.project_dir%/src/MessageHandler/*QueryHandler.php')
-            ->autoconfigure(false)
-            ->tag('messenger.message_handler', ['bus' => 'query.bus']);
+        return function(ContainerConfigurator $configurator) {
+            $services = $configurator->services();
+
+            // ...
+
+            // all services implementing the CommandHandlerInterface
+            // will be registered on the command.bus bus
+            $services->instanceof(CommandHandlerInterface::class)
+                ->tag('messenger.message_handler', ['bus' => 'command.bus']);
+
+            // while those implementing QueryHandlerInterface will be
+            // registered on the query.bus bus
+            $services->instanceof(QueryHandlerInterface::class)
+                ->tag('messenger.message_handler', ['bus' => 'query.bus']);
+        };
 
 Debugging the Buses
 -------------------

service_container/tags.rst

@@ -60,6 +60,8 @@ and many tags require additional arguments (beyond the ``name`` parameter).
 **For most users, this is all you need to know**. If you want to go further and
 learn how to create your own custom tags, keep reading.
 
+.. _di-instanceof:
+
 Autoconfiguring Tags
 --------------------