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.

Internal

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.

Deprecated

since v11, will be removed with v12.

protected ControllerContext $controllerContext

$formRuntime

A reference to the Form Runtime the finisher belongs to

protected FormRuntime $formRuntime

Methods

cancel()

Cancels the finisher invocation after the current finisher

public cancel() : mixed

getFormValues()

The values of the submitted form (after validation and property mapping)

public getFormValues() : array<string|int, mixed>
Return values
array<string|int, mixed>

isCancelled()

TRUE if no further finishers should be invoked. Defaults to FALSE

public isCancelled() : bool
Internal
Return values
bool

        
On this page

Search results