Using Events

The Transport` class of the Notifier component allows you to optionally hook into the lifecycle via events.

Notifier コンポーネントの Transport` クラスを使用すると、オプションでイベントを介してライフサイクルにフックできます。

The MessageEvent::class Event

Typical Purposes: Doing something before the message is send (like logging which message is going to be send, or displaying something about the event to be executed.

典型的な目的: メッセージが送信される前に何かを行うこと (送信されるメッセージをログに記録する、実行されるイベントに関する何かを表示するなど)。

Just before send the message, the event class MessageEvent is dispatched. Listeners receive a MessageEvent event:

メッセージを送信する直前に、イベント クラス MessageEvent が送出されます。リスナーは MessageEvent イベントを受け取ります。
1
2
3
4
5
6
7
8
9
 
use Symfony\Component\Notifier\Event\MessageEvent;

$dispatcher->addListener(MessageEvent::class, function (MessageEvent $event) {
    // gets the message instance
    $message = $event->getMessage();

    // log something
    $this->logger(sprintf('Message with subject: %s will be send to %s, $message->getSubject(), $message->getRecipientId()'));
});

The FailedMessageEvent Event

Typical Purposes: Doing something before the exception is thrown (Retry to send the message or log additional information).

一般的な目的: 例外がスローされる前に何かを行う (メッセージの送信を再試行するか、追加情報をログに記録する)。

Whenever an exception is thrown while sending the message, the event class FailedMessageEvent is dispatched. A listener can do anything useful before the exception is thrown.

メッセージの送信中に例外がスローされるたびに、イベント クラス FailedMessageEvent が送出されます。リスナーは、例外がスローされる前に便利なことを何でも実行できます。

Listeners receive a FailedMessageEvent event:

リスナーは、FailedMessageEvent イベントを受け取ります。
1
2
3
4
5
6
7
8
9
10
11
12
 
use Symfony\Component\Notifier\Event\FailedMessageEvent;

$dispatcher->addListener(FailedMessageEvent::class, function (FailedMessageEvent $event) {
    // gets the message instance
    $message = $event->getMessage();

    // gets the error instance
    $error = $event->getError();

    // log something
    $this->logger(sprintf('The message with subject: %s has not been sent successfully. The error is: %s, $message->getSubject(), $error->getMessage()'));
});

The SentMessageEvent Event

Typical Purposes: To perform some action when the message is successfully sent (like retrieve the id returned when the message is sent).

一般的な目的: メッセージが正常に送信されたときに何らかのアクションを実行するため (メッセージの送信時に返された ID を取得するなど)。

After the message has been successfully sent, the event class SentMessageEvent is dispatched. Listeners receive a SentMessageEvent event:

メッセージが正常に送信された後、イベント クラス SentMessageEvent が送出されます。リスナーは SentMessageEvent イベントを受け取ります。
1
2
3
4
5
6
7
8
9
 
use Symfony\Component\Notifier\Event\SentMessageEvent;

$dispatcher->addListener(SentMessageEvent::class, function (SentMessageEvent $event) {
    // gets the message instance
    $message = $event->getOriginalMessage();

    // log something
    $this->logger(sprintf('The message has been successfully sent and have id: %s, $message->getMessageId()'));
});