Skip to content

Commit a0f6727

Browse files
committed
minor #14374 [Messenger] Update the list of stamp (Nyholm)
This PR was submitted for the 5.x branch but it was squashed and merged into the 4.4 branch instead. Discussion ---------- [Messenger] Update the list of stamp This PR updates the list of stamps. In the current docs it looks like the list of stamps was complete. I think we should just highlight important ones that users will come in contact with. Advanced users will find the rest of the stamps anyways. I sorted the list alphabetically. I added DelayStamp and DispatchAfterCurrentBusStamp Commits ------- 728f89f [Messenger] Update the list of stamp
2 parents 61e30b3 + 728f89f commit a0f6727

File tree

1 file changed

+13
-8
lines changed

1 file changed

+13
-8
lines changed

components/messenger.rst

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -148,21 +148,26 @@ through the transport layer, use the ``SerializerStamp`` stamp::
148148
]))
149149
);
150150

151-
At the moment, the Symfony Messenger has the following built-in envelope stamps:
151+
Here are some important envelope stamps that are shipped with the Symfony Messenger:
152152

153-
#. :class:`Symfony\\Component\\Messenger\\Stamp\\SerializerStamp`,
154-
to configure the serialization groups used by the transport.
155-
#. :class:`Symfony\\Component\\Messenger\\Stamp\\ValidationStamp`,
156-
to configure the validation groups used when the validation middleware is enabled.
153+
#. :class:`Symfony\\Component\\Messenger\\Stamp\\DelayStamp`,
154+
to delay handling of an asynchronous message.
155+
#. :class:`Symfony\\Component\\Messenger\\Stamp\\DispatchAfterCurrentBusStamp`,
156+
to make the message be handled after the current bus has executed. Read more
157+
at :doc:`/messenger/dispatch_after_current_bus`.
158+
#. :class:`Symfony\\Component\\Messenger\\Stamp\\HandledStamp`,
159+
a stamp that marks the message as handled by a specific handler.
160+
Allows accessing the handler returned value and the handler name.
157161
#. :class:`Symfony\\Component\\Messenger\\Stamp\\ReceivedStamp`,
158162
an internal stamp that marks the message as received from a transport.
159163
#. :class:`Symfony\\Component\\Messenger\\Stamp\\SentStamp`,
160164
a stamp that marks the message as sent by a specific sender.
161165
Allows accessing the sender FQCN and the alias if available from the
162166
:class:`Symfony\\Component\\Messenger\\Transport\\Sender\\SendersLocator`.
163-
#. :class:`Symfony\\Component\\Messenger\\Stamp\\HandledStamp`,
164-
a stamp that marks the message as handled by a specific handler.
165-
Allows accessing the handler returned value and the handler name.
167+
#. :class:`Symfony\\Component\\Messenger\\Stamp\\SerializerStamp`,
168+
to configure the serialization groups used by the transport.
169+
#. :class:`Symfony\\Component\\Messenger\\Stamp\\ValidationStamp`,
170+
to configure the validation groups used when the validation middleware is enabled.
166171

167172
Instead of dealing directly with the messages in the middleware you receive the envelope.
168173
Hence you can inspect the envelope content and its stamps, or add any::

0 commit comments

Comments
 (0)