FinisherInterface

Finisher that can be attached to a form in order to be invoked as soon as the complete form is submitted

Scope: frontend

Table of Contents

Methods

execute()  : string|null
Executes the finisher
isEnabled()  : bool
Returns whether this finisher is enabled
setOption()  : mixed
Sets a single finisher option (@see setOptions())
setOptions()  : mixed

Methods

execute()

Executes the finisher

public execute(FinisherContext $finisherContext) : string|null
Parameters
$finisherContext : FinisherContext

The Finisher context that contains the current Form Runtime and Response

Return values
string|null

isEnabled()

Returns whether this finisher is enabled

public isEnabled() : bool
Return values
bool

setOption()

Sets a single finisher option (@see setOptions())

public setOption(string $optionName, mixed $optionValue) : mixed
Parameters
$optionName : string

name of the option to be set

$optionValue : mixed

value of the option

setOptions()

public setOptions(array<string|int, mixed> $options) : mixed
Parameters
$options : array<string|int, mixed>

configuration options in the format ['option1' => 'value1', 'option2' => 'value2', ...]


        
On this page

Search results