Documentation

Event
in package
implements StoppableEventInterface

Event is the 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.

Tags
author

Guilherme Blanco guilhermeblanco@hotmail.com

author

Jonathan Wage jonwage@gmail.com

author

Roman Borschel roman@code-factory.org

author

Bernhard Schussek bschussek@gmail.com

author

Nicolas Grekas p@tchwork.com

Interfaces, Classes and Traits

StoppableEventInterface
An Event whose processing may be interrupted when the event has been handled.

Table of Contents

$propagationStopped  : mixed
isPropagationStopped()  : bool
Is propagation stopped?
stopPropagation()  : void
Stops the propagation of the event to further event listeners.

Properties

$propagationStopped

private mixed $propagationStopped = false

Methods

isPropagationStopped()

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.

stopPropagation()

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().

Return values
void

Search results