-
-
Notifications
You must be signed in to change notification settings - Fork 5.2k
[Messenger] Autoconfigurable attributes #15990
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.
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
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -51,17 +51,19 @@ serialized:: | |
.. _messenger-handler: | ||
|
||
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):: | ||
create a class using :class:`Symfony\\Component\\Messenger\\Attribute\\AsMessageHandler` | ||
attribute which has an ``__invoke()`` method that's type-hinted with the | ||
wouterj marked this conversation as resolved.
Show resolved
Hide resolved
|
||
message class (or a message interface) or you can create a class without the attribute, by implementing | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I'd remove the mention of the interface |
||
:class:`Symfony\\Component\\Messenger\\Handler\\MessageHandlerInterface`:: | ||
|
||
// src/MessageHandler/SmsNotificationHandler.php | ||
namespace App\MessageHandler; | ||
|
||
use App\Message\SmsNotification; | ||
use Symfony\Component\Messenger\Handler\MessageHandlerInterface; | ||
use Symfony\Component\Messenger\Attribute\AsMessageHandler; | ||
|
||
class SmsNotificationHandler implements MessageHandlerInterface | ||
#[AsMessageHandler] | ||
class SmsNotificationHandler | ||
{ | ||
public function __invoke(SmsNotification $message) | ||
{ | ||
|
@@ -349,9 +351,10 @@ Then, in your handler, you can query for a fresh object:: | |
|
||
use App\Message\NewUserWelcomeEmail; | ||
use App\Repository\UserRepository; | ||
use Symfony\Component\Messenger\Handler\MessageHandlerInterface; | ||
use Symfony\Component\Messenger\Attribute\AsMessageHandler; | ||
|
||
class NewUserWelcomeEmailHandler implements MessageHandlerInterface | ||
#[AsMessageHandler] | ||
class NewUserWelcomeEmailHandler | ||
{ | ||
private $userRepository; | ||
|
||
|
@@ -1769,6 +1772,36 @@ Customizing Handlers | |
|
||
.. _messenger-handler-config: | ||
|
||
Configuring Handlers Using Attribute | ||
wouterj marked this conversation as resolved.
Show resolved
Hide resolved
|
||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
||
You can configure your handler easily by passing options to the attribute:: | ||
wouterj marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
// src/MessageHandler/SmsNotificationHandler.php | ||
namespace App\MessageHandler; | ||
|
||
use App\Message\OtherSmsNotification; | ||
use App\Message\SmsNotification; | ||
use Symfony\Component\Messenger\Attribute\AsMessageHandler; | ||
|
||
#[AsMessageHandler(fromTransport: 'async', priority: 10)] | ||
class SmsNotificationHandler | ||
{ | ||
public function __invoke(SmsNotification $message) | ||
{ | ||
// ... | ||
} | ||
} | ||
|
||
|
||
Possible options to configure with the attribute are: | ||
|
||
* ``bus`` | ||
* ``fromTransport`` | ||
* ``handles`` | ||
* ``method`` | ||
* ``priority`` | ||
|
||
Manually Configuring Handlers | ||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
||
|
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.
Uh oh!
There was an error while loading. Please reload this page.