TYPO3CMS  8
 All Classes Namespaces Files Functions Variables Pages
FinisherInterface Interface Reference
Inheritance diagram for FinisherInterface:
AbstractFinisher ClosureFinisher ConfirmationFinisher DeleteUploadsFinisher EmailFinisher FlashMessageFinisher RedirectFinisher SaveToDatabaseFinisher

Public Member Functions

 execute (FinisherContext $finisherContext)
 
 setOptions (array $options)
 
 setOption (string $optionName, $optionValue)
 

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 24 of file FinisherInterface.php.

Member Function Documentation

execute ( FinisherContext  $finisherContext)

Executes the finisher

Parameters
FinisherContext$finisherContextThe Finisher context that contains the current Form Runtime and Response
Returns
void

Implemented in AbstractFinisher.

setOption ( string  $optionName,
  $optionValue 
)

Sets a single finisher option (

See also
setOptions())
Parameters
string$optionNamename of the option to be set
mixed$optionValuevalue of the option
Returns
void

Implemented in AbstractFinisher.

setOptions ( array  $options)
Parameters
array$optionsconfiguration options in the format ['option1' => 'value1', 'option2' => 'value2', ...]
Returns
void

Implemented in AbstractFinisher.