AbstractEvent
in package
implements
StoppableEventInterface
AbstractYes
Base class for classes containing event data.
This class contains no event data. It is used by events that do not pass state information to an event handler when an event is raised.
You can call the method stopPropagation() to abort the execution of further listeners in your event listener.
Table of Contents
Interfaces
- StoppableEventInterface
- An Event whose processing may be interrupted when the event has been handled.
Properties
- $propagationStopped : bool
Methods
- isPropagationStopped() : bool
- Returns whether further event listeners should be triggered.
- stopPropagation() : void
- Stops the propagation of the event to further event listeners.
Properties
$propagationStopped
private
bool
$propagationStopped
= false
Tags
Methods
isPropagationStopped()
Returns whether further event listeners should be triggered.
public
final isPropagationStopped() : bool
Return values
bool —True if the Event is complete and no further listeners should be called. False to continue calling listeners.
stopPropagation()
Stops the propagation of the event to further event listeners.
public
final stopPropagation() : void
If multiple event listeners are connected to the same event, no further event listener will be triggered once any trigger calls stopPropagation().