MessageListener
in package
implements
EventSubscriberInterface
Manipulates the headers and the body of a Message.
Tags
Interfaces, Classes, Traits and Enums
- EventSubscriberInterface
- An EventSubscriber knows itself what events it is interested in.
Table of Contents
- $headers : mixed
- $renderer : mixed
- __construct() : mixed
- getSubscribedEvents() : array<string, mixed>
- Returns an array of event names this subscriber wants to listen to.
- onMessage() : void
- renderMessage() : void
- setHeaders() : void
Properties
$headers
private
mixed
$headers
$renderer
private
mixed
$renderer
Methods
__construct()
public
__construct([Headers $headers = null ][, BodyRendererInterface $renderer = null ]) : mixed
Parameters
- $headers : Headers = null
- $renderer : BodyRendererInterface = null
Return values
mixed —getSubscribedEvents()
Returns an array of event names this subscriber wants to listen to.
public
static getSubscribedEvents() : array<string, mixed>
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, mixed> —The event names to listen to
onMessage()
public
onMessage(MessageEvent $event) : void
Parameters
- $event : MessageEvent
Return values
void —renderMessage()
private
renderMessage(Message $message) : void
Parameters
- $message : Message
Return values
void —setHeaders()
private
setHeaders(Message $message) : void
Parameters
- $message : Message