EnvelopeListener
in package
implements
EventSubscriberInterface
Manipulates the Envelope of a Message.
Tags
Table of Contents
Interfaces
- EventSubscriberInterface
- An EventSubscriber knows itself what events it is interested in.
Properties
- $recipients : mixed
- $sender : mixed
Methods
- __construct() : mixed
- getSubscribedEvents() : array<string, string|array{0: string, 1: int}|array<int, array{0: string, 1?: int}>>
- Returns an array of event names this subscriber wants to listen to.
- onMessage() : void
Properties
$recipients
private
mixed
$recipients
$sender
private
mixed
$sender
Methods
__construct()
public
__construct([Address|string $sender = null ][, array<string|int, Address|string> $recipients = null ]) : mixed
Parameters
getSubscribedEvents()
Returns an array of event names this subscriber wants to listen to.
public
static getSubscribedEvents() : array<string, string|array{0: string, 1: int}|array<int, array{0: string, 1?: int}>>
The array keys are event names and the value can be:
- The method name to call (priority defaults to 0)
- An array composed of the method name to call and the priority
- An array of arrays composed of the method names to call and respective priorities, or 0 if unset
For instance:
- ['eventName' => 'methodName']
- ['eventName' => ['methodName', $priority]]
- ['eventName' => [['methodName1', $priority], ['methodName2']]]
The code must not depend on runtime state as it will only be called at compile time. All logic depending on runtime state must be put into the individual methods handling the events.
Return values
array<string, string|array{0: string, 1: int}|array<int, array{0: string, 1?: int}>>onMessage()
public
onMessage(MessageEvent $event) : void
Parameters
- $event : MessageEvent