TYPO3\CMS\Form\Domain\Model\Renderable\RootRenderableInterface Interface Reference

Inheritance diagram for TYPO3\CMS\Form\Domain\Model\Renderable\RootRenderableInterface:

Public Member Functions
	getType ()
	getIdentifier ()
	getLabel ()
string	getRendererClassName ()
array	getRenderingOptions ()

Detailed Description

Base interface which all parts of a form must adhere to.

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

Definition at line 30 of file RootRenderableInterface.php.

Member Function Documentation

getIdentifier()

TYPO3\CMS\Form\Domain\Model\Renderable\RootRenderableInterface::getIdentifier

(

)

The identifier of this renderable

Implemented in TYPO3\CMS\Form\Domain\Runtime\FormRuntime, and TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable.

Referenced by TYPO3\CMS\Form\Domain\Model\Renderable\AbstractCompositeRenderable\addRenderable(), TYPO3\CMS\Form\Mvc\Property\PropertyMappingConfiguration\adjustPropertyMappingForFileUploadsAtRuntime(), TYPO3\CMS\Form\Mvc\Property\PropertyMappingConfiguration\afterBuildingFinished(), TYPO3\CMS\Form\Hooks\FormElementHooks\afterSubmit(), TYPO3\CMS\Form\Hooks\FormElementHooks\beforeRendering(), TYPO3\CMS\Form\Domain\Model\FormDefinition\registerRenderable(), TYPO3\CMS\Form\Service\TranslationService\translateFormElementError(), TYPO3\CMS\Form\Service\TranslationService\translateFormElementValue(), and TYPO3\CMS\Form\Domain\Model\FormDefinition\unregisterRenderable().

getLabel()

TYPO3\CMS\Form\Domain\Model\Renderable\RootRenderableInterface::getLabel

(

)

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

Implemented in TYPO3\CMS\Form\Domain\Runtime\FormRuntime, and TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable.

Referenced by TYPO3\CMS\Form\Service\TranslationService\translateFormElementValue().

getRendererClassName()

string TYPO3\CMS\Form\Domain\Model\Renderable\RootRenderableInterface::getRendererClassName

(

)

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

Returns

‪string the renderer class name

Implemented in TYPO3\CMS\Form\Domain\Runtime\FormRuntime, TYPO3\CMS\Form\Domain\Model\FormDefinition, and TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable.

getRenderingOptions()

array TYPO3\CMS\Form\Domain\Model\Renderable\RootRenderableInterface::getRenderingOptions

(

)

Get all rendering options

Returns

‪array associative array of rendering options

Implemented in TYPO3\CMS\Form\Domain\Runtime\FormRuntime, and TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable.

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

getType()

TYPO3\CMS\Form\Domain\Model\Renderable\RootRenderableInterface::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.

Implemented in TYPO3\CMS\Form\Domain\Runtime\FormRuntime, and TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable.

Referenced by TYPO3\CMS\Form\Mvc\Property\PropertyMappingConfiguration\afterBuildingFinished(), TYPO3\CMS\Form\Hooks\FormElementHooks\afterSubmit(), TYPO3\CMS\Form\Hooks\FormElementHooks\beforeRendering(), and TYPO3\CMS\Form\Service\TranslationService\translateFormElementValue().