Skip to content

Symfony Messenger component documentation #9437

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 15 commits into from
Apr 16, 2018
Merged

Symfony Messenger component documentation #9437

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
585491d
Move the documentation from the main PR to RST format.
sroze Mar 14, 2018
b40bc71
Fixed the RST syntax issues
javiereguiluz Mar 18, 2018
b26de80
minor doc fixes for the Message component
wiese Mar 23, 2018
88ba8fe
Merge pull request #1 from wiese/patch-3
sroze Mar 23, 2018
5c828e4
Update the documentation a bit, and add more FrameworkBundle document…
sroze Mar 27, 2018
31a56ee
Uses `::` to display as code blocks
sroze Mar 27, 2018
2493c90
Update typos and missing reference
sroze Mar 27, 2018
bcfae23
Finish the documentation about the custom adapter
sroze Mar 27, 2018
25c0b6e
It helps multiple applications
sroze Mar 27, 2018
a15752b
Fix unresolved reference
sroze Mar 27, 2018
fb88abc
Add Messenger in the topics
sroze Mar 27, 2018
509e149
Add a documentation about middlewares and update based on reviews
sroze Mar 27, 2018
3fb973c
Update based on comments
sroze Mar 29, 2018
32403ea
Update the documentation to reflect the latest changes
sroze Apr 12, 2018
c5306b8
Minor wording change
sroze Apr 15, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Uses :: to display as code blocks
  • Loading branch information
@sroze
sroze committed Mar 27, 2018
commit 31a56ee081c24985e74af7b6c7abcb6f9d6759aa
4 changes: 2 additions & 2 deletions components/messenger.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ following middlewares are configured for you:
#. ``SendMessageMiddleware`` (enables asynchronous processing)
#. ``HandleMessageMiddleware`` (calls the registered handle)

Example:
Example::

use App\Message\MyMessage;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more. 

-  use Symfony\Component\Messenger\MessageBus;
-  use Symfony\Component\Messenger\HandlerLocator;
-  use Symfony\Component\Messenger\Middleware\HandleMessageMiddleware;
-
-    use App\Message\MyMessage;
+    use App\Message\MyMessage;
+    use Symfony\Component\Messenger\MessageBus;
+    use Symfony\Component\Messenger\HandlerLocator;
+    use Symfony\Component\Messenger\Middleware\HandleMessageMiddleware;

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure how it even ended like that 😂 Changed!

use Symfony\Component\Messenger\MessageBus;
Expand All @@ -67,7 +67,7 @@ Handlers
Once dispatched to the bus, messages will be handled by a "message handler". A
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"dispatched" is confusing here: according to the Bus section, the bus is responsible for dispatching messages; and the method used to get a message on to the bus is handle().

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, it's dispatch :)

message handler is a PHP callable (i.e. a function or an instance of a class)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we could add a link to the official doc here:

that will do the required processing for your message. It _might_ return a
result:
result::
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It might return a result

What happens if it does or does not return a result? Does the following example code illustrate something about this statement?


namespace App\MessageHandler;

Expand Down
2 changes: 1 addition & 1 deletion messenger.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Registering Handlers
--------------------

In order to do something when your message is dispatched, you need to create a
message handler. It's a class with an `__invoke` method:
message handler. It's a class with an `__invoke` method::

// src/MessageHandler/MyMessageHandler.php
namespace App\MessageHandler;
Expand Down