TYPO3\CMS\Form\Domain\Model\FormElements\Page Class Reference

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

Public Member Functions
	__construct (string $identifier, string $type='Page')
	setParentRenderable (CompositeRenderableInterface $parentRenderable)
‪Public Member Functions inherited from ‪TYPO3\CMS\Form\Domain\Model\FormElements\AbstractSection
FormElementInterface[]	getElements ()
FormElementInterface[]	getElementsRecursively ()
	addElement (FormElementInterface $formElement)
FormElementInterface	createElement (string $identifier, string $typeName)
	moveElementBefore (FormElementInterface $elementToMove, FormElementInterface $referenceElement)
	moveElementAfter (FormElementInterface $elementToMove, FormElementInterface $referenceElement)
	removeElement (FormElementInterface $elementToRemove)
‪Public Member Functions inherited from ‪TYPO3\CMS\Form\Domain\Model\Renderable\AbstractCompositeRenderable
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 ()
	getRootForm ()
	getIndex ()
	setIndex (int $index)
	getLabel ()
	setLabel (string $label)
	getTemplateName ()
	isEnabled ()
RenderableVariantInterface[]	getVariants ()
	createVariant (array $options)
	addVariant (RenderableVariantInterface $variant)
	applyVariant (RenderableVariantInterface $variant)

Additional Inherited Members
‪Protected Member Functions inherited from ‪TYPO3\CMS\Form\Domain\Model\Renderable\AbstractCompositeRenderable
	addRenderable (RenderableInterface $renderable)
	moveRenderableBefore (RenderableInterface $renderableToMove, RenderableInterface $referenceRenderable)
	moveRenderableAfter (RenderableInterface $renderableToMove, RenderableInterface $referenceRenderable)
	removeRenderable (RenderableInterface $renderableToRemove)
‪Protected Attributes inherited from ‪TYPO3\CMS\Form\Domain\Model\Renderable\AbstractCompositeRenderable
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

A Page, being part of a bigger FormDefinition. It contains numerous FormElements as children.

A FormDefinition consists of multiple Pages, where only one page is visible at any given time.

Most of the API of this object is implemented in AbstractSection, so make sure to review this class as well.

Please see FormDefinition for an in-depth explanation.

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

Definition at line 43 of file Page.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Form\Domain\Model\FormElements\Page::__construct	(	string	$identifier,
		string	$type = 'Page'
	)

Constructor. Needs this Page's identifier

Parameters

string	$identifier	‪The Page's identifier
string	$type	‪The Page's type

Exceptions

Reimplemented from TYPO3\CMS\Form\Domain\Model\FormElements\AbstractSection.

Definition at line 52 of file Page.php.

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

Member Function Documentation

setParentRenderable()

TYPO3\CMS\Form\Domain\Model\FormElements\Page::setParentRenderable

(

CompositeRenderableInterface

$parentRenderable

)

Set the parent renderable

Exceptions

FormException

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

Definition at line 62 of file Page.php.

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