‪TYPO3CMS  10.4
TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable Class Reference
Inheritance diagram for TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable:
TYPO3\CMS\Form\Domain\Model\Renderable\RenderableInterface TYPO3\CMS\Form\Domain\Model\Renderable\VariableRenderableInterface TYPO3\CMS\Form\Domain\Model\Renderable\RootRenderableInterface TYPO3\CMS\Form\Domain\Model\FormElements\AbstractFormElement TYPO3\CMS\Form\Domain\Model\FormElements\UnknownFormElement TYPO3\CMS\Form\Domain\Model\Renderable\AbstractCompositeRenderable TYPO3\CMS\Form\Domain\Model\FormElements\Date TYPO3\CMS\Form\Domain\Model\FormElements\DatePicker TYPO3\CMS\Form\Domain\Model\FormElements\FileUpload TYPO3\CMS\Form\Domain\Model\FormElements\GenericFormElement TYPO3\CMS\Form\Domain\Model\FormDefinition TYPO3\CMS\Form\Domain\Model\FormElements\AbstractSection TYPO3\CMS\Form\Domain\Model\FormElements\Page TYPO3\CMS\Form\Domain\Model\FormElements\Section TYPO3\CMS\Form\Domain\Model\FormElements\GridRow

Public Member Functions

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

Protected Attributes

string $type
 
string $identifier
 
CompositeRenderableInterface $parentRenderable
 
string $label = ''
 
array $renderingOptions = array( )
 
int $index = 0
 
string $templateName = ''
 
array $variants = array( )
 

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)

◆ addVariant()

TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable::addVariant ( RenderableVariantInterface  $variant)

◆ applyVariant()

TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable::applyVariant ( RenderableVariantInterface  $variant)

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

Parameters
RenderableVariantInterface$variant

Definition at line 485 of file AbstractRenderable.php.

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

◆ createValidator()

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

◆ createVariant()

◆ getIdentifier()

◆ getIndex()

◆ getLabel()

string TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable::getLabel ( )

Get the label of the renderable

Returns
‪string

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

Definition at line 396 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 296 of file AbstractRenderable.php.

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

◆ getRendererClassName()

string TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable::getRendererClassName ( )

◆ getRenderingOptions()

array TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable::getRenderingOptions ( )

◆ getRootForm()

FormDefinition TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable::getRootForm ( )

◆ getTemplateName()

string TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable::getTemplateName ( )

Get the templateName name of the renderable

Returns
‪string

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

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

Definition at line 426 of file AbstractRenderable.php.

◆ getType()

string TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable::getType ( )

Get the type of the renderable

Returns
‪string

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

Definition at line 99 of file AbstractRenderable.php.

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

◆ getValidators()

SplObjectStorage TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable::getValidators ( )

◆ getVariants()

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

◆ isEnabled()

bool TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable::isEnabled ( )

Returns whether this renderable is enabled

Returns
‪bool

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

Definition at line 438 of file AbstractRenderable.php.

◆ onRemoveFromParentRenderable()

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

◆ registerInFormIfPossible()

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

◆ setDataType()

TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable::setDataType ( string  $dataType)

◆ setDefaultValue()

◆ setIdentifier()

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

Set the identifier of the element

Parameters
string$identifier

Definition at line 119 of file AbstractRenderable.php.

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

◆ setIndex()

TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable::setIndex ( int  $index)

Set the index of the renderable

Parameters
int$index

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

Definition at line 386 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

Parameters
string$label

Definition at line 406 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()

◆ setParentRenderable()

TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable::setParentRenderable ( CompositeRenderableInterface  $parentRenderable)

◆ setProperty()

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

◆ setRenderingOption()

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

Member Data Documentation

◆ $identifier

◆ $index

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

◆ $label

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

◆ $parentRenderable

◆ $renderingOptions

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

◆ $templateName

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

The name of the template file of the renderable.

Definition at line 86 of file AbstractRenderable.php.

◆ $type

◆ $variants

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

associative array of rendering variants

Definition at line 92 of file AbstractRenderable.php.

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