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

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

Public Member Functions
RenderableInterface[]	getRenderablesRecursively ()
	registerInFormIfPossible ()
	onRemoveFromParentRenderable ()
‪Public Member Functions inherited from ‪TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable
	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 ()
	getIndex ()
	setIndex (int $index)
	getLabel ()
	setLabel (string $label)
	getTemplateName ()
	isEnabled ()
RenderableVariantInterface[]	getVariants ()
	createVariant (array $options)
	addVariant (RenderableVariantInterface $variant)
	applyVariant (RenderableVariantInterface $variant)

Protected Member Functions
	addRenderable (RenderableInterface $renderable)
	moveRenderableBefore (RenderableInterface $renderableToMove, RenderableInterface $referenceRenderable)
	moveRenderableAfter (RenderableInterface $renderableToMove, RenderableInterface $referenceRenderable)
	removeRenderable (RenderableInterface $renderableToRemove)

Protected Attributes
TYPO3 CMS Form Domain Model Renderable RenderableInterface[]	$renderables = array( )
‪Protected Attributes inherited from ‪TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable
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 CompositeRenderableInterface, i.e. have child renderable elements.

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

Definition at line 33 of file AbstractCompositeRenderable.php.

Member Function Documentation

addRenderable()

TYPO3\CMS\Form\Domain\Model\Renderable\AbstractCompositeRenderable::addRenderable ( RenderableInterface  $renderable )

protected

Add a renderable to the list of child renderables.

This function will be wrapped by the subclasses, f.e. with an "addPage" or "addElement" method with the correct type hint.

Parameters

RenderableInterface

$renderable

Exceptions

FormDefinitionConsistencyException

Definition at line 51 of file AbstractCompositeRenderable.php.

References TYPO3\CMS\Form\Domain\Model\Renderable\RootRenderableInterface\getIdentifier(), TYPO3\CMS\Form\Domain\Model\Renderable\RenderableInterface\getParentRenderable(), TYPO3\CMS\Form\Domain\Model\Renderable\RenderableInterface\setIndex(), and TYPO3\CMS\Form\Domain\Model\Renderable\RenderableInterface\setParentRenderable().

Referenced by TYPO3\CMS\Form\Domain\Model\FormElements\AbstractSection\addElement(), and TYPO3\CMS\Form\Domain\Model\FormDefinition\addPage().

getRenderablesRecursively()

RenderableInterface [] TYPO3\CMS\Form\Domain\Model\Renderable\AbstractCompositeRenderable::getRenderablesRecursively

(

)

Returns all RenderableInterface instances of this composite renderable recursively

Returns

‪RenderableInterface[]

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

Definition at line 140 of file AbstractCompositeRenderable.php.

References TYPO3\CMS\Form\Domain\Model\Renderable\AbstractCompositeRenderable\$renderables.

Referenced by TYPO3\CMS\Form\Domain\Model\FormElements\AbstractSection\getElementsRecursively(), and TYPO3\CMS\Form\Domain\Factory\AbstractFormFactory\triggerFormBuildingFinished().

moveRenderableAfter()

TYPO3\CMS\Form\Domain\Model\Renderable\AbstractCompositeRenderable::moveRenderableAfter ( RenderableInterface  $renderableToMove, RenderableInterface  $referenceRenderable  )

protected

Move $renderableToMove after $referenceRenderable

This function will be wrapped by the subclasses, f.e. with an "movePageAfter" or "moveElementAfter" method with the correct type hint.

Parameters

RenderableInterface	$renderableToMove
RenderableInterface	$referenceRenderable

Exceptions

FormDefinitionConsistencyException

Definition at line 108 of file AbstractCompositeRenderable.php.

References TYPO3\CMS\Form\Domain\Model\Renderable\RenderableInterface\getParentRenderable(), and TYPO3\CMS\Form\Domain\Model\Renderable\RenderableInterface\setIndex().

Referenced by TYPO3\CMS\Form\Domain\Model\FormElements\AbstractSection\moveElementAfter(), and TYPO3\CMS\Form\Domain\Model\FormDefinition\movePageAfter().

moveRenderableBefore()

TYPO3\CMS\Form\Domain\Model\Renderable\AbstractCompositeRenderable::moveRenderableBefore ( RenderableInterface  $renderableToMove, RenderableInterface  $referenceRenderable  )

protected

Move $renderableToMove before $referenceRenderable

This function will be wrapped by the subclasses, f.e. with an "movePageBefore" or "moveElementBefore" method with the correct type hint.

Parameters

RenderableInterface	$renderableToMove
RenderableInterface	$referenceRenderable

Exceptions

FormDefinitionConsistencyException

Definition at line 72 of file AbstractCompositeRenderable.php.

References TYPO3\CMS\Form\Domain\Model\Renderable\RenderableInterface\getParentRenderable(), and TYPO3\CMS\Form\Domain\Model\Renderable\RenderableInterface\setIndex().

Referenced by TYPO3\CMS\Form\Domain\Model\FormElements\AbstractSection\moveElementBefore(), and TYPO3\CMS\Form\Domain\Model\FormDefinition\movePageBefore().

onRemoveFromParentRenderable()

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

(

)

This function is called after a renderable has been removed from its parent renderable. This just passes the event down to all child renderables of this composite renderable.

Reimplemented from TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable.

Definition at line 201 of file AbstractCompositeRenderable.php.

registerInFormIfPossible()

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

(

)

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

Reimplemented from TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable.

Definition at line 186 of file AbstractCompositeRenderable.php.

removeRenderable()

TYPO3\CMS\Form\Domain\Model\Renderable\AbstractCompositeRenderable::removeRenderable ( RenderableInterface  $renderableToRemove )

protected

Remove a renderable from this renderable.

This function will be wrapped by the subclasses, f.e. with an "removePage" or "removeElement" method with the correct type hint.

Parameters

RenderableInterface

$renderableToRemove

Exceptions

FormDefinitionConsistencyException

Definition at line 162 of file AbstractCompositeRenderable.php.

References TYPO3\CMS\Form\Domain\Model\Renderable\RenderableInterface\getParentRenderable(), and TYPO3\CMS\Form\Domain\Model\Renderable\RenderableInterface\onRemoveFromParentRenderable().

Referenced by TYPO3\CMS\Form\Domain\Model\FormElements\AbstractSection\removeElement(), and TYPO3\CMS\Form\Domain\Model\FormDefinition\removePage().

Member Data Documentation

$renderables

TYPO3 CMS Form Domain Model Renderable RenderableInterface [] TYPO3\CMS\Form\Domain\Model\Renderable\AbstractCompositeRenderable::$renderables = array( )

protected

array of child renderables

Definition at line 39 of file AbstractCompositeRenderable.php.

Referenced by TYPO3\CMS\Form\Domain\Model\FormElements\AbstractSection\getElements(), and TYPO3\CMS\Form\Domain\Model\Renderable\AbstractCompositeRenderable\getRenderablesRecursively().