TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable Class Reference

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

Public Member Functions
	getType ()
	getIdentifier ()
	setIdentifier (string $identifier)
	setOptions (array $options, bool $resetValidators=false)
	createValidator (string $validatorIdentifier, array $options=[])
	addValidator (ValidatorInterface $validator)
	getValidators ()
	setDataType (string $dataType)
	getRendererClassName ()
	getRenderingOptions ()
mixed	setRenderingOption (string $key, $value)
CompositeRenderableInterface null	getParentRenderable ()
	setParentRenderable (CompositeRenderableInterface $parentRenderable)
	getRootForm ()
	registerInFormIfPossible ()
	onRemoveFromParentRenderable ()
	getIndex ()
	setIndex (int $index)
	getLabel ()
	setLabel (string $label)
	getTemplateName ()
	isEnabled ()
RenderableVariantInterface[]	getVariants ()
	createVariant (array $options)
	addVariant (RenderableVariantInterface $variant)
	applyVariant (RenderableVariantInterface $variant)

Protected Attributes
string	$type
string	$identifier
CompositeRenderableInterface null	$parentRenderable
string	$label = ''
array	$renderingOptions = array( )
int	$index = 0
string	$templateName = ''
array	$variants = array( )
ValidatorResolver	$validatorResolver = null

Detailed Description

Convenience base class which implements common functionality for most classes which implement RenderableInterface.

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

Definition at line 41 of file AbstractRenderable.php.

Member Function Documentation

addValidator()

TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable::addValidator

(

ValidatorInterface

$validator

)

Add a validator to the element.

Definition at line 202 of file AbstractRenderable.php.

References TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable\getIdentifier(), and TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable\getRootForm().

Referenced by TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable\createValidator().

addVariant()

TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable::addVariant

(

RenderableVariantInterface

$variant

)

Adds the specified variant to this form element

Implements TYPO3\CMS\Form\Domain\Model\Renderable\VariableRenderableInterface.

Definition at line 415 of file AbstractRenderable.php.

References TYPO3\CMS\Form\Domain\Model\Renderable\RenderableVariantInterface\getIdentifier().

Referenced by TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable\createVariant().

applyVariant()

TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable::applyVariant

(

RenderableVariantInterface

$variant

)

Apply the specified variant to this form element regardless of their conditions

Definition at line 424 of file AbstractRenderable.php.

References TYPO3\CMS\Form\Domain\Model\Renderable\RenderableVariantInterface\apply().

createValidator()

TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable::createValidator	(	string	$validatorIdentifier,
		array	$options = []
	)

Create a validator for the element.

Exceptions

ValidatorPresetNotFoundException

Definition at line 176 of file AbstractRenderable.php.

References $validator, TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable\addValidator(), and TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable\getRootForm().

Referenced by TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable\setOptions().

createVariant()

TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable::createVariant

(

array

$options

)

Definition at line 401 of file AbstractRenderable.php.

References TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable\$identifier, and TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable\addVariant().

Referenced by TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable\setOptions(), and TYPO3\CMS\Form\Domain\Model\FormDefinition\setOptions().

getIdentifier()

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

(

)

Get the identifier of the element

Implements TYPO3\CMS\Form\Domain\Model\Renderable\RootRenderableInterface.

Definition at line 106 of file AbstractRenderable.php.

References TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable\$identifier.

Referenced by TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable\addValidator(), TYPO3\CMS\Form\Domain\Runtime\FormRuntime\getHoneypotNameFromSession(), TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable\getValidators(), TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable\setDataType(), TYPO3\CMS\Form\Domain\Runtime\FormRuntime\setHoneypotNameInSession(), and TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable\setOptions().

getIndex()

TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable::getIndex

(

)

Get the index of the renderable

Implements TYPO3\CMS\Form\Domain\Model\Renderable\RenderableInterface.

Definition at line 342 of file AbstractRenderable.php.

References TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable\$index.

Referenced by TYPO3\CMS\Form\Domain\Runtime\FormRuntime\getNextPage(), TYPO3\CMS\Form\Domain\Runtime\FormRuntime\getPreviousEnabledPage(), and TYPO3\CMS\Form\Domain\Runtime\FormRuntime\getPreviousPage().

getLabel()

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

(

)

Get the label of the renderable

Implements TYPO3\CMS\Form\Domain\Model\Renderable\RootRenderableInterface.

Definition at line 360 of file AbstractRenderable.php.

References TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable\$label.

getParentRenderable()

CompositeRenderableInterface null TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable::getParentRenderable

(

)

Get the parent renderable

Returns

‪CompositeRenderableInterface|null

Implements TYPO3\CMS\Form\Domain\Model\Renderable\RenderableInterface.

Definition at line 267 of file AbstractRenderable.php.

References TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable\$parentRenderable.

getRendererClassName()

TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable::getRendererClassName

(

)

Get the classname of the renderer

Implements TYPO3\CMS\Form\Domain\Model\Renderable\RootRenderableInterface.

Reimplemented in TYPO3\CMS\Form\Domain\Model\FormDefinition.

Definition at line 231 of file AbstractRenderable.php.

References TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable\getRootForm().

getRenderingOptions()

TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable::getRenderingOptions

(

)

Get all rendering options

Implements TYPO3\CMS\Form\Domain\Model\Renderable\RootRenderableInterface.

Definition at line 239 of file AbstractRenderable.php.

References TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable\$renderingOptions.

getRootForm()

TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable::getRootForm

(

)

Get the root form this element belongs to

Exceptions

FormDefinitionConsistencyException

Definition at line 286 of file AbstractRenderable.php.

References TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable\$parentRenderable, and TYPO3\CMS\Form\Domain\Model\Renderable\RenderableInterface\getParentRenderable().

Referenced by TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable\addValidator(), TYPO3\CMS\Form\Domain\Model\FormElements\AbstractSection\createElement(), TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable\createValidator(), TYPO3\CMS\Form\Domain\Model\FormElements\AbstractFormElement\getDefaultValue(), TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable\getRendererClassName(), TYPO3\CMS\Form\Domain\Model\FormElements\UnknownFormElement\getUniqueIdentifier(), TYPO3\CMS\Form\Domain\Model\FormElements\Section\getUniqueIdentifier(), TYPO3\CMS\Form\Domain\Model\FormElements\AbstractFormElement\getUniqueIdentifier(), TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable\getValidators(), TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable\onRemoveFromParentRenderable(), TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable\registerInFormIfPossible(), TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable\setDataType(), TYPO3\CMS\Form\Domain\Model\FormElements\AbstractFormElement\setDefaultValue(), and TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable\setOptions().

getTemplateName()

TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable::getTemplateName

(

)

Get the templateName name of the renderable

Implements TYPO3\CMS\Form\Domain\Model\Renderable\RenderableInterface.

Reimplemented in TYPO3\CMS\Form\Domain\Model\FormElements\UnknownFormElement.

Definition at line 376 of file AbstractRenderable.php.

getType()

TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable::getType

(

)

Get the type of the renderable

Implements TYPO3\CMS\Form\Domain\Model\Renderable\RootRenderableInterface.

Definition at line 98 of file AbstractRenderable.php.

References TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable\$type.

getValidators()

TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable::getValidators

(

)

Get all validators on the element

Definition at line 213 of file AbstractRenderable.php.

References TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable\getIdentifier(), and TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable\getRootForm().

getVariants()

RenderableVariantInterface [] TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable::getVariants

(

)

Get all rendering variants

Returns

‪RenderableVariantInterface[]

Implements TYPO3\CMS\Form\Domain\Model\Renderable\VariableRenderableInterface.

Definition at line 396 of file AbstractRenderable.php.

References TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable\$variants.

isEnabled()

TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable::isEnabled

(

)

Returns whether this renderable is enabled

Implements TYPO3\CMS\Form\Domain\Model\Renderable\RenderableInterface.

Definition at line 386 of file AbstractRenderable.php.

onRemoveFromParentRenderable()

TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable::onRemoveFromParentRenderable

(

)

Triggered when the renderable is removed from it's parent

Implements TYPO3\CMS\Form\Domain\Model\Renderable\RenderableInterface.

Reimplemented in TYPO3\CMS\Form\Domain\Model\Renderable\AbstractCompositeRenderable.

Definition at line 318 of file AbstractRenderable.php.

References $GLOBALS, and TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable\getRootForm().

registerInFormIfPossible()

TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable::registerInFormIfPossible

(

)

Register this element at the parent form, if there is a connection to the parent form.

Implements TYPO3\CMS\Form\Domain\Model\Renderable\RenderableInterface.

Reimplemented in TYPO3\CMS\Form\Domain\Model\Renderable\AbstractCompositeRenderable.

Definition at line 304 of file AbstractRenderable.php.

References TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable\getRootForm().

Referenced by TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable\setParentRenderable().

setDataType()

TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable::setDataType

(

string

$dataType

)

Set the datatype

Definition at line 222 of file AbstractRenderable.php.

References TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable\getIdentifier(), and TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable\getRootForm().

setIdentifier()

TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable::setIdentifier

(

string

$identifier

)

Set the identifier of the element

Definition at line 114 of file AbstractRenderable.php.

References TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable\$identifier.

Referenced by TYPO3\CMS\Form\Tests\Functional\Domain\Model\Renderable\AbstractRenderableTest\buildAbstractRenderable().

setIndex()

TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable::setIndex

(

int

$index

)

Set the index of the renderable

Implements TYPO3\CMS\Form\Domain\Model\Renderable\RenderableInterface.

Definition at line 352 of file AbstractRenderable.php.

References TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable\$index.

setLabel()

TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable::setLabel

(

string

$label

)

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

Definition at line 368 of file AbstractRenderable.php.

References TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable\$label.

Referenced by TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable\setOptions(), and TYPO3\CMS\Form\Domain\Model\FormDefinition\setOptions().

setOptions()

TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable::setOptions	(	array	$options,
		bool	$resetValidators = false
	)

Set multiple properties of this object at once. Every property which has a corresponding set* method can be set using the passed $options array.

Implements TYPO3\CMS\Form\Domain\Model\Renderable\VariableRenderableInterface.

Reimplemented in TYPO3\CMS\Form\Domain\Model\FormElements\AbstractFormElement, TYPO3\CMS\Form\Domain\Model\FormElements\Section, and TYPO3\CMS\Form\Domain\Model\FormDefinition.

Definition at line 124 of file AbstractRenderable.php.

References TYPO3\CMS\Core\Utility\ArrayUtility\assertAllArrayKeysAreValid(), TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable\createValidator(), TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable\createVariant(), TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable\getIdentifier(), TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable\getRootForm(), TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable\setLabel(), and TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable\setRenderingOption().

setParentRenderable()

TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable::setParentRenderable

(

CompositeRenderableInterface

$parentRenderable

)

Set the parent renderable

Implements TYPO3\CMS\Form\Domain\Model\Renderable\RenderableInterface.

Reimplemented in TYPO3\CMS\Form\Domain\Model\FormElements\Page.

Definition at line 275 of file AbstractRenderable.php.

References TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable\$parentRenderable, and TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable\registerInFormIfPossible().

Referenced by TYPO3\CMS\Form\Tests\Functional\Domain\Model\Renderable\AbstractRenderableTest\buildAbstractRenderable().

setRenderingOption()

mixed TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable::setRenderingOption	(	string	$key,
			$value
	)

Set the rendering option $key to $value.

Parameters

mixed

$value

Returns

‪mixed

Definition at line 250 of file AbstractRenderable.php.

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

Referenced by TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable\setOptions(), and TYPO3\CMS\Form\Domain\Model\FormDefinition\setOptions().

Member Data Documentation

$identifier

string TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable::$identifier

protected

The identifier of this renderable

Definition at line 55 of file AbstractRenderable.php.

Referenced by TYPO3\CMS\Form\Domain\Model\FormElements\UnknownFormElement\__construct(), TYPO3\CMS\Form\Domain\Model\FormElements\AbstractSection\__construct(), TYPO3\CMS\Form\Domain\Model\FormElements\Page\__construct(), TYPO3\CMS\Form\Domain\Model\FormElements\AbstractFormElement\__construct(), TYPO3\CMS\Form\Domain\Model\FormElements\AbstractSection\createElement(), TYPO3\CMS\Form\Domain\Model\FormDefinition\createPage(), TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable\createVariant(), TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable\getIdentifier(), and TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable\setIdentifier().

$index

int TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable::$index = 0

protected

The position of this renderable inside the parent renderable.

Definition at line 79 of file AbstractRenderable.php.

Referenced by TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable\getIndex(), TYPO3\CMS\Form\Domain\Model\FormDefinition\getPageByIndex(), and TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable\setIndex().

$label

string TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable::$label = ''

protected

The label of this renderable

Definition at line 67 of file AbstractRenderable.php.

Referenced by TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable\getLabel(), and TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable\setLabel().

$parentRenderable

CompositeRenderableInterface null TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable::$parentRenderable

protected

The parent renderable

Definition at line 61 of file AbstractRenderable.php.

Referenced by TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable\getParentRenderable(), TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable\getRootForm(), TYPO3\CMS\Form\Domain\Model\FormElements\Page\setParentRenderable(), and TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable\setParentRenderable().

$renderingOptions

array TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable::$renderingOptions = array( )

protected

associative array of rendering options

Definition at line 73 of file AbstractRenderable.php.

Referenced by TYPO3\CMS\Form\Domain\Model\FormElements\AbstractSection\createElement(), and TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable\getRenderingOptions().

$templateName

string TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable::$templateName = ''

protected

The name of the template file of the renderable.

Definition at line 85 of file AbstractRenderable.php.

$type

string TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable::$type

protected

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.

Definition at line 49 of file AbstractRenderable.php.

Referenced by TYPO3\CMS\Form\Domain\Model\FormElements\UnknownFormElement\__construct(), TYPO3\CMS\Form\Domain\Model\FormElements\AbstractSection\__construct(), TYPO3\CMS\Form\Domain\Model\FormElements\Page\__construct(), TYPO3\CMS\Form\Domain\Model\FormElements\AbstractFormElement\__construct(), TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable\getType(), and TYPO3\CMS\Form\Domain\Model\FormDefinition\initializeFromFormDefaults().

$validatorResolver

ValidatorResolver TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable::$validatorResolver = null

protected

Definition at line 93 of file AbstractRenderable.php.

$variants

array TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable::$variants = array( )

protected

associative array of rendering variants

Definition at line 91 of file AbstractRenderable.php.

Referenced by TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable\getVariants().