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

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

Protected Attributes
bool	$cancelled = false
FormRuntime	$formRuntime
ControllerContext	$controllerContext
FinisherVariableProvider	$finisherVariableProvider

Private Attributes
Request	$request

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

Constructor & Destructor Documentation

__construct()

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

Parameters

FormRuntime	$formRuntime
ControllerContext	$controllerContext

Deprecated:

‪since v11, will be removed with v12.

Parameters

Request

$request

Definition at line 69 of file FinisherContext.php.

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

Member Function Documentation

cancel()

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

(

)

Cancels the finisher invocation after the current finisher

Definition at line 81 of file FinisherContext.php.

getControllerContext()

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

(

)

Returns

‪ControllerContext

Deprecated:

‪since v11, will be removed in v12

Definition at line 121 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 129 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 102 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 112 of file FinisherContext.php.

getRequest()

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

(

)

Definition at line 134 of file FinisherContext.php.

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

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

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

$controllerContext

ControllerContext TYPO3\CMS\Form\Domain\Finishers\FinisherContext::$controllerContext

protected

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

Deprecated:

‪since v11, will be removed with v12.

Definition at line 54 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 59 of file FinisherContext.php.

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

$formRuntime

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

protected

A reference to the Form Runtime the finisher belongs to

Definition at line 48 of file FinisherContext.php.

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

$request

Request TYPO3\CMS\Form\Domain\Finishers\FinisherContext::$request

private

Definition at line 61 of file FinisherContext.php.

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