FormElementInterface.php

Go to the documentation of this file.

<?php
declare(strict_types = 1);
namespace TYPO3\CMS\Form\Domain\Model\FormElements;

/*
 * This file is part of the TYPO3 CMS project.
 *
 * It originated from the Neos.Form package (www.neos.io)
 *
 * 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!
 */

use TYPO3\CMS\Extbase\Validation\Validator\ValidatorInterface;
use TYPO3\CMS\Form\Domain\Model\Renderable\RenderableInterface;
use TYPO3\CMS\Form\Domain\Runtime\FormRuntime;

interface FormElementInterface extends RenderableInterface
{

    public function initializeFormElement();

    public function getUniqueIdentifier(): string;

    public function getDefaultValue();

    public function setDefaultValue($defaultValue);

    public function setProperty(string $key, $value);

    public function getProperties(): array;

    public function setRenderingOption(string $key, $value);

    public function getValidators(): \SplObjectStorage;

    public function addValidator(ValidatorInterface $validator);

    public function setDataType(string $dataType);

    public function isRequired(): bool;

    public function onSubmit(FormRuntime $formRuntime, &$elementValue, array $requestArguments = []);
}