minor #10476 Add autoconfiguration note for MessageHandlers (Steveb-p)

javiereguiluz · javiereguiluz · commit 2d35174f81ab · 2018-10-16T16:52:12.000+02:00
This PR was squashed before being merged into the 4.1 branch (closes #10476). Discussion ---------- Add autoconfiguration note for MessageHandlers This pull request adds a note regarding MessageHandlerInterface causing handlers to automatically register themselves as one. Commits ------- 957b691 Add autoconfiguration note for MessageHandlers
diff --git a/messenger.rst b/messenger.rst
@@ -48,16 +48,23 @@ message handler. It's a class with an ``__invoke`` method::
 
     // src/MessageHandler/MyMessageHandler.php
     namespace App\MessageHandler;
+    
+    use Symfony\Component\Messenger\Handler;
 
-    class MyMessageHandler
+    class MyMessageHandler implements MessageHandlerInterface
     {
         public function __invoke(MyMessage $message)
         {
             // do something with it.
         }
     }
 
-Once you've created your handler, you need to register it:
+Message handlers must be registered as services and :doc:`tagged </service_container/tags>`
+with the ``messenger.message_handler`` tag. If you're using the
+:ref:`default services.yaml configuration <service-container-services-load-example>`,
+this is already done for you, thanks to :ref:`autoconfiguration <services-autoconfigure>`.
+
+If you're not using autoconfigure functionality, then you need to register it:
 
 .. configuration-block::
 

Original file line number	Diff line number	Diff line change
@@ -48,16 +48,23 @@ message handler. It's a class with an ``__invoke`` method::
`48`	`48`
`49`	`49`	`// src/MessageHandler/MyMessageHandler.php`
`50`	`50`	`namespace App\MessageHandler;`
	`51`	`+`
	`52`	`+ use Symfony\Component\Messenger\Handler;`
`51`	`53`
`52`		`- class MyMessageHandler`
	`54`	`+ class MyMessageHandler implements MessageHandlerInterface`
`53`	`55`	`{`
`54`	`56`	`public function __invoke(MyMessage $message)`
`55`	`57`	`{`
`56`	`58`	`// do something with it.`
`57`	`59`	`}`
`58`	`60`	`}`
`59`	`61`
`60`		`-Once you've created your handler, you need to register it:`
	`62`	+Message handlers must be registered as services and :doc:`tagged </service_container/tags>`
	`63`	+with the ``messenger.message_handler`` tag. If you're using the
	`64`	+:ref:`default services.yaml configuration <service-container-services-load-example>`,
	`65`	+this is already done for you, thanks to :ref:`autoconfiguration <services-autoconfigure>`.
	`66`	`+`
	`67`	`+If you're not using autoconfigure functionality, then you need to register it:`
`61`	`68`
`62`	`69`	`.. configuration-block::`
`63`	`70`