TYPO3 CMS  TYPO3_7-6
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
TYPO3\CMS\Form\Domain\Model\Element Class Reference
Inheritance diagram for TYPO3\CMS\Form\Domain\Model\Element:
TYPO3\CMS\Extbase\DomainObject\AbstractEntity TYPO3\CMS\Extbase\DomainObject\AbstractDomainObject TYPO3\CMS\Extbase\DomainObject\DomainObjectInterface TYPO3\CMS\Extbase\Persistence\ObjectMonitoringInterface

Public Member Functions

 __construct ()
 
 getAdditionalArguments ()
 
 setAdditionalArguments ($additionalArguments=[])
 
 getAdditionalArgument ($key='')
 
 setAdditionalArgument ($key='', $value=null)
 
 addChildElement (Element $element)
 
 getChildElements ()
 
 setChildElements (ObjectStorage $childElements)
 
 getElementCounter ()
 
 setElementCounter ($elementCounter=0)
 
 getElementType ()
 
 getElementTypeLowerCase ()
 
 setElementType ($elementType)
 
 getValidationErrorMessages ()
 
 setValidationErrorMessages (array $validationErrorMessages)
 
 getHtmlAttributes ()
 
 setHtmlAttributes ($htmlAttributes=[])
 
 removeHtmlAttribute ($key='')
 
 getHtmlAttribute ($key='')
 
 setHtmlAttribute ($key='', $value=null)
 
 getId ()
 
 setId ($id)
 
 getLayout ()
 
 setLayout (array $layout)
 
 getMandatoryValidationMessages ()
 
 setMandatoryValidationMessages (array $mandatoryValidationMessages)
 
 getName ()
 
 setName ($name)
 
 getParentElement ()
 
 setParentElement (Element $parentElement)
 
 getPartialPath ()
 
 setPartialPath ($partialPath)
 
 getShowElement ()
 
 setShowElement ($showElement=false)
 
 setThemeName ($themeName='Default')
 
 getThemeName ()
 
- Public Member Functions inherited from TYPO3\CMS\Extbase\DomainObject\AbstractDomainObject
 __wakeup ()
 
 getUid ()
 
 setPid ($pid)
 
 getPid ()
 
 _setProperty ($propertyName, $propertyValue)
 
 _getProperty ($propertyName)
 
 _getProperties ()
 
 _hasProperty ($propertyName)
 
 _isNew ()
 
 _memorizeCleanState ($propertyName=null)
 
 _memorizePropertyCleanState ($propertyName)
 
 _getCleanProperties ()
 
 _getCleanProperty ($propertyName)
 
 _isDirty ($propertyName=null)
 
 _isClone ()
 
 _setClone ($clone)
 
 __clone ()
 
 __toString ()
 
- Public Member Functions inherited from TYPO3\CMS\Extbase\Persistence\ObjectMonitoringInterface
 _memorizeCleanState ()
 
 _isDirty ()
 

Protected Member Functions

 initStorageObjects ()
 
- Protected Member Functions inherited from TYPO3\CMS\Extbase\DomainObject\AbstractDomainObject
 isPropertyDirty ($previousValue, $currentValue)
 

Protected Attributes

 $additionalArguments
 
 $childElements
 
 $elementCounter
 
 $elementType
 
 $validationErrorMessages
 
 $htmlAttributes
 
 $id
 
 $layout
 
 $mandatoryValidationMessages
 
 $name
 
 $parentElement
 
 $partialPath
 
 $showElement
 
 $themeName
 
- Protected Attributes inherited from TYPO3\CMS\Extbase\DomainObject\AbstractDomainObject
 $uid
 
 $_localizedUid
 
 $_languageUid
 
 $_versionedUid
 
 $pid
 

Detailed Description

The Element Domain Model represents the high-level view on the user submitted data using a nested hierarchy.

Definition at line 24 of file Element.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Form\Domain\Model\Element::__construct ( )

Creates an instance.

Definition at line 128 of file Element.php.

References TYPO3\CMS\Form\Domain\Model\Element\initStorageObjects().

Member Function Documentation

◆ addChildElement()

TYPO3\CMS\Form\Domain\Model\Element::addChildElement ( Element  $element)

Adds a child element

Parameters
\TYPO3\CMS\Form\Domain\Model\Element$element
Returns
void

Definition at line 193 of file Element.php.

Referenced by TYPO3\CMS\Form\Domain\Builder\FormBuilder\addChildElement().

◆ getAdditionalArgument()

TYPO3\CMS\Form\Domain\Model\Element::getAdditionalArgument (   $key = '')

Get a single attribute value

Parameters
string$key
Returns
array

Definition at line 170 of file Element.php.

Referenced by TYPO3\CMS\Form\ViewHelpers\AggregateSelectOptionsViewHelper\checkElementForOptgroup(), TYPO3\CMS\Form\Utility\CompatibilityLayerUtility\getDescriptionElementLayouts(), TYPO3\CMS\Form\Hooks\HandleIncomingFormValues\handleIncomingFormValues(), TYPO3\CMS\Form\Domain\Builder\FormBuilder\handleIncomingValues(), TYPO3\CMS\Form\Domain\Builder\FormBuilder\setAttributes(), and TYPO3\CMS\Form\Utility\CompatibilityLayerUtility\setElementLayouts().

◆ getAdditionalArguments()

TYPO3\CMS\Form\Domain\Model\Element::getAdditionalArguments ( )

Return a array with all the additional arguments to use it in the template

Returns
array

Definition at line 148 of file Element.php.

References TYPO3\CMS\Form\Domain\Model\Element\$additionalArguments.

◆ getChildElements()

TYPO3\CMS\Form\Domain\Model\Element::getChildElements ( )

Returns the child elements

Returns
<> $element

Definition at line 203 of file Element.php.

References TYPO3\CMS\Form\Domain\Model\Element\$childElements.

Referenced by TYPO3\CMS\Form\ViewHelpers\AggregateSelectOptionsViewHelper\getChildElements(), and TYPO3\CMS\Form\ViewHelpers\AggregateSelectOptionsViewHelper\render().

◆ getElementCounter()

TYPO3\CMS\Form\Domain\Model\Element::getElementCounter ( )

Returns the element counter

Returns
int

Definition at line 224 of file Element.php.

References TYPO3\CMS\Form\Domain\Model\Element\$elementCounter.

Referenced by TYPO3\CMS\Form\ViewHelpers\AggregateSelectOptionsViewHelper\checkElementForOptgroup(), TYPO3\CMS\Form\Hooks\HandleIncomingFormValues\handleIncomingFormValues(), TYPO3\CMS\Form\Domain\Builder\FormBuilder\setChildElementsByIntegerKey(), and TYPO3\CMS\Form\Utility\CompatibilityLayerUtility\setElementLayouts().

◆ getElementType()

TYPO3\CMS\Form\Domain\Model\Element::getElementType ( )

Returns the element type

Returns
string

Definition at line 245 of file Element.php.

References TYPO3\CMS\Form\Domain\Model\Element\$elementType.

Referenced by TYPO3\CMS\Form\ViewHelpers\AggregateSelectOptionsViewHelper\checkElementForOptgroup(), TYPO3\CMS\Form\Hooks\HandleIncomingFormValues\handleIncomingFormValues(), TYPO3\CMS\Form\Domain\Builder\FormBuilder\reviveElement(), TYPO3\CMS\Form\Domain\Builder\FormBuilder\setAttributes(), and TYPO3\CMS\Form\Utility\CompatibilityLayerUtility\setElementLayouts().

◆ getElementTypeLowerCase()

TYPO3\CMS\Form\Domain\Model\Element::getElementTypeLowerCase ( )

Returns the element type in lower case

Returns
string

Definition at line 255 of file Element.php.

Referenced by TYPO3\CMS\Form\Utility\CompatibilityLayerUtility\setElementLayouts().

◆ getHtmlAttribute()

TYPO3\CMS\Form\Domain\Model\Element::getHtmlAttribute (   $key = '')

Get a single html attribute value

Parameters
string$key
Returns
array

Definition at line 330 of file Element.php.

Referenced by TYPO3\CMS\Form\Domain\Builder\FormBuilder\handleIncomingValues(), TYPO3\CMS\Form\Hooks\HandleIncomingFormValues\setAttribute(), TYPO3\CMS\Form\Domain\Builder\FormBuilder\setAttributes(), and TYPO3\CMS\Form\Utility\CompatibilityLayerUtility\setElementLayouts().

◆ getHtmlAttributes()

TYPO3\CMS\Form\Domain\Model\Element::getHtmlAttributes ( )

Returns the element html attributes and values

Returns
array

Definition at line 297 of file Element.php.

References TYPO3\CMS\Form\Domain\Model\Element\$htmlAttributes.

◆ getId()

TYPO3\CMS\Form\Domain\Model\Element::getId ( )

Returns the id attribute

Returns
string

Definition at line 352 of file Element.php.

References TYPO3\CMS\Form\Domain\Model\Element\$id.

Referenced by TYPO3\CMS\Form\Utility\CompatibilityLayerUtility\setElementLayouts().

◆ getLayout()

TYPO3\CMS\Form\Domain\Model\Element::getLayout ( )

Returns the element layout

Returns
array

Definition at line 373 of file Element.php.

References TYPO3\CMS\Form\Domain\Model\Element\$layout.

Referenced by TYPO3\CMS\Form\Utility\CompatibilityLayerUtility\setElementLayouts().

◆ getMandatoryValidationMessages()

TYPO3\CMS\Form\Domain\Model\Element::getMandatoryValidationMessages ( )

Returns the mandatory validation messages

Returns
array

Definition at line 394 of file Element.php.

References TYPO3\CMS\Form\Domain\Model\Element\$mandatoryValidationMessages.

◆ getName()

TYPO3\CMS\Form\Domain\Model\Element::getName ( )

Returns the name attribute

Returns
string

Definition at line 415 of file Element.php.

References TYPO3\CMS\Form\Domain\Model\Element\$name.

Referenced by TYPO3\CMS\Form\Utility\CompatibilityLayerUtility\getDescriptionElementLayouts(), TYPO3\CMS\Form\Hooks\HandleIncomingFormValues\handleIncomingFormValues(), TYPO3\CMS\Form\Domain\Builder\FormBuilder\handleIncomingValues(), and TYPO3\CMS\Form\Domain\Builder\FormBuilder\setAttributes().

◆ getParentElement()

TYPO3\CMS\Form\Domain\Model\Element::getParentElement ( )

Returns the parent element

Returns
Element

Definition at line 436 of file Element.php.

References TYPO3\CMS\Form\Domain\Model\Element\$parentElement.

Referenced by TYPO3\CMS\Form\Hooks\HandleIncomingFormValues\handleIncomingFormValues().

◆ getPartialPath()

TYPO3\CMS\Form\Domain\Model\Element::getPartialPath ( )

Returns the fluid partial path for the element

Returns
string

Definition at line 457 of file Element.php.

References TYPO3\CMS\Form\Domain\Model\Element\$partialPath.

◆ getShowElement()

TYPO3\CMS\Form\Domain\Model\Element::getShowElement ( )

Returns TRUE if the element should be displayed

Returns
bool

Definition at line 478 of file Element.php.

References TYPO3\CMS\Form\Domain\Model\Element\$showElement.

◆ getThemeName()

TYPO3\CMS\Form\Domain\Model\Element::getThemeName ( )

Returns the theme name

Returns
string

Definition at line 510 of file Element.php.

References TYPO3\CMS\Form\Domain\Model\Element\$themeName.

◆ getValidationErrorMessages()

TYPO3\CMS\Form\Domain\Model\Element::getValidationErrorMessages ( )

Returns the validation error messages

Returns
array

Definition at line 276 of file Element.php.

References TYPO3\CMS\Form\Domain\Model\Element\$validationErrorMessages.

Referenced by TYPO3\CMS\Form\Utility\CompatibilityLayerUtility\getDescriptionElementLayouts().

◆ initStorageObjects()

TYPO3\CMS\Form\Domain\Model\Element::initStorageObjects ( )
protected

Initializes all ObjectStorage properties.

Returns
void

Definition at line 138 of file Element.php.

Referenced by TYPO3\CMS\Form\Domain\Model\Element\__construct().

◆ removeHtmlAttribute()

TYPO3\CMS\Form\Domain\Model\Element::removeHtmlAttribute (   $key = '')

Remove a single html attribute

Parameters
string$key
Returns
void

Definition at line 319 of file Element.php.

◆ setAdditionalArgument()

TYPO3\CMS\Form\Domain\Model\Element::setAdditionalArgument (   $key = '',
  $value = null 
)

Set a single attribute and value

Parameters
string$key
mixed$value
Returns
array

Definition at line 182 of file Element.php.

Referenced by TYPO3\CMS\Form\Hooks\HandleIncomingFormValues\handleIncomingFormValues(), TYPO3\CMS\Form\Domain\Builder\FormBuilder\handleIncomingValues(), TYPO3\CMS\Form\Hooks\HandleIncomingFormValues\setAttribute(), TYPO3\CMS\Form\Domain\Builder\FormBuilder\setAttributes(), and TYPO3\CMS\Form\Utility\CompatibilityLayerUtility\setElementLayouts().

◆ setAdditionalArguments()

TYPO3\CMS\Form\Domain\Model\Element::setAdditionalArguments (   $additionalArguments = [])

Sets a array with all the additional arguments to use it in the template

Parameters
array$additionalArguments
Returns
void

Definition at line 159 of file Element.php.

References TYPO3\CMS\Form\Domain\Model\Element\$additionalArguments.

Referenced by TYPO3\CMS\Form\Domain\Builder\FormBuilder\reviveElement(), and TYPO3\CMS\Form\Domain\Builder\FormBuilder\setAttributes().

◆ setChildElements()

TYPO3\CMS\Form\Domain\Model\Element::setChildElements ( ObjectStorage  $childElements)

Sets the child elements

Parameters

Definition at line 214 of file Element.php.

References TYPO3\CMS\Form\Domain\Model\Element\$childElements.

◆ setElementCounter()

TYPO3\CMS\Form\Domain\Model\Element::setElementCounter (   $elementCounter = 0)

Sets the element counter

Parameters
int$elementCounter
Returns
void

Definition at line 235 of file Element.php.

References TYPO3\CMS\Form\Domain\Model\Element\$elementCounter.

Referenced by TYPO3\CMS\Form\Domain\Builder\FormBuilder\reviveElement().

◆ setElementType()

TYPO3\CMS\Form\Domain\Model\Element::setElementType (   $elementType)

Sets the parent element

Parameters
string$elementType
Returns
void

Definition at line 266 of file Element.php.

References TYPO3\CMS\Form\Domain\Model\Element\$elementType.

Referenced by TYPO3\CMS\Form\Domain\Builder\FormBuilder\reviveElement().

◆ setHtmlAttribute()

TYPO3\CMS\Form\Domain\Model\Element::setHtmlAttribute (   $key = '',
  $value = null 
)

Set a single html attribute and value

Parameters
string$key
mixed$value
Returns
array

Definition at line 342 of file Element.php.

Referenced by TYPO3\CMS\Form\Domain\Builder\FormBuilder\handleIncomingValues(), TYPO3\CMS\Form\Hooks\HandleIncomingFormValues\setAttribute(), and TYPO3\CMS\Form\Utility\CompatibilityLayerUtility\setElementLayouts().

◆ setHtmlAttributes()

TYPO3\CMS\Form\Domain\Model\Element::setHtmlAttributes (   $htmlAttributes = [])

Sets the element html attributes and values

Parameters
array$htmlAttributes
Returns
void

Definition at line 308 of file Element.php.

References TYPO3\CMS\Form\Domain\Model\Element\$htmlAttributes.

Referenced by TYPO3\CMS\Form\Domain\Builder\FormBuilder\setAttributes().

◆ setId()

TYPO3\CMS\Form\Domain\Model\Element::setId (   $id)

Sets the id attribute

Parameters
string$id
Returns
void

Definition at line 363 of file Element.php.

References TYPO3\CMS\Form\Domain\Model\Element\$id.

◆ setLayout()

TYPO3\CMS\Form\Domain\Model\Element::setLayout ( array  $layout)

Sets the element layout

Parameters
array$layout
Returns
void

Definition at line 384 of file Element.php.

References TYPO3\CMS\Form\Domain\Model\Element\$layout.

Referenced by TYPO3\CMS\Form\Utility\CompatibilityLayerUtility\setElementLayouts().

◆ setMandatoryValidationMessages()

TYPO3\CMS\Form\Domain\Model\Element::setMandatoryValidationMessages ( array  $mandatoryValidationMessages)

Sets the mandatory validation messages

Parameters
array$mandatoryValidationMessages
Returns
void

Definition at line 405 of file Element.php.

References TYPO3\CMS\Form\Domain\Model\Element\$mandatoryValidationMessages.

Referenced by TYPO3\CMS\Form\Domain\Builder\FormBuilder\handleIncomingValues().

◆ setName()

TYPO3\CMS\Form\Domain\Model\Element::setName (   $name)

Sets the name attribute

Parameters
string$name
Returns
void

Definition at line 426 of file Element.php.

References TYPO3\CMS\Form\Domain\Model\Element\$name.

◆ setParentElement()

TYPO3\CMS\Form\Domain\Model\Element::setParentElement ( Element  $parentElement)

Sets the parent element

Parameters

Definition at line 447 of file Element.php.

References TYPO3\CMS\Form\Domain\Model\Element\$parentElement.

◆ setPartialPath()

TYPO3\CMS\Form\Domain\Model\Element::setPartialPath (   $partialPath)

Sets the fluid partial path for the element

Parameters
string$partialPath
Returns
void

Definition at line 468 of file Element.php.

References TYPO3\CMS\Form\Domain\Model\Element\$partialPath.

◆ setShowElement()

TYPO3\CMS\Form\Domain\Model\Element::setShowElement (   $showElement = false)

TRUE if the element should be displayed

Parameters
bool$showElement
Returns
void

Definition at line 489 of file Element.php.

References TYPO3\CMS\Form\Domain\Model\Element\$showElement.

◆ setThemeName()

TYPO3\CMS\Form\Domain\Model\Element::setThemeName (   $themeName = 'Default')

Set the theme name

Parameters
string
Returns
$themeName

Definition at line 500 of file Element.php.

References TYPO3\CMS\Form\Domain\Model\Element\$themeName.

◆ setValidationErrorMessages()

TYPO3\CMS\Form\Domain\Model\Element::setValidationErrorMessages ( array  $validationErrorMessages)

Sets the validation error messages

Parameters
array$validationErrorMessages
Returns
void

Definition at line 287 of file Element.php.

References TYPO3\CMS\Form\Domain\Model\Element\$validationErrorMessages.

Referenced by TYPO3\CMS\Form\Domain\Builder\FormBuilder\handleIncomingValues().

Member Data Documentation

◆ $additionalArguments

TYPO3\CMS\Form\Domain\Model\Element::$additionalArguments
protected

Definition at line 31 of file Element.php.

Referenced by TYPO3\CMS\Form\Domain\Model\Element\getAdditionalArguments(), and TYPO3\CMS\Form\Domain\Model\Element\setAdditionalArguments().

◆ $childElements

TYPO3\CMS\Form\Domain\Model\Element::$childElements
protected

Definition at line 38 of file Element.php.

Referenced by TYPO3\CMS\Form\Domain\Model\Element\getChildElements(), and TYPO3\CMS\Form\Domain\Model\Element\setChildElements().

◆ $elementCounter

TYPO3\CMS\Form\Domain\Model\Element::$elementCounter
protected

Definition at line 45 of file Element.php.

Referenced by TYPO3\CMS\Form\Domain\Model\Element\getElementCounter(), and TYPO3\CMS\Form\Domain\Model\Element\setElementCounter().

◆ $elementType

TYPO3\CMS\Form\Domain\Model\Element::$elementType
protected

Definition at line 52 of file Element.php.

Referenced by TYPO3\CMS\Form\Domain\Model\Element\getElementType(), and TYPO3\CMS\Form\Domain\Model\Element\setElementType().

◆ $htmlAttributes

TYPO3\CMS\Form\Domain\Model\Element::$htmlAttributes
protected

Definition at line 66 of file Element.php.

Referenced by TYPO3\CMS\Form\Domain\Model\Element\getHtmlAttributes(), and TYPO3\CMS\Form\Domain\Model\Element\setHtmlAttributes().

◆ $id

TYPO3\CMS\Form\Domain\Model\Element::$id
protected

Definition at line 73 of file Element.php.

Referenced by TYPO3\CMS\Form\Domain\Model\Element\getId(), and TYPO3\CMS\Form\Domain\Model\Element\setId().

◆ $layout

TYPO3\CMS\Form\Domain\Model\Element::$layout
protected

Definition at line 81 of file Element.php.

Referenced by TYPO3\CMS\Form\Domain\Model\Element\getLayout(), and TYPO3\CMS\Form\Domain\Model\Element\setLayout().

◆ $mandatoryValidationMessages

TYPO3\CMS\Form\Domain\Model\Element::$mandatoryValidationMessages
protected

Definition at line 88 of file Element.php.

Referenced by TYPO3\CMS\Form\Domain\Model\Element\getMandatoryValidationMessages(), and TYPO3\CMS\Form\Domain\Model\Element\setMandatoryValidationMessages().

◆ $name

TYPO3\CMS\Form\Domain\Model\Element::$name
protected

Definition at line 95 of file Element.php.

Referenced by TYPO3\CMS\Form\Domain\Model\Element\getName(), and TYPO3\CMS\Form\Domain\Model\Element\setName().

◆ $parentElement

TYPO3\CMS\Form\Domain\Model\Element::$parentElement
protected

Definition at line 102 of file Element.php.

Referenced by TYPO3\CMS\Form\Domain\Model\Element\getParentElement(), and TYPO3\CMS\Form\Domain\Model\Element\setParentElement().

◆ $partialPath

TYPO3\CMS\Form\Domain\Model\Element::$partialPath
protected

Definition at line 109 of file Element.php.

Referenced by TYPO3\CMS\Form\Domain\Model\Element\getPartialPath(), and TYPO3\CMS\Form\Domain\Model\Element\setPartialPath().

◆ $showElement

TYPO3\CMS\Form\Domain\Model\Element::$showElement
protected

Definition at line 116 of file Element.php.

Referenced by TYPO3\CMS\Form\Domain\Model\Element\getShowElement(), and TYPO3\CMS\Form\Domain\Model\Element\setShowElement().

◆ $themeName

TYPO3\CMS\Form\Domain\Model\Element::$themeName
protected

Definition at line 123 of file Element.php.

Referenced by TYPO3\CMS\Form\Domain\Model\Element\getThemeName(), and TYPO3\CMS\Form\Domain\Model\Element\setThemeName().

◆ $validationErrorMessages

TYPO3\CMS\Form\Domain\Model\Element::$validationErrorMessages
protected

Definition at line 59 of file Element.php.

Referenced by TYPO3\CMS\Form\Domain\Model\Element\getValidationErrorMessages(), and TYPO3\CMS\Form\Domain\Model\Element\setValidationErrorMessages().