DocumentRenderedEvent
extends AbstractEvent
in package
FinalYes
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
Properties
Methods
- __construct() : mixed
- getOutput() : RenderedContentInterface
- isPropagationStopped() : bool
- Returns whether further event listeners should be triggered.
- replaceOutput() : void
- stopPropagation() : void
- Stops the propagation of the event to further event listeners.
Properties
$output
private
RenderedContentInterface
$output
Methods
__construct()
public
__construct(RenderedContentInterface $output) : mixed
Parameters
- $output : RenderedContentInterface
getOutput()
public
getOutput() : RenderedContentInterface
Tags
Return values
RenderedContentInterfaceisPropagationStopped()
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.
replaceOutput()
public
replaceOutput(RenderedContentInterface $output) : void
Parameters
- $output : RenderedContentInterface
Tags
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().