Skip to content

Commit 5955fd4

Browse files
committed
minor #19120 [Messenger] Improve handler options description (makmaoui)
This PR was merged into the 6.3 branch. Discussion ---------- [Messenger] Improve handler options description <!-- If your pull request fixes a BUG, use the oldest maintained branch that contains the bug (see https://symfony.com/releases 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 `6.x` for features of unreleased versions). --> Commits ------- f5e530b Improve handler options description
2 parents 31c233c + f5e530b commit 5955fd4

File tree

1 file changed

+20
-10
lines changed

1 file changed

+20
-10
lines changed

messenger.rst

Lines changed: 20 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2016,11 +2016,16 @@ You can configure your handler by passing options to the attribute::
20162016

20172017
Possible options to configure with the attribute are:
20182018

2019-
* ``bus``
2020-
* ``fromTransport``
2021-
* ``handles``
2022-
* ``method``
2023-
* ``priority``
2019+
============================ ====================================================================================================
2020+
Option Description
2021+
============================ ====================================================================================================
2022+
``bus`` Name of the bus from which the handler can receive messages, by default all buses.
2023+
``fromTransport`` Name of the transport from which the handler can receive messages, by default all transports.
2024+
``handles`` Type of messages (FQCN) that can be processed by the handler, only needed if can't be guessed by
2025+
type-hint.
2026+
``method`` Name of the method that will process the message, only if the target is a class.
2027+
``priority`` Priority of the handler when multiple handlers can process the same message.
2028+
============================ ====================================================================================================
20242029

20252030
.. _messenger-handler-config:
20262031

@@ -2079,11 +2084,16 @@ by tagging the handler service with ``messenger.message_handler``
20792084
20802085
Possible options to configure with tags are:
20812086

2082-
* ``bus``
2083-
* ``from_transport``
2084-
* ``handles``
2085-
* ``method``
2086-
* ``priority``
2087+
============================ ====================================================================================================
2088+
Option Description
2089+
============================ ====================================================================================================
2090+
``bus`` Name of the bus from which the handler can receive messages, by default all buses.
2091+
``from_transport`` Name of the transport from which the handler can receive messages, by default all transports.
2092+
``handles`` Type of messages (FQCN) that can be processed by the handler, only needed if can't be guessed by
2093+
type-hint.
2094+
``method`` Name of the method that will process the message.
2095+
``priority`` Priority of the handler when multiple handlers can process the same message.
2096+
============================ ====================================================================================================
20872097

20882098
.. _handler-subscriber-options:
20892099

0 commit comments

Comments
 (0)