TYPO3CMS  8
 All Classes Namespaces Files Functions Variables Pages
FinisherContext Class Reference

Public Member Functions

 __construct (FormRuntime $formRuntime, ControllerContext $controllerContext)
 
 cancel ()
 
 isCancelled ()
 
 getFormRuntime ()
 
 getFormValues ()
 
 getControllerContext ()
 

Protected Attributes

 $cancelled = false
 
 $formRuntime
 
 $controllerContext
 

Detailed Description

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.

Definition at line 29 of file FinisherContext.php.

Constructor & Destructor Documentation

__construct ( FormRuntime  $formRuntime,
ControllerContext  $controllerContext 
)
Parameters
FormRuntime$formRuntime

Definition at line 57 of file FinisherContext.php.

References FinisherContext\$controllerContext, and FinisherContext\$formRuntime.

Member Function Documentation

cancel ( )

Cancels the finisher invocation after the current finisher

Returns
void

Definition at line 69 of file FinisherContext.php.

getControllerContext ( )
Returns
ControllerContext

Definition at line 111 of file FinisherContext.php.

References FinisherContext\$controllerContext.

getFormRuntime ( )

The Form Runtime that is associated with the current finisher

Returns
FormRuntime

Definition at line 91 of file FinisherContext.php.

References FinisherContext\$formRuntime.

getFormValues ( )

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

Returns
array

Definition at line 102 of file FinisherContext.php.

isCancelled ( )

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

Returns
bool

Definition at line 80 of file FinisherContext.php.

References FinisherContext\$cancelled.

Member Data Documentation

$cancelled = false
protected

Definition at line 37 of file FinisherContext.php.

Referenced by FinisherContext\isCancelled().

$controllerContext
protected
$formRuntime
protected