TYPO3\CMS\Form\Domain\Finishers\FinisherContext Class Reference

Public Member Functions
	__construct (FormRuntime $formRuntime, ControllerContext $controllerContext)
	initializeObject ()
	cancel ()
bool	isCancelled ()
FormRuntime	getFormRuntime ()
array	getFormValues ()
ControllerContext	getControllerContext ()
FinisherVariableProvider	getFinisherVariableProvider ()

Protected Attributes
bool	$cancelled = false
TYPO3 CMS Form Domain Runtime FormRuntime	$formRuntime
TYPO3 CMS Extbase Mvc Controller ControllerContext	$controllerContext
FinisherVariableProvider	$finisherVariableProvider

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 33 of file FinisherContext.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Form\Domain\Finishers\FinisherContext::__construct	(	FormRuntime	$formRuntime,
		ControllerContext	$controllerContext
	)

Parameters

FormRuntime	$formRuntime
ControllerContext	$controllerContext

Definition at line 65 of file FinisherContext.php.

References TYPO3\CMS\Form\Domain\Finishers\FinisherContext\$controllerContext, and TYPO3\CMS\Form\Domain\Finishers\FinisherContext\$formRuntime.

Member Function Documentation

cancel()

TYPO3\CMS\Form\Domain\Finishers\FinisherContext::cancel

(

)

Cancels the finisher invocation after the current finisher

Definition at line 83 of file FinisherContext.php.

getControllerContext()

ControllerContext TYPO3\CMS\Form\Domain\Finishers\FinisherContext::getControllerContext

(

)

Returns

‪ControllerContext

Definition at line 122 of file FinisherContext.php.

References TYPO3\CMS\Form\Domain\Finishers\FinisherContext\$controllerContext.

getFinisherVariableProvider()

FinisherVariableProvider TYPO3\CMS\Form\Domain\Finishers\FinisherContext::getFinisherVariableProvider

(

)

Returns

‪FinisherVariableProvider

Definition at line 130 of file FinisherContext.php.

References TYPO3\CMS\Form\Domain\Finishers\FinisherContext\$finisherVariableProvider.

getFormRuntime()

FormRuntime TYPO3\CMS\Form\Domain\Finishers\FinisherContext::getFormRuntime

(

)

The Form Runtime that is associated with the current finisher

Returns

‪FormRuntime

Definition at line 104 of file FinisherContext.php.

References TYPO3\CMS\Form\Domain\Finishers\FinisherContext\$formRuntime.

getFormValues()

array TYPO3\CMS\Form\Domain\Finishers\FinisherContext::getFormValues

(

)

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

Returns

‪array

Definition at line 114 of file FinisherContext.php.

initializeObject()

TYPO3\CMS\Form\Domain\Finishers\FinisherContext::initializeObject

(

)

Sets up the FinisherVariableProvider

Definition at line 74 of file FinisherContext.php.

isCancelled()

bool TYPO3\CMS\Form\Domain\Finishers\FinisherContext::isCancelled

(

)

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

Returns

‪bool

Definition at line 94 of file FinisherContext.php.

References TYPO3\CMS\Form\Domain\Finishers\FinisherContext\$cancelled.

Member Data Documentation

$cancelled

bool TYPO3\CMS\Form\Domain\Finishers\FinisherContext::$cancelled = false

protected

If TRUE further finishers won't be invoked

Definition at line 40 of file FinisherContext.php.

Referenced by TYPO3\CMS\Form\Domain\Finishers\FinisherContext\isCancelled().

$controllerContext

TYPO3 CMS Extbase Mvc Controller ControllerContext TYPO3\CMS\Form\Domain\Finishers\FinisherContext::$controllerContext

protected

The assigned controller context which might be needed by the finisher.

Definition at line 52 of file FinisherContext.php.

Referenced by TYPO3\CMS\Form\Domain\Finishers\FinisherContext\__construct(), and TYPO3\CMS\Form\Domain\Finishers\FinisherContext\getControllerContext().

$finisherVariableProvider

FinisherVariableProvider TYPO3\CMS\Form\Domain\Finishers\FinisherContext::$finisherVariableProvider

protected

The assigned controller context which might be needed by the finisher.

Definition at line 58 of file FinisherContext.php.

Referenced by TYPO3\CMS\Form\Domain\Finishers\FinisherContext\getFinisherVariableProvider().

$formRuntime

TYPO3 CMS Form Domain Runtime FormRuntime TYPO3\CMS\Form\Domain\Finishers\FinisherContext::$formRuntime

protected

A reference to the Form Runtime that the finisher belongs to

Definition at line 46 of file FinisherContext.php.

Referenced by TYPO3\CMS\Form\Domain\Finishers\FinisherContext\__construct(), and TYPO3\CMS\Form\Domain\Finishers\FinisherContext\getFormRuntime().