FinisherContext
The context that is passed to each finisher when executed.
It acts like an EventObject that is able to stop propagation.
Scope: frontend This class is NOT meant to be sub classed by developers.
Table of Contents
Properties
- $cancelled : bool
- If TRUE further finishers won't be invoked
- $controllerContext : ControllerContext
- The assigned controller context which might be needed by the finisher.
- $finisherVariableProvider : FinisherVariableProvider
- The assigned controller context which might be needed by the finisher.
- $formRuntime : FormRuntime
- A reference to the Form Runtime the finisher belongs to
Methods
- __construct() : mixed
- cancel() : mixed
- Cancels the finisher invocation after the current finisher
- getControllerContext() : ControllerContext
- getFinisherVariableProvider() : FinisherVariableProvider
- getFormRuntime() : FormRuntime
- The Form Runtime that is associated with the current finisher
- getFormValues() : array<string|int, mixed>
- The values of the submitted form (after validation and property mapping)
- getRequest() : Request
- isCancelled() : bool
- TRUE if no further finishers should be invoked. Defaults to FALSE
Properties
$cancelled
If TRUE further finishers won't be invoked
protected
bool
$cancelled
= false
$controllerContext
The assigned controller context which might be needed by the finisher.
since v11, will be removed with v12.
protected
ControllerContext
$controllerContext
$finisherVariableProvider
The assigned controller context which might be needed by the finisher.
protected
FinisherVariableProvider
$finisherVariableProvider
$formRuntime
A reference to the Form Runtime the finisher belongs to
protected
FormRuntime
$formRuntime
Methods
__construct()
public
__construct(FormRuntime $formRuntime, ControllerContext $controllerContext, Request $request) : mixed
Parameters
- $formRuntime : FormRuntime
- $controllerContext : ControllerContext
-
@deprecated since v11, will be removed with v12.
- $request : Request
cancel()
Cancels the finisher invocation after the current finisher
public
cancel() : mixed
getControllerContext()
public
getControllerContext() : ControllerContext
since v11, will be removed in v12
Return values
ControllerContextgetFinisherVariableProvider()
public
getFinisherVariableProvider() : FinisherVariableProvider
Return values
FinisherVariableProvidergetFormRuntime()
The Form Runtime that is associated with the current finisher
public
getFormRuntime() : FormRuntime
Return values
FormRuntimegetFormValues()
The values of the submitted form (after validation and property mapping)
public
getFormValues() : array<string|int, mixed>
Return values
array<string|int, mixed>getRequest()
public
getRequest() : Request
Return values
RequestisCancelled()
TRUE if no further finishers should be invoked. Defaults to FALSE
public
isCancelled() : bool