Skip to content

[Messenger] Minor tweaks for the main Messenger article #12806

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 1 commit into from
Dec 14, 2019
Merged

[Messenger] Minor tweaks for the main Messenger article #12806

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
17 changes: 9 additions & 8 deletions messenger.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,9 +50,10 @@ serialized::

.. _messenger-handler:

A message handler is a PHP callable, the recommended way to create it is to create a class that
implements ``MessageHandlerInterface`` and has an ``__invoke()`` method that's
type-hinted with the message class (or a message interface)::
A message handler is a PHP callable, the recommended way to create it is to
create a class that implements :class:`Symfony\\Component\\Messenger\\Handler\\MessageHandlerInterface`
and has an ``__invoke()`` method that's type-hinted with the message class (or a
message interface)::

// src/MessageHandler/SmsNotificationHandler.php
namespace App\MessageHandler;
Expand Down Expand Up @@ -111,7 +112,7 @@ Transports: Async/Queued Messages
By default, messages are handled as soon as they are dispatched. If you want
to handle a message asynchronously, you can configure a transport. A transport
is capable of sending messages (e.g. to a queueing system) and then
:ref:`receiving them via a worker<messenger-worker>`. Messenger supports
:ref:`receiving them via a worker <messenger-worker>`. Messenger supports
:ref:`multiple transports <messenger-transports-config>`.

.. note::
Expand Down Expand Up @@ -503,7 +504,7 @@ different messages to them. For example:
# queue_name is specific to the doctrine transport
queue_name: high

# for amqp send to a separate exchange then queue
# for AMQP send to a separate exchange then queue
#exchange:
# name: high
#queues:
Expand Down Expand Up @@ -1240,7 +1241,7 @@ Envelopes & Stamps
~~~~~~~~~~~~~~~~~~

A message can be any PHP object. Sometimes, you may need to configure something
extra about the message - like the way it should be handled inside Amqp or adding
extra about the message - like the way it should be handled inside AMQP or adding
a delay before the message should be handled. You can do that by adding a "stamp"
to your message::

Expand Down Expand Up @@ -1294,8 +1295,8 @@ for each bus looks like this:

.. note::

These middleware names are actually shortcuts names. The real service ids
are prefixed with ``messenger.middleware.``.
These middleware names are actually shortcut names. The real service ids
are prefixed with ``messenger.middleware.`` (e.g. ``messenger.middleware.handle_message``).

The middleware are executed when the message is dispatched but *also* again when
a message is received via the worker (for messages that were sent to a transport
Expand Down