PreRenderProcess
in package
FinalYes
This event is called once before each rendering method after all documents have been parsed and all compiler passes (including node transformers have been called.)
It can be used to exit the rendering process before anything was rendered. A third party extension could then take over the rendering with its own means.
Table of Contents
Properties
- $command : RenderCommand
- $exitRendering : bool
- $steps : int
Methods
- __construct() : mixed
- getCommand() : RenderCommand
- getSteps() : int
- isExitRendering() : bool
- setExitRendering() : PreRenderProcess
Properties
$command read-only
private
RenderCommand
$command
$exitRendering
private
bool
$exitRendering
= false
$steps read-only
private
int
$steps
= 1
Methods
__construct()
public
__construct(RenderCommand $command[, int $steps = 1 ]) : mixed
Parameters
- $command : RenderCommand
- $steps : int = 1
getCommand()
public
getCommand() : RenderCommand
Return values
RenderCommandgetSteps()
public
getSteps() : int
Return values
intisExitRendering()
public
isExitRendering() : bool
Return values
boolsetExitRendering()
public
setExitRendering(bool $exitRendering) : PreRenderProcess
Parameters
- $exitRendering : bool