TYPO3\CMS\Form\Domain\Model\FormElements\FormElementInterface Interface Reference

Inheritance diagram for TYPO3\CMS\Form\Domain\Model\FormElements\FormElementInterface:

Public Member Functions
	initializeFormElement ()
string	getUniqueIdentifier ()
mixed	getDefaultValue ()
	setDefaultValue ($defaultValue)
	setProperty (string $key, $value)
	getProperties ()
	setRenderingOption (string $key, $value)
SplObjectStorage< ValidatorInterface >	getValidators ()
	addValidator (ValidatorInterface $validator)
	setDataType (string $dataType)
	isRequired ()
‪Public Member Functions inherited from ‪TYPO3\CMS\Form\Domain\Model\Renderable\RenderableInterface
CompositeRenderableInterface null	getParentRenderable ()
	setParentRenderable (CompositeRenderableInterface $renderable)
	setIndex (int $index)
	getIndex ()
	onRemoveFromParentRenderable ()
	registerInFormIfPossible ()
	getTemplateName ()
	isEnabled ()
‪Public Member Functions inherited from ‪TYPO3\CMS\Form\Domain\Model\Renderable\RootRenderableInterface
	getType ()
	getIdentifier ()
	getLabel ()
string	getRendererClassName ()
array	getRenderingOptions ()

Detailed Description

A base form element interface, which can be the starting point for creating custom (PHP-based) Form Elements.

A FormElement is a part of a Page, which in turn is part of a FormDefinition. See FormDefinition for an in-depth explanation.

Often, you should rather subclass AbstractFormElement instead of implementing this interface.

Scope: frontend

Definition at line 39 of file FormElementInterface.php.

Member Function Documentation

addValidator()

TYPO3\CMS\Form\Domain\Model\FormElements\FormElementInterface::addValidator

(

ValidatorInterface

$validator

)

Registers a validator for this element

getDefaultValue()

mixed TYPO3\CMS\Form\Domain\Model\FormElements\FormElementInterface::getDefaultValue

(

)

Get the default value with which the Form Element should be initialized during display.

Returns

‪mixed the default value for this Form Element

Implemented in TYPO3\CMS\Form\Domain\Model\FormElements\AbstractFormElement, TYPO3\CMS\Form\Domain\Model\FormElements\Section, and TYPO3\CMS\Form\Domain\Model\FormElements\UnknownFormElement.

getProperties()

TYPO3\CMS\Form\Domain\Model\FormElements\FormElementInterface::getProperties

(

)

Get all element-specific configuration properties

Implemented in TYPO3\CMS\Form\Domain\Model\FormElements\AbstractFormElement, TYPO3\CMS\Form\Domain\Model\FormElements\UnknownFormElement, and TYPO3\CMS\Form\Domain\Model\FormElements\Section.

Referenced by TYPO3\CMS\Form\ViewHelpers\RenderFormValueViewHelper\processElementValue().

getUniqueIdentifier()

string TYPO3\CMS\Form\Domain\Model\FormElements\FormElementInterface::getUniqueIdentifier

(

)

Returns a unique identifier of this element. While element identifiers are only unique within one form, this includes the identifier of the form itself, making it "globally" unique

Returns

‪string the "globally" unique identifier of this element

Implemented in TYPO3\CMS\Form\Domain\Model\FormElements\AbstractFormElement, TYPO3\CMS\Form\Domain\Model\FormElements\Section, and TYPO3\CMS\Form\Domain\Model\FormElements\UnknownFormElement.

getValidators()

SplObjectStorage<ValidatorInterface> TYPO3\CMS\Form\Domain\Model\FormElements\FormElementInterface::getValidators

(

)

Returns the child validators of the ConjunctionValidator that is registered for this element

Returns

‪\SplObjectStorage<ValidatorInterface>

Referenced by TYPO3\CMS\Form\Domain\Model\FormElements\Section\isRequired(), and TYPO3\CMS\Form\Domain\Model\FormElements\AbstractFormElement\isRequired().

initializeFormElement()

TYPO3\CMS\Form\Domain\Model\FormElements\FormElementInterface::initializeFormElement

(

)

Will be called as soon as the element is (tried to be) added to a form

See also

‪registerInFormIfPossible()

Implemented in TYPO3\CMS\Form\Domain\Model\FormElements\AbstractFormElement, TYPO3\CMS\Form\Domain\Model\FormElements\UnknownFormElement, TYPO3\CMS\Form\Domain\Model\FormElements\Section, TYPO3\CMS\Form\Domain\Model\FormElements\Date, TYPO3\CMS\Form\Domain\Model\FormElements\DatePicker, and TYPO3\CMS\Form\Domain\Model\FormElements\FileUpload.

isRequired()

TYPO3\CMS\Form\Domain\Model\FormElements\FormElementInterface::isRequired

(

)

Whether or not this element is required

Implemented in TYPO3\CMS\Form\Domain\Model\FormElements\AbstractFormElement, TYPO3\CMS\Form\Domain\Model\FormElements\Section, and TYPO3\CMS\Form\Domain\Model\FormElements\UnknownFormElement.

setDataType()

TYPO3\CMS\Form\Domain\Model\FormElements\FormElementInterface::setDataType

(

string

$dataType

)

Set the target data type for this element

Parameters

string

$dataType

‪the target data type

Referenced by TYPO3\CMS\Form\Domain\Model\FormElements\FileUpload\initializeFormElement(), TYPO3\CMS\Form\Domain\Model\FormElements\Date\initializeFormElement(), and TYPO3\CMS\Form\Domain\Model\FormElements\DatePicker\initializeFormElement().

setDefaultValue()

TYPO3\CMS\Form\Domain\Model\FormElements\FormElementInterface::setDefaultValue

(

$defaultValue

)

Set the default value with which the Form Element should be initialized during display.

Parameters

mixed

$defaultValue

‪the default value for this Form Element

Implemented in TYPO3\CMS\Form\Domain\Model\FormElements\AbstractFormElement, TYPO3\CMS\Form\Domain\Model\FormElements\Section, and TYPO3\CMS\Form\Domain\Model\FormElements\UnknownFormElement.

setProperty()

TYPO3\CMS\Form\Domain\Model\FormElements\FormElementInterface::setProperty	(	string	$key,
			$value
	)

Set an element-specific configuration property.

Parameters

mixed

$value

Implemented in TYPO3\CMS\Form\Domain\Model\FormElements\AbstractFormElement, TYPO3\CMS\Form\Domain\Model\FormElements\Section, and TYPO3\CMS\Form\Domain\Model\FormElements\UnknownFormElement.

setRenderingOption()

TYPO3\CMS\Form\Domain\Model\FormElements\FormElementInterface::setRenderingOption	(	string	$key,
			$value
	)

Set a rendering option

Parameters

mixed

$value