DocumentPreRenderEvent
extends AbstractEvent
in package
FinalYes
Event dispatched just before rendering begins
Table of Contents
Properties
Methods
- __construct() : mixed
- getDocument() : Document
- getFormat() : string
- isPropagationStopped() : bool
- Returns whether further event listeners should be triggered.
- stopPropagation() : void
- Stops the propagation of the event to further event listeners.
Properties
$document
private
Document
$document
Tags
$format
private
string
$format
Tags
Methods
__construct()
public
__construct(Document $document, string $format) : mixed
Parameters
- $document : Document
- $format : string
getDocument()
public
getDocument() : Document
Return values
DocumentgetFormat()
public
getFormat() : string
Return values
stringisPropagationStopped()
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().