MessageEvent
extends Event
in package
FinalYes
Event is the base class for classes containing event data.
Tags
Table of Contents
Properties
- $message : mixed
- $propagationStopped : bool
- $queued : bool
Methods
- __construct() : mixed
- getMessage() : MessageInterface
- isPropagationStopped() : bool
- Is propagation stopped?
- isQueued() : bool
- stopPropagation() : void
- Stops the propagation of the event to further event listeners.
Properties
$message
private
mixed
$message
$propagationStopped
private
bool
$propagationStopped
= false
$queued
private
bool
$queued
Methods
__construct()
public
__construct(MessageInterface $message[, bool $queued = false ]) : mixed
Parameters
- $message : MessageInterface
- $queued : bool = false
getMessage()
public
getMessage() : MessageInterface
Return values
MessageInterfaceisPropagationStopped()
Is propagation stopped?
public
isPropagationStopped() : bool
Return values
bool —True if the Event is complete and no further listeners should be called. False to continue calling listeners.
isQueued()
public
isQueued() : bool
Return values
boolstopPropagation()
Stops the propagation of the event to further event listeners.
public
stopPropagation() : void
If multiple event listeners are connected to the same event, no further event listener will be triggered once any trigger calls stopPropagation().