[Messenger] HandlerArgumentsStamp #17174
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
fabpot
added a commit
to symfony/symfony
that referenced
this pull request
Aug 14, 2022
This PR was merged into the 6.2 branch. Discussion ---------- [Messenger] Add HandlerArgumentsStamp | Q | A | ------------- | --- | Branch? | 6.2 | Bug fix? | no | New feature? | yes | Deprecations? | no | Tickets | Fix #31075 | License | MIT | Doc PR | symfony/symfony-docs#17174 As discussed in #31075 sometimes it's desirable for the messenger handler to receive additional argument than just the message itself. I understand the voiced concerns about passing the entire envelope but instead of that we could use the approach from this PR which doesn't add any additional arguments by default but is actually even more powerful since it gives the user full control what should be sent to the handler if desired. This is just a prototype of course. With #45377 in mind I used a readonly property from PHP 8.1 but of course such details can be easily adjusted. Let me know if such feature is wanted in Symfony. If yes then I'll add tests and a doc PR. Commits ------- d081267 Add HandlerArgumentsStamp
|
Can you please add an example of code? I think it also need a note to say that it was added since Symfony 6.2. |
|
friendly ping @enumag |
|
Code sample and version note added. |
enumag
force-pushed
the
patch-4
branch
5 times, most recently
from
52a946f to
187f63f
Compare
MrYamous
reviewed
Jun 9, 2023
messenger.rst
Outdated
| It's possible to have messenger pass additional data to the message handler using the | ||
| :class:`Symfony\\Component\\Messenger\\Stamp\\HandlerArgumentsStamp`. Add this stamp to | ||
| the envelope in a middleware and fill it with any additional data you want to have | ||
| available in the handler. |
There was a problem hiding this comment.
Suggested change
| available in the handler. | |
| available in the handler:: |
messenger.rst
Outdated
| } | ||
| } | ||
|
|
||
| Then your handler will look like this: |
There was a problem hiding this comment.
Suggested change
| Then your handler will look like this: | |
| Then your handler will look like this:: |
messenger.rst
Outdated
|
|
||
| .. versionadded:: 6.2 | ||
|
|
||
| The HandlerArgumentsStamp was introduced in Symfony 6.2. |
There was a problem hiding this comment.
Suggested change
| The HandlerArgumentsStamp was introduced in Symfony 6.2. | |
| The :class:`Symfony\\Component\\Messenger\\Stamp\\HandlerArgumentsStamp` was introduced in Symfony 6.2. |
OskarStark
approved these changes
Aug 14, 2023
|
It took time, but here we go, this is in now. Thank you very much Jáchym. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Refs