Inheritance diagram for TYPO3\CMS\Form\Domain\Runtime\FormRuntime:

Public Member Functions
	injectHashService (HashService $hashService)

	injectObjectManager (ObjectManagerInterface $objectManager)

	injectConfigurationManager (ConfigurationManagerInterface $configurationManager)

	__construct (FormDefinition $formDefinition, Request $request, Response $response)

	initializeObject ()

	overrideCurrentPage (int $pageIndex)

string null	render ()

string	getIdentifier ()

Request	getRequest ()

Response	getResponse ()

bool	canProcessFormSubmission ()

FormSession null	getFormSession ()

Page null	getCurrentPage ()

Page null	getPreviousPage ()

Page null	getNextPage ()

Page null	getPreviousEnabledPage ()

Page null	getNextEnabledPage ()

string	getType ()

bool	offsetExists ($identifier)

mixed	offsetGet ($identifier)

	offsetSet ($identifier, $value)

	offsetUnset ($identifier)

mixed	getElementValue (string $identifier)

array Page[]	getPages ()

FormState null	getFormState ()

array	getRenderingOptions ()

string	getRendererClassName ()

string	getLabel ()

string	getTemplateName ()

FormDefinition	getFormDefinition ()

SiteLanguage	getCurrentSiteLanguage ()

	setCurrentSiteLanguage (SiteLanguage $currentSiteLanguage)

FinisherInterface null	getCurrentFinisher ()

Public Attributes
const	HONEYPOT_NAME_SESSION_IDENTIFIER = 'tx_form_honeypot_name_'

Protected Member Functions
	initializeFormSessionFromRequest ()

	initializeFormStateFromRequest ()

	triggerAfterFormStateInitialized ()

	initializeCurrentPageFromRequest ()

	initializeHoneypotFromRequest ()

	renderHoneypot ()

string null	getHoneypotNameFromSession (Page $page)

	setHoneypotNameInSession (Page $page, string $honeypotName)

bool	isFrontendUserAuthenticated ()

	processVariants ()

bool	isAfterLastPage ()

bool	isFirstRequest ()

bool	isPostRequest ()

bool	isRenderedCached ()

	processSubmittedFormValues ()

bool	userWentBackToPreviousStep ()

Result	mapAndValidatePage (Page $page)

string	invokeFinishers ()

ControllerContext	getControllerContext ()

	initializeCurrentSiteLanguage ()

Resolver	getConditionResolver ()

FrontendUserAuthentication	getFrontendUser ()

TypoScriptFrontendController null	getTypoScriptFrontendController ()

Protected Attributes
TYPO3 CMS Extbase Object ObjectManagerInterface	$objectManager

TYPO3 CMS Form Domain Model FormDefinition	$formDefinition

TYPO3 CMS Extbase Mvc Web Request	$request

TYPO3 CMS Extbase Mvc Web Response	$response

TYPO3 CMS Form Domain Runtime FormState	$formState

FormSession null	$formSession

TYPO3 CMS Form Domain Model FormElements Page	$currentPage

TYPO3 CMS Form Domain Model FormElements Page	$lastDisplayedPage

TYPO3 CMS Extbase Security Cryptography HashService	$hashService

SiteLanguage	$currentSiteLanguage

TYPO3 CMS Form Domain Finishers FinisherInterface	$currentFinisher

TYPO3 CMS Extbase Configuration ConfigurationManagerInterface	$configurationManager

Detailed Description

This class implements the runtime logic of a form, i.e. deciding which page is shown currently, what the current values of the form are, trigger validation and property mapping.

You generally receive an instance of this class by calling \TYPO3\CMS\Form\Domain\Model\FormDefinition::bind.

Rendering a Form

That's easy, just call render() on the FormRuntime:

/—code php $form = $formDefinition->bind($request, $response); $renderedForm = $form->render(); ---

Accessing Form Values

In order to get the values the user has entered into the form, you can access this object like an array: If a form field with the identifier firstName exists, you can do $form['firstName'] to retrieve its current value.

You can also set values in the same way.

Rendering Internals

The FormRuntime asks the FormDefinition about the configured Renderer which should be used (\TYPO3\CMS\Form\Domain\Model\FormDefinition::getRendererClassName), and then trigger render() on this Renderer.

This makes it possible to declaratively define how a form should be rendered.

Scope: frontend This class is NOT meant to be sub classed by developers.

Definition at line 102 of file FormRuntime.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Form\Domain\Runtime\FormRuntime::__construct	(	FormDefinition	$formDefinition,
		Request	$request,
		Response	$response
	)

Parameters

FormDefinition	$formDefinition
Request	$request
Response	$response

Definition at line 202 of file FormRuntime.php.

References TYPO3\CMS\Form\Domain\Runtime\FormRuntime\$formDefinition, TYPO3\CMS\Form\Domain\Runtime\FormRuntime\$request, TYPO3\CMS\Form\Domain\Runtime\FormRuntime\$response, TYPO3\CMS\Extbase\Mvc\Request\getArguments(), and TYPO3\CMS\Extbase\Mvc\Request\setArguments().

Member Function Documentation

◆ canProcessFormSubmission()

bool TYPO3\CMS\Form\Domain\Runtime\FormRuntime::canProcessFormSubmission ( )

Only process values if there is a post request and if the surrounding content object is uncached. Is this not the case, all possible submitted values will be discarded and the first form step will be shown with an empty form state.

Returns: ‪bool

Definition at line 783 of file FormRuntime.php.

References TYPO3\CMS\Form\Domain\Runtime\FormRuntime\isPostRequest(), and TYPO3\CMS\Form\Domain\Runtime\FormRuntime\isRenderedCached().

Referenced by TYPO3\CMS\Form\Mvc\Property\PropertyMappingConfiguration\adjustPropertyMappingForFileUploadsAtRuntime(), TYPO3\CMS\Form\Domain\Runtime\FormRuntime\initializeFormSessionFromRequest(), TYPO3\CMS\Form\Domain\Runtime\FormRuntime\initializeFormStateFromRequest(), and TYPO3\CMS\Form\Domain\Runtime\FormRuntime\initializeObject().

◆ getConditionResolver()

Resolver TYPO3\CMS\Form\Domain\Runtime\FormRuntime::getConditionResolver ( )

protected

Returns: ‪Resolver

Definition at line 1147 of file FormRuntime.php.

References $GLOBALS, TYPO3\CMS\Form\Domain\Runtime\FormRuntime\getCurrentFinisher(), TYPO3\CMS\Form\Domain\Runtime\FormRuntime\getCurrentPage(), TYPO3\CMS\Form\Domain\Runtime\FormRuntime\getFormDefinition(), TYPO3\CMS\Form\Domain\Runtime\FormRuntime\getFormState(), TYPO3\CMS\Form\Domain\Model\FormDefinition\getPageByIndex(), and TYPO3\CMS\Form\Domain\Runtime\FormRuntime\getRequest().

Referenced by TYPO3\CMS\Form\Domain\Runtime\FormRuntime\processVariants().

◆ getControllerContext()

ControllerContext TYPO3\CMS\Form\Domain\Runtime\FormRuntime::getControllerContext ( )

protected

Returns: ‪ControllerContext

Definition at line 900 of file FormRuntime.php.

References TYPO3\CMS\Extbase\Mvc\Controller\ControllerContext\setRequest().

Referenced by TYPO3\CMS\Form\Domain\Runtime\FormRuntime\invokeFinishers(), and TYPO3\CMS\Form\Domain\Runtime\FormRuntime\render().

◆ getCurrentFinisher()

FinisherInterface null TYPO3\CMS\Form\Domain\Runtime\FormRuntime::getCurrentFinisher ( )

Reference to the current running finisher

Returns: ‪FinisherInterface|null

Definition at line 1139 of file FormRuntime.php.

References TYPO3\CMS\Form\Domain\Runtime\FormRuntime\$currentFinisher.

Referenced by TYPO3\CMS\Form\Domain\Runtime\FormRuntime\getConditionResolver().

◆ getCurrentPage()

Page null TYPO3\CMS\Form\Domain\Runtime\FormRuntime::getCurrentPage ( )

Returns the currently selected page

Returns: ‪Page|null

Definition at line 802 of file FormRuntime.php.

References TYPO3\CMS\Form\Domain\Runtime\FormRuntime\$currentPage.

Referenced by TYPO3\CMS\Form\Domain\Runtime\FormRuntime\getConditionResolver().

◆ getCurrentSiteLanguage()

SiteLanguage TYPO3\CMS\Form\Domain\Runtime\FormRuntime::getCurrentSiteLanguage ( )

Get the current site language configuration.

Returns: ‪SiteLanguage

Definition at line 1076 of file FormRuntime.php.

References TYPO3\CMS\Form\Domain\Runtime\FormRuntime\$currentSiteLanguage.

◆ getElementValue()

mixed TYPO3\CMS\Form\Domain\Runtime\FormRuntime::getElementValue ( string $identifier )

Returns the value of the specified element

Parameters

string $identifier

Returns: ‪mixed

Definition at line 994 of file FormRuntime.php.

Referenced by TYPO3\CMS\Form\Domain\Runtime\FormRuntime\offsetExists(), and TYPO3\CMS\Form\Domain\Runtime\FormRuntime\offsetGet().

◆ getFormDefinition()

FormDefinition TYPO3\CMS\Form\Domain\Runtime\FormRuntime::getFormDefinition ( )

Get the underlying form definition from the runtime

Returns: ‪FormDefinition

Definition at line 1066 of file FormRuntime.php.

References TYPO3\CMS\Form\Domain\Runtime\FormRuntime\$formDefinition.

Referenced by TYPO3\CMS\Form\Mvc\Property\PropertyMappingConfiguration\afterFormStateInitialized(), TYPO3\CMS\Form\Domain\Runtime\FormRuntime\getConditionResolver(), and TYPO3\CMS\Form\Domain\Finishers\AbstractFinisher\resolveRuntimeReference().

◆ getFormSession()

FormSession null TYPO3\CMS\Form\Domain\Runtime\FormRuntime::getFormSession ( )

Returns: ‪FormSession|null

Definition at line 792 of file FormRuntime.php.

References TYPO3\CMS\Form\Domain\Runtime\FormRuntime\$formSession.

Referenced by TYPO3\CMS\Form\Mvc\Property\PropertyMappingConfiguration\adjustPropertyMappingForFileUploadsAtRuntime().

◆ getFormState()

FormState null TYPO3\CMS\Form\Domain\Runtime\FormRuntime::getFormState ( )

Returns: ‪FormState|null

Definition at line 1015 of file FormRuntime.php.

References TYPO3\CMS\Form\Domain\Runtime\FormRuntime\$formState.

Referenced by TYPO3\CMS\Form\Domain\Runtime\FormRuntime\getConditionResolver().

◆ getFrontendUser()

FrontendUserAuthentication TYPO3\CMS\Form\Domain\Runtime\FormRuntime::getFrontendUser ( )

protected

Returns: ‪FrontendUserAuthentication

Definition at line 1183 of file FormRuntime.php.

References TYPO3\CMS\Form\Domain\Runtime\FormRuntime\getTypoScriptFrontendController().

Referenced by TYPO3\CMS\Form\Domain\Runtime\FormRuntime\getHoneypotNameFromSession(), and TYPO3\CMS\Form\Domain\Runtime\FormRuntime\setHoneypotNameInSession().

◆ getHoneypotNameFromSession()

string null TYPO3\CMS\Form\Domain\Runtime\FormRuntime::getHoneypotNameFromSession ( Page $page )

protected

Parameters

Page $page

Returns: ‪string|null

Definition at line 436 of file FormRuntime.php.

References TYPO3\CMS\Form\Domain\Runtime\FormRuntime\getFrontendUser(), TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable\getIdentifier(), TYPO3\CMS\Form\Domain\Runtime\FormRuntime\getIdentifier(), TYPO3\CMS\Frontend\Authentication\FrontendUserAuthentication\getKey(), and TYPO3\CMS\Form\Domain\Runtime\FormRuntime\isFrontendUserAuthenticated().

Referenced by TYPO3\CMS\Form\Domain\Runtime\FormRuntime\initializeHoneypotFromRequest(), and TYPO3\CMS\Form\Domain\Runtime\FormRuntime\renderHoneypot().

◆ getIdentifier()

string TYPO3\CMS\Form\Domain\Runtime\FormRuntime::getIdentifier ( )

Returns: ‪string The identifier of underlying form

Implements TYPO3\CMS\Form\Domain\Model\Renderable\RootRenderableInterface.

Definition at line 743 of file FormRuntime.php.

Referenced by TYPO3\CMS\Form\Domain\Runtime\FormRuntime\getHoneypotNameFromSession(), TYPO3\CMS\Form\Domain\Runtime\FormRuntime\mapAndValidatePage(), TYPO3\CMS\Form\Domain\Runtime\FormRuntime\setHoneypotNameInSession(), TYPO3\CMS\Form\Service\TranslationService\translateFinisherOption(), TYPO3\CMS\Form\Service\TranslationService\translateFormElementError(), and TYPO3\CMS\Form\Service\TranslationService\translateFormElementValue().

◆ getLabel()

string TYPO3\CMS\Form\Domain\Runtime\FormRuntime::getLabel ( )

Get the label which shall be displayed next to the form element

Returns: ‪string

Implements TYPO3\CMS\Form\Domain\Model\Renderable\RootRenderableInterface.

Definition at line 1046 of file FormRuntime.php.

◆ getNextEnabledPage()

Page null TYPO3\CMS\Form\Domain\Runtime\FormRuntime::getNextEnabledPage ( )

Returns the next enabled page of the currently selected one or NULL if there is no next page

Returns: ‪Page|null

Definition at line 870 of file FormRuntime.php.

Referenced by TYPO3\CMS\Form\Domain\Runtime\FormRuntime\initializeCurrentPageFromRequest().

◆ getNextPage()

Page null TYPO3\CMS\Form\Domain\Runtime\FormRuntime::getNextPage ( )

Returns the next page of the currently selected one or NULL if there is no next page

Returns: ‪Page|null

Definition at line 826 of file FormRuntime.php.

References TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable\getIndex().

◆ getPages()

array Page [] TYPO3\CMS\Form\Domain\Runtime\FormRuntime::getPages ( )

Returns: ‪array|Page[] The Form's pages in the correct order

Definition at line 1006 of file FormRuntime.php.

◆ getPreviousEnabledPage()

Page null TYPO3\CMS\Form\Domain\Runtime\FormRuntime::getPreviousEnabledPage ( )

Returns the previous enabled page of the currently selected one or NULL if there is no previous page

Returns: ‪Page|null

Definition at line 841 of file FormRuntime.php.

References TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable\getIndex().

Referenced by TYPO3\CMS\Form\Domain\Runtime\FormRuntime\initializeCurrentPageFromRequest().

◆ getPreviousPage()

Page null TYPO3\CMS\Form\Domain\Runtime\FormRuntime::getPreviousPage ( )

Returns the previous page of the currently selected one or NULL if there is no previous page

Returns: ‪Page|null

Definition at line 812 of file FormRuntime.php.

References TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable\getIndex().

◆ getRendererClassName()

string TYPO3\CMS\Form\Domain\Runtime\FormRuntime::getRendererClassName ( )

Get the renderer class name to be used to display this renderable; must implement RendererInterface

Returns: ‪string the renderer class name

Implements TYPO3\CMS\Form\Domain\Model\Renderable\RootRenderableInterface.

Definition at line 1036 of file FormRuntime.php.

◆ getRenderingOptions()

array TYPO3\CMS\Form\Domain\Runtime\FormRuntime::getRenderingOptions ( )

Get all rendering options

Returns: ‪array associative array of rendering options

Implements TYPO3\CMS\Form\Domain\Model\Renderable\RootRenderableInterface.

Definition at line 1025 of file FormRuntime.php.

Referenced by TYPO3\CMS\Form\Service\TranslationService\translateFinisherOption(), TYPO3\CMS\Form\Service\TranslationService\translateFormElementError(), and TYPO3\CMS\Form\Service\TranslationService\translateFormElementValue().

◆ getRequest()

Request TYPO3\CMS\Form\Domain\Runtime\FormRuntime::getRequest ( )

Get the request this object is bound to.

This is mostly relevant inside Finishers, where you f.e. want to redirect the user to another page.

Returns: ‪Request the request this object is bound to

Definition at line 756 of file FormRuntime.php.

References TYPO3\CMS\Form\Domain\Runtime\FormRuntime\$request.

Referenced by TYPO3\CMS\Form\Domain\Runtime\FormRuntime\getConditionResolver(), and TYPO3\CMS\Form\Domain\Runtime\FormRuntime\isPostRequest().

◆ getResponse()

Response TYPO3\CMS\Form\Domain\Runtime\FormRuntime::getResponse ( )

Get the response this object is bound to.

This is mostly relevant inside Finishers, where you f.e. want to set response headers or output content.

Returns: ‪Response the response this object is bound to

Definition at line 769 of file FormRuntime.php.

References TYPO3\CMS\Form\Domain\Runtime\FormRuntime\$response.

◆ getTemplateName()

string TYPO3\CMS\Form\Domain\Runtime\FormRuntime::getTemplateName ( )

Get the template name of the renderable

Returns: ‪string

Definition at line 1056 of file FormRuntime.php.

◆ getType()

string TYPO3\CMS\Form\Domain\Runtime\FormRuntime::getType ( )

Abstract "type" of this Renderable. Is used during the rendering process to determine the template file or the View PHP class being used to render the particular element.

Returns: ‪string

Implements TYPO3\CMS\Form\Domain\Model\Renderable\RootRenderableInterface.

Definition at line 919 of file FormRuntime.php.

◆ getTypoScriptFrontendController()

TypoScriptFrontendController null TYPO3\CMS\Form\Domain\Runtime\FormRuntime::getTypoScriptFrontendController ( )

protected

Returns: ‪TypoScriptFrontendController|null

Definition at line 1191 of file FormRuntime.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Form\Domain\Runtime\FormRuntime\getFrontendUser(), and TYPO3\CMS\Form\Domain\Runtime\FormRuntime\initializeCurrentSiteLanguage().

◆ initializeCurrentPageFromRequest()

TYPO3\CMS\Form\Domain\Runtime\FormRuntime::initializeCurrentPageFromRequest ( )

protected

Initializes the current page data based on the current request, also modifiable by a hook

Definition at line 288 of file FormRuntime.php.

References $GLOBALS, TYPO3\CMS\Form\Domain\Runtime\FormRuntime\getNextEnabledPage(), TYPO3\CMS\Form\Domain\Runtime\FormRuntime\getPreviousEnabledPage(), and TYPO3\CMS\Form\Domain\Runtime\FormRuntime\userWentBackToPreviousStep().

Referenced by TYPO3\CMS\Form\Domain\Runtime\FormRuntime\initializeObject().

◆ initializeCurrentSiteLanguage()

TYPO3\CMS\Form\Domain\Runtime\FormRuntime::initializeCurrentSiteLanguage ( )

protected

Initialize the SiteLanguage object. This is mainly used by the condition matcher.

Definition at line 1098 of file FormRuntime.php.

References $GLOBALS, and TYPO3\CMS\Form\Domain\Runtime\FormRuntime\getTypoScriptFrontendController().

Referenced by TYPO3\CMS\Form\Domain\Runtime\FormRuntime\initializeObject().

◆ initializeFormSessionFromRequest()

TYPO3\CMS\Form\Domain\Runtime\FormRuntime::initializeFormSessionFromRequest ( )

protected

Todo:: ‪FormRuntime::$formSession is still vulnerable to session fixation unless a real cookie-based process is used

Definition at line 241 of file FormRuntime.php.

References TYPO3\CMS\Form\Domain\Runtime\FormRuntime\canProcessFormSubmission().

Referenced by TYPO3\CMS\Form\Domain\Runtime\FormRuntime\initializeObject().

◆ initializeFormStateFromRequest()

TYPO3\CMS\Form\Domain\Runtime\FormRuntime::initializeFormStateFromRequest ( )

protected

Initializes the current state of the form, based on the request

Exceptions

BadRequestException

Definition at line 257 of file FormRuntime.php.

References TYPO3\CMS\Form\Domain\Runtime\FormRuntime\canProcessFormSubmission().

Referenced by TYPO3\CMS\Form\Domain\Runtime\FormRuntime\initializeObject().

◆ initializeHoneypotFromRequest()

TYPO3\CMS\Form\Domain\Runtime\FormRuntime::initializeHoneypotFromRequest ( )

protected

Checks if the honey pot is active, and adds a validator if so.

Definition at line 362 of file FormRuntime.php.

References $validator, TYPO3\CMS\Core\Utility\ArrayUtility\assertAllArrayKeysAreValid(), TYPO3\CMS\Form\Domain\Runtime\FormRuntime\getHoneypotNameFromSession(), and TYPO3\CMS\Form\Domain\Runtime\FormRuntime\isFirstRequest().

Referenced by TYPO3\CMS\Form\Domain\Runtime\FormRuntime\initializeObject().

◆ initializeObject()

TYPO3\CMS\Form\Domain\Runtime\FormRuntime::initializeObject ( )

Definition at line 218 of file FormRuntime.php.

◆ injectConfigurationManager()

TYPO3\CMS\Form\Domain\Runtime\FormRuntime::injectConfigurationManager ( ConfigurationManagerInterface $configurationManager )

Parameters

\TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface $configurationManager

Definition at line 192 of file FormRuntime.php.

References TYPO3\CMS\Form\Domain\Runtime\FormRuntime\$configurationManager.

◆ injectHashService()

TYPO3\CMS\Form\Domain\Runtime\FormRuntime::injectHashService ( HashService $hashService )

Parameters

\TYPO3\CMS\Extbase\Security\Cryptography\HashService $hashService

Definition at line 175 of file FormRuntime.php.

References TYPO3\CMS\Form\Domain\Runtime\FormRuntime\$hashService.

◆ injectObjectManager()

TYPO3\CMS\Form\Domain\Runtime\FormRuntime::injectObjectManager ( ObjectManagerInterface $objectManager )

Parameters

\TYPO3\CMS\Extbase\Object\ObjectManagerInterface $objectManager

Definition at line 184 of file FormRuntime.php.

References TYPO3\CMS\Form\Domain\Runtime\FormRuntime\$objectManager.

◆ invokeFinishers()

string TYPO3\CMS\Form\Domain\Runtime\FormRuntime::invokeFinishers ( )

protected

Executes all finishers of this form

Returns: ‪string

Definition at line 708 of file FormRuntime.php.

References $output, TYPO3\CMS\Form\Domain\Runtime\FormRuntime\getControllerContext(), and TYPO3\CMS\Form\Domain\Runtime\FormRuntime\processVariants().

Referenced by TYPO3\CMS\Form\Domain\Runtime\FormRuntime\render().

◆ isAfterLastPage()

bool TYPO3\CMS\Form\Domain\Runtime\FormRuntime::isAfterLastPage ( )

protected

Returns TRUE if the last page of the form has been submitted, otherwise FALSE

Returns: ‪bool

Definition at line 506 of file FormRuntime.php.

Referenced by TYPO3\CMS\Form\Domain\Runtime\FormRuntime\render(), TYPO3\CMS\Form\Domain\Runtime\FormRuntime\renderHoneypot(), and TYPO3\CMS\Form\Domain\Runtime\FormRuntime\userWentBackToPreviousStep().

◆ isFirstRequest()

bool TYPO3\CMS\Form\Domain\Runtime\FormRuntime::isFirstRequest ( )

protected

Returns TRUE if no previous page is stored in the FormState, otherwise FALSE

Returns: ‪bool

Definition at line 516 of file FormRuntime.php.

Referenced by TYPO3\CMS\Form\Domain\Runtime\FormRuntime\initializeHoneypotFromRequest(), TYPO3\CMS\Form\Domain\Runtime\FormRuntime\initializeObject(), TYPO3\CMS\Form\Domain\Runtime\FormRuntime\renderHoneypot(), and TYPO3\CMS\Form\Domain\Runtime\FormRuntime\userWentBackToPreviousStep().

◆ isFrontendUserAuthenticated()

bool TYPO3\CMS\Form\Domain\Runtime\FormRuntime::isFrontendUserAuthenticated ( )

protected

Necessary to know if honeypot information should be stored in the user session info, or in the anonymous session

Returns: ‪bool true when a frontend user is logged, otherwise false

Definition at line 478 of file FormRuntime.php.

Referenced by TYPO3\CMS\Form\Domain\Runtime\FormRuntime\getHoneypotNameFromSession(), and TYPO3\CMS\Form\Domain\Runtime\FormRuntime\setHoneypotNameInSession().

◆ isPostRequest()

bool TYPO3\CMS\Form\Domain\Runtime\FormRuntime::isPostRequest ( )

protected

Returns: ‪bool

Definition at line 524 of file FormRuntime.php.

References TYPO3\CMS\Extbase\Mvc\Request\getMethod(), and TYPO3\CMS\Form\Domain\Runtime\FormRuntime\getRequest().

Referenced by TYPO3\CMS\Form\Domain\Runtime\FormRuntime\canProcessFormSubmission().

◆ isRenderedCached()

bool TYPO3\CMS\Form\Domain\Runtime\FormRuntime::isRenderedCached ( )

protected

Determine whether the surrounding content object is cached. If no surrounding content object can be found (which would be strange) we assume a cached request for safety which means that an empty form will be rendered.

Todo:: ‪: this should be checked against https://forge.typo3.org/issues/91625 as this was fixed differently for UriBuilder

Returns: ‪bool

Definition at line 538 of file FormRuntime.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\OBJECTTYPE_USER.

Referenced by TYPO3\CMS\Form\Domain\Runtime\FormRuntime\canProcessFormSubmission().

◆ mapAndValidatePage()

Result TYPO3\CMS\Form\Domain\Runtime\FormRuntime::mapAndValidatePage ( Page $page )

protected

Parameters

Page $page

Returns: ‪Result

Exceptions

PropertyMappingException

Definition at line 574 of file FormRuntime.php.

References $GLOBALS, TYPO3\CMS\Form\Domain\Model\FormElements\AbstractSection\getElementsRecursively(), TYPO3\CMS\Form\Domain\Runtime\FormRuntime\getIdentifier(), and TYPO3\CMS\Core\Utility\ArrayUtility\getValueByPath().

Referenced by TYPO3\CMS\Form\Domain\Runtime\FormRuntime\processSubmittedFormValues().

◆ offsetExists()

bool TYPO3\CMS\Form\Domain\Runtime\FormRuntime::offsetExists ( $identifier )

Parameters

string $identifier

Returns: ‪bool

Definition at line 929 of file FormRuntime.php.

References TYPO3\CMS\Form\Domain\Runtime\FormRuntime\getElementValue().

◆ offsetGet()

mixed TYPO3\CMS\Form\Domain\Runtime\FormRuntime::offsetGet ( $identifier )

Parameters

string $identifier

Returns: ‪mixed

Definition at line 957 of file FormRuntime.php.

References TYPO3\CMS\Form\Domain\Runtime\FormRuntime\getElementValue().

◆ offsetSet()

TYPO3\CMS\Form\Domain\Runtime\FormRuntime::offsetSet	(	$identifier,
		$value
	)

Parameters

string	$identifier
mixed	$value

Definition at line 974 of file FormRuntime.php.

◆ offsetUnset()

TYPO3\CMS\Form\Domain\Runtime\FormRuntime::offsetUnset ( $identifier )

Parameters

string $identifier

Definition at line 983 of file FormRuntime.php.

◆ overrideCurrentPage()

TYPO3\CMS\Form\Domain\Runtime\FormRuntime::overrideCurrentPage ( int $pageIndex )

Override the current page taken from the request, rendering the page with index $pageIndex instead.

This is typically not needed in production code, but it is very helpful when displaying some kind of "preview" of the form (e.g. form editor).

Parameters

int $pageIndex

Definition at line 667 of file FormRuntime.php.

◆ processSubmittedFormValues()

TYPO3\CMS\Form\Domain\Runtime\FormRuntime::processSubmittedFormValues ( )

protected

Runs through all validations

Definition at line 550 of file FormRuntime.php.

References TYPO3\CMS\Form\Domain\Runtime\FormRuntime\$lastDisplayedPage, and TYPO3\CMS\Form\Domain\Runtime\FormRuntime\mapAndValidatePage().

Referenced by TYPO3\CMS\Form\Domain\Runtime\FormRuntime\initializeObject().

◆ processVariants()

TYPO3\CMS\Form\Domain\Runtime\FormRuntime::processVariants ( )

protected

Definition at line 484 of file FormRuntime.php.

References TYPO3\CMS\Form\Domain\Runtime\FormRuntime\getConditionResolver().

Referenced by TYPO3\CMS\Form\Domain\Runtime\FormRuntime\initializeObject(), TYPO3\CMS\Form\Domain\Runtime\FormRuntime\invokeFinishers(), and TYPO3\CMS\Form\Domain\Runtime\FormRuntime\render().

◆ render()

string null TYPO3\CMS\Form\Domain\Runtime\FormRuntime::render ( )

Render this form.

Returns: ‪string|null rendered form

Exceptions

RenderingException

Definition at line 678 of file FormRuntime.php.

References TYPO3\CMS\Form\Domain\Runtime\FormRuntime\getControllerContext(), TYPO3\CMS\Form\Domain\Runtime\FormRuntime\invokeFinishers(), TYPO3\CMS\Form\Domain\Runtime\FormRuntime\isAfterLastPage(), and TYPO3\CMS\Form\Domain\Runtime\FormRuntime\processVariants().

◆ renderHoneypot()

TYPO3\CMS\Form\Domain\Runtime\FormRuntime::renderHoneypot ( )

protected

Renders a hidden field if the honey pot is active.

Definition at line 389 of file FormRuntime.php.

References $validator, TYPO3\CMS\Core\Utility\ArrayUtility\assertAllArrayKeysAreValid(), TYPO3\CMS\Form\Domain\Runtime\FormRuntime\getHoneypotNameFromSession(), TYPO3\CMS\Form\Domain\Runtime\FormRuntime\isAfterLastPage(), TYPO3\CMS\Form\Domain\Runtime\FormRuntime\isFirstRequest(), and TYPO3\CMS\Form\Domain\Runtime\FormRuntime\setHoneypotNameInSession().

Referenced by TYPO3\CMS\Form\Domain\Runtime\FormRuntime\initializeObject().

◆ setCurrentSiteLanguage()

TYPO3\CMS\Form\Domain\Runtime\FormRuntime::setCurrentSiteLanguage ( SiteLanguage $currentSiteLanguage )

Override the the current site language configuration.

This is typically not needed in production code, but it is very helpful when displaying some kind of "preview" of the form (e.g. form editor).

Parameters

SiteLanguage $currentSiteLanguage

Definition at line 1089 of file FormRuntime.php.

References TYPO3\CMS\Form\Domain\Runtime\FormRuntime\$currentSiteLanguage.

◆ setHoneypotNameInSession()

TYPO3\CMS\Form\Domain\Runtime\FormRuntime::setHoneypotNameInSession	(	Page	$page,
		string	$honeypotName
	)

protected

Parameters

Page	$page
string	$honeypotName

Definition at line 456 of file FormRuntime.php.

References TYPO3\CMS\Form\Domain\Runtime\FormRuntime\getFrontendUser(), TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable\getIdentifier(), TYPO3\CMS\Form\Domain\Runtime\FormRuntime\getIdentifier(), TYPO3\CMS\Form\Domain\Runtime\FormRuntime\isFrontendUserAuthenticated(), and TYPO3\CMS\Frontend\Authentication\FrontendUserAuthentication\setKey().

Referenced by TYPO3\CMS\Form\Domain\Runtime\FormRuntime\renderHoneypot().

◆ triggerAfterFormStateInitialized()

TYPO3\CMS\Form\Domain\Runtime\FormRuntime::triggerAfterFormStateInitialized ( )

protected

Definition at line 275 of file FormRuntime.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Form\Domain\Runtime\FormRuntime\initializeObject().

◆ userWentBackToPreviousStep()

bool TYPO3\CMS\Form\Domain\Runtime\FormRuntime::userWentBackToPreviousStep ( )

protected

returns TRUE if the user went back to any previous step in the form.

Returns: ‪bool

Definition at line 564 of file FormRuntime.php.

References TYPO3\CMS\Form\Domain\Runtime\FormRuntime\isAfterLastPage(), and TYPO3\CMS\Form\Domain\Runtime\FormRuntime\isFirstRequest().

Referenced by TYPO3\CMS\Form\Domain\Runtime\FormRuntime\initializeCurrentPageFromRequest().

Member Data Documentation

◆ $configurationManager

TYPO3 CMS Extbase Configuration ConfigurationManagerInterface TYPO3\CMS\Form\Domain\Runtime\FormRuntime::$configurationManager

protected

Definition at line 169 of file FormRuntime.php.

Referenced by TYPO3\CMS\Form\Domain\Runtime\FormRuntime\injectConfigurationManager().

◆ $currentFinisher

TYPO3 CMS Form Domain Finishers FinisherInterface TYPO3\CMS\Form\Domain\Runtime\FormRuntime::$currentFinisher

protected

Reference to the current running finisher

Definition at line 165 of file FormRuntime.php.

Referenced by TYPO3\CMS\Form\Domain\Runtime\FormRuntime\getCurrentFinisher().

◆ $currentPage

TYPO3 CMS Form Domain Model FormElements Page TYPO3\CMS\Form\Domain\Runtime\FormRuntime::$currentPage

protected

The current page is the page which will be displayed to the user during rendering.

If $currentPage is NULL, the last page has been submitted and finishing actions need to take place. You should use $this->isAfterLastPage() instead of explicitly checking for NULL.

Definition at line 142 of file FormRuntime.php.

Referenced by TYPO3\CMS\Form\Domain\Runtime\FormRuntime\getCurrentPage().

◆ $currentSiteLanguage

SiteLanguage TYPO3\CMS\Form\Domain\Runtime\FormRuntime::$currentSiteLanguage

protected

The current site language configuration.

Definition at line 159 of file FormRuntime.php.

Referenced by TYPO3\CMS\Form\Domain\Runtime\FormRuntime\getCurrentSiteLanguage(), and TYPO3\CMS\Form\Domain\Runtime\FormRuntime\setCurrentSiteLanguage().

◆ $formDefinition

TYPO3 CMS Form Domain Model FormDefinition TYPO3\CMS\Form\Domain\Runtime\FormRuntime::$formDefinition

protected

Definition at line 112 of file FormRuntime.php.

Referenced by TYPO3\CMS\Form\Domain\Runtime\FormRuntime\__construct(), and TYPO3\CMS\Form\Domain\Runtime\FormRuntime\getFormDefinition().

◆ $formSession

FormSession null TYPO3\CMS\Form\Domain\Runtime\FormRuntime::$formSession

protected

Individual unique random form session identifier valid for current user session. This value is not persisted server-side.

Definition at line 131 of file FormRuntime.php.

Referenced by TYPO3\CMS\Form\Domain\Runtime\FormRuntime\getFormSession().

◆ $formState

TYPO3 CMS Form Domain Runtime FormState TYPO3\CMS\Form\Domain\Runtime\FormRuntime::$formState

protected

Definition at line 124 of file FormRuntime.php.

Referenced by TYPO3\CMS\Form\Domain\Runtime\FormRuntime\getFormState().

◆ $hashService

TYPO3 CMS Extbase Security Cryptography HashService TYPO3\CMS\Form\Domain\Runtime\FormRuntime::$hashService

protected

Definition at line 153 of file FormRuntime.php.

Referenced by TYPO3\CMS\Form\Domain\Runtime\FormRuntime\injectHashService().

◆ $lastDisplayedPage

TYPO3 CMS Form Domain Model FormElements Page TYPO3\CMS\Form\Domain\Runtime\FormRuntime::$lastDisplayedPage

protected

Reference to the page which has been shown on the last request (i.e. we have to handle the submitted data from lastDisplayedPage)

Definition at line 149 of file FormRuntime.php.

Referenced by TYPO3\CMS\Form\Domain\Runtime\FormRuntime\processSubmittedFormValues().

◆ $objectManager

TYPO3 CMS Extbase Object ObjectManagerInterface TYPO3\CMS\Form\Domain\Runtime\FormRuntime::$objectManager

protected

Definition at line 108 of file FormRuntime.php.

Referenced by TYPO3\CMS\Form\Domain\Runtime\FormRuntime\injectObjectManager().

◆ $request

TYPO3 CMS Extbase Mvc Web Request TYPO3\CMS\Form\Domain\Runtime\FormRuntime::$request

protected

Definition at line 116 of file FormRuntime.php.

Referenced by TYPO3\CMS\Form\Domain\Runtime\FormRuntime\__construct(), and TYPO3\CMS\Form\Domain\Runtime\FormRuntime\getRequest().

◆ $response

TYPO3 CMS Extbase Mvc Web Response TYPO3\CMS\Form\Domain\Runtime\FormRuntime::$response

protected

Definition at line 120 of file FormRuntime.php.

Referenced by TYPO3\CMS\Form\Domain\Runtime\FormRuntime\__construct(), and TYPO3\CMS\Form\Domain\Runtime\FormRuntime\getResponse().

◆ HONEYPOT_NAME_SESSION_IDENTIFIER

const TYPO3\CMS\Form\Domain\Runtime\FormRuntime::HONEYPOT_NAME_SESSION_IDENTIFIER = 'tx_form_honeypot_name_'

Definition at line 104 of file FormRuntime.php.

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Rendering a Form

Accessing Form Values

Rendering Internals

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ canProcessFormSubmission()

◆ getConditionResolver()

◆ getControllerContext()

◆ getCurrentFinisher()

◆ getCurrentPage()

◆ getCurrentSiteLanguage()

◆ getElementValue()

◆ getFormDefinition()

◆ getFormSession()

◆ getFormState()

◆ getFrontendUser()

◆ getHoneypotNameFromSession()

◆ getIdentifier()

◆ getLabel()

◆ getNextEnabledPage()

◆ getNextPage()

◆ getPages()

◆ getPreviousEnabledPage()

◆ getPreviousPage()

◆ getRendererClassName()

◆ getRenderingOptions()

◆ getRequest()

◆ getResponse()

◆ getTemplateName()

◆ getType()

◆ getTypoScriptFrontendController()

◆ initializeCurrentPageFromRequest()

◆ initializeCurrentSiteLanguage()

◆ initializeFormSessionFromRequest()

◆ initializeFormStateFromRequest()

◆ initializeHoneypotFromRequest()

◆ initializeObject()

◆ injectConfigurationManager()

◆ injectHashService()

◆ injectObjectManager()

◆ invokeFinishers()

◆ isAfterLastPage()

◆ isFirstRequest()

◆ isFrontendUserAuthenticated()

◆ isPostRequest()

◆ isRenderedCached()

◆ mapAndValidatePage()

◆ offsetExists()

◆ offsetGet()

◆ offsetSet()

◆ offsetUnset()

◆ overrideCurrentPage()

◆ processSubmittedFormValues()

◆ processVariants()

◆ render()

◆ renderHoneypot()

◆ setCurrentSiteLanguage()

◆ setHoneypotNameInSession()

◆ triggerAfterFormStateInitialized()

◆ userWentBackToPreviousStep()

Member Data Documentation

◆ $configurationManager

◆ $currentFinisher

◆ $currentPage

◆ $currentSiteLanguage

◆ $formDefinition

◆ $formSession

◆ $formState

◆ $hashService

◆ $lastDisplayedPage

◆ $objectManager

◆ $request

◆ $response

◆ HONEYPOT_NAME_SESSION_IDENTIFIER