TYPO3  7.6
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Element Class Reference
Inheritance diagram for Element:
AbstractEntity AbstractDomainObject DomainObjectInterface ObjectMonitoringInterface

Public Member Functions

 __construct ()
 
 getAdditionalArguments ()
 
 setAdditionalArguments ($additionalArguments=array())
 
 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=array())
 
 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 ()
 

Protected Member Functions

 initStorageObjects ()
 

Protected Attributes

 $additionalArguments
 
 $childElements
 
 $elementCounter
 
 $elementType
 
 $validationErrorMessages
 
 $htmlAttributes
 
 $id
 
 $layout
 
 $mandatoryValidationMessages
 
 $name
 
 $parentElement
 
 $partialPath
 
 $showElement
 
 $themeName
 

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 ( )

Creates an instance.

Definition at line 128 of file Element.php.

References Element\initStorageObjects().

Member Function Documentation

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 FormBuilder\addChildElement().

getAdditionalArgument (   $key = '')

Get a single attribute value

Parameters
string$key
Returns
array

Definition at line 170 of file Element.php.

Referenced by AggregateSelectOptionsViewHelper\checkElementForOptgroup(), CompatibilityLayerUtility\getDescriptionElementLayouts(), HandleIncomingFormValues\handleIncomingFormValues(), FormBuilder\handleIncomingValues(), FormBuilder\setAttributes(), and CompatibilityLayerUtility\setElementLayouts().

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 Element\$additionalArguments.

getChildElements ( )

Returns the child elements

Returns
<> $element

Definition at line 203 of file Element.php.

References Element\$childElements.

Referenced by AggregateSelectOptionsViewHelper\getChildElements(), and AggregateSelectOptionsViewHelper\render().

getElementCounter ( )

Returns the element counter

Returns
int

Definition at line 224 of file Element.php.

References Element\$elementCounter.

Referenced by AggregateSelectOptionsViewHelper\checkElementForOptgroup(), HandleIncomingFormValues\handleIncomingFormValues(), FormBuilder\setChildElementsByIntegerKey(), and CompatibilityLayerUtility\setElementLayouts().

getElementType ( )

Returns the element type

Returns
string

Definition at line 245 of file Element.php.

References Element\$elementType.

Referenced by AggregateSelectOptionsViewHelper\checkElementForOptgroup(), HandleIncomingFormValues\handleIncomingFormValues(), FormBuilder\reviveElement(), FormBuilder\setAttributes(), and CompatibilityLayerUtility\setElementLayouts().

getElementTypeLowerCase ( )

Returns the element type in lower case

Returns
string

Definition at line 255 of file Element.php.

Referenced by CompatibilityLayerUtility\setElementLayouts().

getHtmlAttribute (   $key = '')

Get a single html attribute value

Parameters
string$key
Returns
array

Definition at line 330 of file Element.php.

Referenced by FormBuilder\handleIncomingValues(), HandleIncomingFormValues\setAttribute(), FormBuilder\setAttributes(), and CompatibilityLayerUtility\setElementLayouts().

getHtmlAttributes ( )

Returns the element html attributes and values

Returns
array

Definition at line 297 of file Element.php.

References Element\$htmlAttributes.

getId ( )

Returns the id attribute

Returns
string

Definition at line 352 of file Element.php.

References Element\$id.

Referenced by CompatibilityLayerUtility\setElementLayouts().

getLayout ( )

Returns the element layout

Returns
array

Definition at line 373 of file Element.php.

References Element\$layout.

Referenced by CompatibilityLayerUtility\setElementLayouts().

getMandatoryValidationMessages ( )

Returns the mandatory validation messages

Returns
array

Definition at line 394 of file Element.php.

References Element\$mandatoryValidationMessages.

getName ( )

Returns the name attribute

Returns
string

Definition at line 415 of file Element.php.

References Element\$name.

Referenced by CompatibilityLayerUtility\getDescriptionElementLayouts(), HandleIncomingFormValues\handleIncomingFormValues(), FormBuilder\handleIncomingValues(), and FormBuilder\setAttributes().

getParentElement ( )

Returns the parent element

Returns
Element

Definition at line 436 of file Element.php.

References Element\$parentElement.

Referenced by HandleIncomingFormValues\handleIncomingFormValues().

getPartialPath ( )

Returns the fluid partial path for the element

Returns
string

Definition at line 457 of file Element.php.

References Element\$partialPath.

getShowElement ( )

Returns TRUE if the element should be displayed

Returns
bool

Definition at line 478 of file Element.php.

References Element\$showElement.

getThemeName ( )

Returns the theme name

Returns
string

Definition at line 510 of file Element.php.

References Element\$themeName.

getValidationErrorMessages ( )

Returns the validation error messages

Returns
array

Definition at line 276 of file Element.php.

References Element\$validationErrorMessages.

Referenced by CompatibilityLayerUtility\getDescriptionElementLayouts().

initStorageObjects ( )
protected

Initializes all ObjectStorage properties.

Returns
void

Definition at line 138 of file Element.php.

Referenced by Element\__construct().

removeHtmlAttribute (   $key = '')

Remove a single html attribute

Parameters
string$key
Returns
void

Definition at line 319 of file Element.php.

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 HandleIncomingFormValues\handleIncomingFormValues(), FormBuilder\handleIncomingValues(), HandleIncomingFormValues\setAttribute(), FormBuilder\setAttributes(), and CompatibilityLayerUtility\setElementLayouts().

setAdditionalArguments (   $additionalArguments = array())

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 Element\$additionalArguments.

Referenced by FormBuilder\reviveElement(), and FormBuilder\setAttributes().

setChildElements ( ObjectStorage  $childElements)

Sets the child elements

Parameters
\TYPO3\CMS\Extbase\Persistence\ObjectStorage<\TYPO3\CMS\Form\Domain\Model\Element>$childElements
Returns
void

Definition at line 214 of file Element.php.

References Element\$childElements.

setElementCounter (   $elementCounter = 0)

Sets the element counter

Parameters
int$elementCounter
Returns
void

Definition at line 235 of file Element.php.

References Element\$elementCounter.

Referenced by FormBuilder\reviveElement().

setElementType (   $elementType)

Sets the parent element

Parameters
string$elementType
Returns
void

Definition at line 266 of file Element.php.

References Element\$elementType.

Referenced by FormBuilder\reviveElement().

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 FormBuilder\handleIncomingValues(), HandleIncomingFormValues\setAttribute(), and CompatibilityLayerUtility\setElementLayouts().

setHtmlAttributes (   $htmlAttributes = array())

Sets the element html attributes and values

Parameters
array$htmlAttributes
Returns
void

Definition at line 308 of file Element.php.

References Element\$htmlAttributes.

Referenced by FormBuilder\setAttributes().

setId (   $id)

Sets the id attribute

Parameters
string$id
Returns
void

Definition at line 363 of file Element.php.

References Element\$id.

setLayout ( array  $layout)

Sets the element layout

Parameters
array$layout
Returns
void

Definition at line 384 of file Element.php.

References Element\$layout.

Referenced by CompatibilityLayerUtility\setElementLayouts().

setMandatoryValidationMessages ( array  $mandatoryValidationMessages)

Sets the mandatory validation messages

Parameters
array$mandatoryValidationMessages
Returns
void

Definition at line 405 of file Element.php.

References Element\$mandatoryValidationMessages.

setName (   $name)

Sets the name attribute

Parameters
string$name
Returns
void

Definition at line 426 of file Element.php.

References Element\$name.

setParentElement ( Element  $parentElement)

Sets the parent element

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

Definition at line 447 of file Element.php.

References Element\$parentElement.

setPartialPath (   $partialPath)

Sets the fluid partial path for the element

Parameters
string$partialPath
Returns
void

Definition at line 468 of file Element.php.

References Element\$partialPath.

setShowElement (   $showElement = false)

TRUE if the element should be displayed

Parameters
bool$showElement
Returns
void

Definition at line 489 of file Element.php.

References Element\$showElement.

setThemeName (   $themeName = 'Default')

Set the theme name

Parameters
string
Returns
$themeName

Definition at line 500 of file Element.php.

References Element\$themeName.

setValidationErrorMessages ( array  $validationErrorMessages)

Sets the validation error messages

Parameters
array$validationErrorMessages
Returns
void

Definition at line 287 of file Element.php.

References Element\$validationErrorMessages.

Member Data Documentation

$additionalArguments
protected

Definition at line 31 of file Element.php.

Referenced by Element\getAdditionalArguments(), and Element\setAdditionalArguments().

$childElements
protected

Definition at line 38 of file Element.php.

Referenced by Element\getChildElements(), and Element\setChildElements().

$elementCounter
protected

Definition at line 45 of file Element.php.

Referenced by Element\getElementCounter(), and Element\setElementCounter().

$elementType
protected

Definition at line 52 of file Element.php.

Referenced by Element\getElementType(), and Element\setElementType().

$htmlAttributes
protected

Definition at line 66 of file Element.php.

Referenced by Element\getHtmlAttributes(), and Element\setHtmlAttributes().

$id
protected

Definition at line 73 of file Element.php.

Referenced by Element\getId(), and Element\setId().

$layout
protected

Definition at line 81 of file Element.php.

Referenced by Element\getLayout(), and Element\setLayout().

$mandatoryValidationMessages
protected

Definition at line 88 of file Element.php.

Referenced by Element\getMandatoryValidationMessages(), and Element\setMandatoryValidationMessages().

$name
protected

Definition at line 95 of file Element.php.

Referenced by Element\getName(), and Element\setName().

$parentElement
protected

Definition at line 102 of file Element.php.

Referenced by Element\getParentElement(), and Element\setParentElement().

$partialPath
protected

Definition at line 109 of file Element.php.

Referenced by Element\getPartialPath(), and Element\setPartialPath().

$showElement
protected

Definition at line 116 of file Element.php.

Referenced by Element\getShowElement(), and Element\setShowElement().

$themeName
protected

Definition at line 123 of file Element.php.

Referenced by Element\getThemeName(), and Element\setThemeName().

$validationErrorMessages
protected

Definition at line 59 of file Element.php.

Referenced by Element\getValidationErrorMessages(), and Element\setValidationErrorMessages().

Generated on Wed Nov 11 2015 01:52:42 for TYPO3 by   doxygen 1.8.3