TYPO3\CMS\Form\Domain\Finishers\FinisherInterface Interface Reference

Inheritance diagram for TYPO3\CMS\Form\Domain\Finishers\FinisherInterface:

Public Member Functions
string null	execute (FinisherContext $finisherContext)
	setFinisherIdentifier (string $finisherIdentifier)
	setOptions (array $options)
	setOption (string $optionName, $optionValue)
	isEnabled ()

Detailed Description

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

Scope: frontend

Definition at line 30 of file FinisherInterface.php.

Member Function Documentation

execute()

string null TYPO3\CMS\Form\Domain\Finishers\FinisherInterface::execute

(

FinisherContext

$finisherContext

)

Executes the finisher

Parameters

FinisherContext

$finisherContext

‪The Finisher context that contains the current Form Runtime and Response

Returns

‪string|null

Implemented in TYPO3\CMS\Form\Domain\Finishers\AbstractFinisher.

isEnabled()

TYPO3\CMS\Form\Domain\Finishers\FinisherInterface::isEnabled

(

)

Returns whether this finisher is enabled

Implemented in TYPO3\CMS\Form\Domain\Finishers\AbstractFinisher.

setFinisherIdentifier()

TYPO3\CMS\Form\Domain\Finishers\FinisherInterface::setFinisherIdentifier

(

string

$finisherIdentifier

)

Implemented in TYPO3\CMS\Form\Domain\Finishers\AbstractFinisher.

setOption()

TYPO3\CMS\Form\Domain\Finishers\FinisherInterface::setOption	(	string	$optionName,
			$optionValue
	)

Sets a single finisher option (

See also

‪setOptions())

Parameters

string	$optionName	‪name of the option to be set
mixed	$optionValue	‪value of the option

Implemented in TYPO3\CMS\Form\Domain\Finishers\AbstractFinisher.

setOptions()

TYPO3\CMS\Form\Domain\Finishers\FinisherInterface::setOptions

(

array

$options

)

Parameters

array

$options

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

Implemented in TYPO3\CMS\Form\Domain\Finishers\AbstractFinisher.