‪TYPO3CMS  ‪main
TYPO3\CMS\Form\Domain\Runtime\FormState Class Reference

Public Member Functions

bool isFormSubmitted ()
 getLastDisplayedPageIndex ()
 setLastDisplayedPageIndex (int $lastDisplayedPageIndex)
 getFormValues ()
 setFormValue (string $propertyPath, $value)
mixed getFormValue (string $propertyPath)

Public Attributes

const NOPAGE = -1

Protected Attributes

int $lastDisplayedPageIndex = self::NOPAGE
array $formValues = array( )

Detailed Description

The current state of the form which is attached to the FormRuntime and saved in a session or the client.

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

Definition at line 35 of file FormState.php.

Member Function Documentation

◆ getFormValue()

mixed TYPO3\CMS\Form\Domain\Runtime\FormState::getFormValue ( string  $propertyPath)

Definition at line 92 of file FormState.php.

References TYPO3\CMS\Core\Utility\ArrayUtility\getValueByPath().

◆ getFormValues()

TYPO3\CMS\Form\Domain\Runtime\FormState::getFormValues ( )

Definition at line 71 of file FormState.php.

References TYPO3\CMS\Form\Domain\Runtime\FormState\$formValues.

◆ getLastDisplayedPageIndex()

TYPO3\CMS\Form\Domain\Runtime\FormState::getLastDisplayedPageIndex ( )

◆ isFormSubmitted()

bool TYPO3\CMS\Form\Domain\Runtime\FormState::isFormSubmitted ( )
‪bool FALSE if the form has never been submitted before, TRUE otherwise

Definition at line 56 of file FormState.php.

References TYPO3\CMS\Form\Domain\Runtime\FormState\NOPAGE.

◆ setFormValue()

TYPO3\CMS\Form\Domain\Runtime\FormState::setFormValue ( string  $propertyPath,

Definition at line 79 of file FormState.php.

References TYPO3\CMS\Core\Utility\ArrayUtility\setValueByPath().

◆ setLastDisplayedPageIndex()

TYPO3\CMS\Form\Domain\Runtime\FormState::setLastDisplayedPageIndex ( int  $lastDisplayedPageIndex)

Member Data Documentation

◆ $formValues

array TYPO3\CMS\Form\Domain\Runtime\FormState::$formValues = array( )

Definition at line 51 of file FormState.php.

Referenced by TYPO3\CMS\Form\Domain\Runtime\FormState\getFormValues().

◆ $lastDisplayedPageIndex

int TYPO3\CMS\Form\Domain\Runtime\FormState::$lastDisplayedPageIndex = self::NOPAGE


const TYPO3\CMS\Form\Domain\Runtime\FormState::NOPAGE = -1

Constant which means that we are currently not on any page; i.e. the form has never rendered before.

Definition at line 41 of file FormState.php.

Referenced by TYPO3\CMS\Form\Domain\Runtime\FormState\isFormSubmitted().