FormState.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */
 
/*
 * Inspired by and partially taken from the Neos.Form package (www.neos.io)
 */
 
namespace ‪TYPO3\CMS\Form\Domain\Runtime;
 
use ‪TYPO3\CMS\Core\Utility\ArrayUtility;
use ‪TYPO3\CMS\Core\Utility\Exception\MissingArrayPathException;
 
class ‪FormState
{
    public const ‪NOPAGE = -1;
 
    protected ‪$lastDisplayedPageIndex = ‪self::NOPAGE;
 
    protected ‪$formValues = [];
 
    public function ‪isFormSubmitted(): bool
    {
        return $this->lastDisplayedPageIndex !== ‪self::NOPAGE;
    }
 
    public function ‪getLastDisplayedPageIndex(): int
    {
        return ‪$this->lastDisplayedPageIndex;
    }
 
    public function ‪setLastDisplayedPageIndex(int ‪$lastDisplayedPageIndex)
    {
        $this->lastDisplayedPageIndex = ‪$lastDisplayedPageIndex;
    }
 
    public function ‪getFormValues(): array
    {
        return ‪$this->formValues;
    }
 
    public function ‪setFormValue(string $propertyPath, $value)
    {
        $this->formValues = ‪ArrayUtility::setValueByPath(
            $this->formValues,
            $propertyPath,
            $value,
            '.'
        );
    }
 
    public function ‪getFormValue(string $propertyPath)
    {
        try {
            return ‪ArrayUtility::getValueByPath($this->formValues, $propertyPath, '.');
        } catch (MissingArrayPathException $exception) {
            return null;
        }
    }
}