MessageListener
in package
implements
EventSubscriberInterface
Manipulates the headers and the body of a Message.
Tags
Table of Contents
Interfaces
- EventSubscriberInterface
- An EventSubscriber knows itself what events it is interested in.
Constants
- DEFAULT_RULES = ['from' => self::HEADER_SET_IF_EMPTY, 'return-path' => self::HEADER_SET_IF_EMPTY, 'reply-to' => self::HEADER_ADD, 'to' => self::HEADER_SET_IF_EMPTY, 'cc' => self::HEADER_ADD, 'bcc' => self::HEADER_ADD]
- HEADER_ADD = 2
- HEADER_REPLACE = 3
- HEADER_SET_IF_EMPTY = 1
Properties
- $headerRules : mixed
- $headers : mixed
- $renderer : mixed
Methods
- __construct() : mixed
- addHeaderRule() : void
- 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
- renderMessage() : void
- setHeaders() : void
Constants
DEFAULT_RULES
public
mixed
DEFAULT_RULES
= ['from' => self::HEADER_SET_IF_EMPTY, 'return-path' => self::HEADER_SET_IF_EMPTY, 'reply-to' => self::HEADER_ADD, 'to' => self::HEADER_SET_IF_EMPTY, 'cc' => self::HEADER_ADD, 'bcc' => self::HEADER_ADD]
HEADER_ADD
public
mixed
HEADER_ADD
= 2
HEADER_REPLACE
public
mixed
HEADER_REPLACE
= 3
HEADER_SET_IF_EMPTY
public
mixed
HEADER_SET_IF_EMPTY
= 1
Properties
$headerRules
private
mixed
$headerRules
= []
$headers
private
mixed
$headers
$renderer
private
mixed
$renderer
Methods
__construct()
public
__construct([Headers|null $headers = null ][, BodyRendererInterface|null $renderer = null ][, array<string|int, mixed> $headerRules = self::DEFAULT_RULES ]) : mixed
Parameters
- $headers : Headers|null = null
- $renderer : BodyRendererInterface|null = null
- $headerRules : array<string|int, mixed> = self::DEFAULT_RULES
addHeaderRule()
public
addHeaderRule(string $headerName, int $rule) : void
Parameters
- $headerName : string
- $rule : int
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
renderMessage()
private
renderMessage(Message $message) : void
Parameters
- $message : Message
setHeaders()
private
setHeaders(Message $message) : void
Parameters
- $message : Message