TYPO3 CMS  TYPO3_7-6
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
TYPO3\CMS\Form\Domain\Builder\ElementBuilder Class Reference

Public Member Functions

 injectTypoScriptRepository (\TYPO3\CMS\Form\Domain\Repository\TypoScriptRepository $typoScriptRepository)
 
 injectTypoScriptService (\TYPO3\CMS\Extbase\Service\TypoScriptService $typoScriptService)
 
 setFormBuilder (FormBuilder $formBuilder)
 
 setElement (Element $element)
 
 setPartialPaths ()
 
 setVisibility ()
 
 setHtmlAttributeWildcards ()
 
 overlayUserdefinedHtmlAttributeValues ()
 
 overlayFixedHtmlAttributeValues ()
 
 moveHtmlAttributesToAdditionalArguments ()
 
 setViewHelperDefaulArgumentsToAdditionalArguments ()
 
 moveAllOtherUserdefinedPropertiesToAdditionalArguments ()
 
 setNameAndId ()
 
 sanitizeNameAttribute ($name)
 
 getHtmlAttributes ()
 
 setHtmlAttributes (array $htmlAttributes)
 
 getAdditionalArguments ()
 
 setAdditionalArguments (array $additionalArguments)
 
 getWildcardPrefixes ()
 
 setWildcardPrefixes (array $wildcardPrefixes)
 
 getUserConfiguredElementTyposcript ()
 
 setUserConfiguredElementTyposcript (array $userConfiguredElementTyposcript)
 

Protected Member Functions

 setElementPartialPath ()
 
 sanitizeIdAttribute ($id)
 
 arrayKeyExists ($needle, array $haystack=[])
 

Protected Attributes

 $typoScriptRepository
 
 $typoScriptService
 
 $userConfiguredElementTyposcript = []
 
 $htmlAttributes = []
 
 $additionalArguments = []
 
 $wildcardPrefixes = []
 
 $formBuilder
 
 $element
 

Detailed Description

Builder for Element domain models.

Definition at line 23 of file ElementBuilder.php.

Member Function Documentation

◆ arrayKeyExists()

TYPO3\CMS\Form\Domain\Builder\ElementBuilder::arrayKeyExists (   $needle,
array  $haystack = [] 
)
protected

Check if a needle exists in a array.

Parameters
string$needle
array$haystack
Returns
bool TRUE if found

Definition at line 477 of file ElementBuilder.php.

Referenced by TYPO3\CMS\Form\Domain\Builder\ElementBuilder\moveAllOtherUserdefinedPropertiesToAdditionalArguments(), and TYPO3\CMS\Form\Domain\Builder\ElementBuilder\overlayUserdefinedHtmlAttributeValues().

◆ getAdditionalArguments()

TYPO3\CMS\Form\Domain\Builder\ElementBuilder::getAdditionalArguments ( )

Get the current additional arguments

Returns
array

Definition at line 509 of file ElementBuilder.php.

References TYPO3\CMS\Form\Domain\Builder\ElementBuilder\$additionalArguments.

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

◆ getHtmlAttributes()

TYPO3\CMS\Form\Domain\Builder\ElementBuilder::getHtmlAttributes ( )

Get the current html attributes

Returns
array

Definition at line 489 of file ElementBuilder.php.

References TYPO3\CMS\Form\Domain\Builder\ElementBuilder\$htmlAttributes.

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

◆ getUserConfiguredElementTyposcript()

TYPO3\CMS\Form\Domain\Builder\ElementBuilder::getUserConfiguredElementTyposcript ( )

Get the current Element

Returns
array

Definition at line 549 of file ElementBuilder.php.

References TYPO3\CMS\Form\Domain\Builder\ElementBuilder\$userConfiguredElementTyposcript.

◆ getWildcardPrefixes()

TYPO3\CMS\Form\Domain\Builder\ElementBuilder::getWildcardPrefixes ( )

Get the current wildcard prefixes

Returns
array

Definition at line 529 of file ElementBuilder.php.

References TYPO3\CMS\Form\Domain\Builder\ElementBuilder\$wildcardPrefixes.

◆ injectTypoScriptRepository()

TYPO3\CMS\Form\Domain\Builder\ElementBuilder::injectTypoScriptRepository ( \TYPO3\CMS\Form\Domain\Repository\TypoScriptRepository  $typoScriptRepository)
Parameters
\TYPO3\CMS\Form\Domain\Repository\TypoScriptRepository$typoScriptRepository
Returns
void

Definition at line 85 of file ElementBuilder.php.

References TYPO3\CMS\Form\Domain\Builder\ElementBuilder\$typoScriptRepository.

◆ injectTypoScriptService()

TYPO3\CMS\Form\Domain\Builder\ElementBuilder::injectTypoScriptService ( \TYPO3\CMS\Extbase\Service\TypoScriptService  $typoScriptService)
Parameters
\TYPO3\CMS\Extbase\Service\TypoScriptService$typoScriptService
Returns
void

Definition at line 94 of file ElementBuilder.php.

References TYPO3\CMS\Form\Domain\Builder\ElementBuilder\$typoScriptService.

◆ moveAllOtherUserdefinedPropertiesToAdditionalArguments()

TYPO3\CMS\Form\Domain\Builder\ElementBuilder::moveAllOtherUserdefinedPropertiesToAdditionalArguments ( )

Move all userdefined properties to the additionalArguments array. Ignore the child elements

Returns
void

Definition at line 329 of file ElementBuilder.php.

References TYPO3\CMS\Form\Domain\Builder\ElementBuilder\arrayKeyExists(), and TYPO3\CMS\Core\Utility\MathUtility\canBeInterpretedAsInteger().

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

◆ moveHtmlAttributesToAdditionalArguments()

TYPO3\CMS\Form\Domain\Builder\ElementBuilder::moveHtmlAttributesToAdditionalArguments ( )

Move htmlAttributes to additionalArguments that must be passed as a view helper argument

Returns
void

Definition at line 293 of file ElementBuilder.php.

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

◆ overlayFixedHtmlAttributeValues()

TYPO3\CMS\Form\Domain\Builder\ElementBuilder::overlayFixedHtmlAttributeValues ( )

If fixedHtmlAttributeValues are defined for this element then overwrite the html attribute value

Returns
void

Definition at line 277 of file ElementBuilder.php.

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

◆ overlayUserdefinedHtmlAttributeValues()

TYPO3\CMS\Form\Domain\Builder\ElementBuilder::overlayUserdefinedHtmlAttributeValues ( )

Overlay user defined html attribute values To determine whats a html attribute, the htmlAttributes array is used. If a html attribute value is found in userConfiguredElementTyposcript this value is set to htmlAttributes and removed from userConfiguredElementTyposcript.

Returns
void

Definition at line 196 of file ElementBuilder.php.

References TYPO3\CMS\Form\Domain\Builder\ElementBuilder\arrayKeyExists(), and TYPO3\CMS\Core\Utility\MathUtility\canBeInterpretedAsInteger().

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

◆ sanitizeIdAttribute()

TYPO3\CMS\Form\Domain\Builder\ElementBuilder::sanitizeIdAttribute (   $id)
protected

If the id is not defined it is automatically generated using the following syntax: field-{element_counter} The id attribute will be transformed if it contains some non allowed characters:

  • spaces are changed into hyphens
  • if the id start with a integer then transform it to field-{integer}
  • remove all characters expect a-z A-Z 0-9 _ - : .
Parameters
string$id
Returns
string

Definition at line 461 of file ElementBuilder.php.

Referenced by TYPO3\CMS\Form\Domain\Builder\ElementBuilder\setNameAndId().

◆ sanitizeNameAttribute()

TYPO3\CMS\Form\Domain\Builder\ElementBuilder::sanitizeNameAttribute (   $name)

If the name is not defined it is automatically generated using the following syntax: id-{element_counter} The name attribute will be transformed if it contains some non allowed characters:

  • spaces are changed into hyphens
  • remove all characters except a-z A-Z 0-9 _ -
Parameters
string$name
Returns
string

Definition at line 440 of file ElementBuilder.php.

Referenced by TYPO3\CMS\Form\Domain\Builder\ElementBuilder\setNameAndId().

◆ setAdditionalArguments()

TYPO3\CMS\Form\Domain\Builder\ElementBuilder::setAdditionalArguments ( array  $additionalArguments)

Set the current additional arguments

Parameters
array$additionalArguments

Definition at line 519 of file ElementBuilder.php.

References TYPO3\CMS\Form\Domain\Builder\ElementBuilder\$additionalArguments.

◆ setElement()

TYPO3\CMS\Form\Domain\Builder\ElementBuilder::setElement ( Element  $element)
Parameters
Element$element

Definition at line 110 of file ElementBuilder.php.

References TYPO3\CMS\Form\Domain\Builder\ElementBuilder\$element.

◆ setElementPartialPath()

TYPO3\CMS\Form\Domain\Builder\ElementBuilder::setElementPartialPath ( )
protected

Set the fluid partial path to the element

Returns
void

Definition at line 130 of file ElementBuilder.php.

Referenced by TYPO3\CMS\Form\Domain\Builder\ElementBuilder\setPartialPaths().

◆ setFormBuilder()

TYPO3\CMS\Form\Domain\Builder\ElementBuilder::setFormBuilder ( FormBuilder  $formBuilder)
Parameters
FormBuilder$formBuilder

Definition at line 102 of file ElementBuilder.php.

References TYPO3\CMS\Form\Domain\Builder\ElementBuilder\$formBuilder.

◆ setHtmlAttributes()

TYPO3\CMS\Form\Domain\Builder\ElementBuilder::setHtmlAttributes ( array  $htmlAttributes)

Set the current html attributes

Parameters
array$htmlAttributes

Definition at line 499 of file ElementBuilder.php.

References TYPO3\CMS\Form\Domain\Builder\ElementBuilder\$htmlAttributes.

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

◆ setHtmlAttributeWildcards()

TYPO3\CMS\Form\Domain\Builder\ElementBuilder::setHtmlAttributeWildcards ( )

Find all prefix-* attributes and return the found prefixs. Than delete them from the htmlAttributes array

Returns
void

Definition at line 177 of file ElementBuilder.php.

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

◆ setNameAndId()

TYPO3\CMS\Form\Domain\Builder\ElementBuilder::setNameAndId ( )

Set the name and id attribute

Returns
array

Definition at line 411 of file ElementBuilder.php.

References TYPO3\CMS\Form\Domain\Builder\ElementBuilder\sanitizeIdAttribute(), and TYPO3\CMS\Form\Domain\Builder\ElementBuilder\sanitizeNameAttribute().

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

◆ setPartialPaths()

TYPO3\CMS\Form\Domain\Builder\ElementBuilder::setPartialPaths ( )

Set the fluid partial path to the element

Returns
void

Definition at line 120 of file ElementBuilder.php.

References TYPO3\CMS\Form\Domain\Builder\ElementBuilder\setElementPartialPath().

◆ setUserConfiguredElementTyposcript()

TYPO3\CMS\Form\Domain\Builder\ElementBuilder::setUserConfiguredElementTyposcript ( array  $userConfiguredElementTyposcript)

Set the current Element

Parameters
array$userConfiguredElementTyposcript

Definition at line 559 of file ElementBuilder.php.

References TYPO3\CMS\Form\Domain\Builder\ElementBuilder\$userConfiguredElementTyposcript.

◆ setViewHelperDefaulArgumentsToAdditionalArguments()

TYPO3\CMS\Form\Domain\Builder\ElementBuilder::setViewHelperDefaulArgumentsToAdditionalArguments ( )

Set the viewhelper default arguments in the additionalArguments array

Returns
void

Definition at line 311 of file ElementBuilder.php.

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

◆ setVisibility()

TYPO3\CMS\Form\Domain\Builder\ElementBuilder::setVisibility ( )

Set the fluid partial path to the element

Returns
void

Definition at line 146 of file ElementBuilder.php.

◆ setWildcardPrefixes()

TYPO3\CMS\Form\Domain\Builder\ElementBuilder::setWildcardPrefixes ( array  $wildcardPrefixes)

Set the current wildcard prefixes

Parameters
array$wildcardPrefixes

Definition at line 539 of file ElementBuilder.php.

References TYPO3\CMS\Form\Domain\Builder\ElementBuilder\$wildcardPrefixes.

Member Data Documentation

◆ $additionalArguments

TYPO3\CMS\Form\Domain\Builder\ElementBuilder::$additionalArguments = []
protected

Definition at line 64 of file ElementBuilder.php.

Referenced by TYPO3\CMS\Form\Domain\Builder\ElementBuilder\getAdditionalArguments(), and TYPO3\CMS\Form\Domain\Builder\ElementBuilder\setAdditionalArguments().

◆ $element

TYPO3\CMS\Form\Domain\Builder\ElementBuilder::$element
protected

Definition at line 79 of file ElementBuilder.php.

Referenced by TYPO3\CMS\Form\Domain\Builder\ElementBuilder\setElement().

◆ $formBuilder

TYPO3\CMS\Form\Domain\Builder\ElementBuilder::$formBuilder
protected

Definition at line 74 of file ElementBuilder.php.

Referenced by TYPO3\CMS\Form\Domain\Builder\ElementBuilder\setFormBuilder().

◆ $htmlAttributes

TYPO3\CMS\Form\Domain\Builder\ElementBuilder::$htmlAttributes = []
protected

Definition at line 59 of file ElementBuilder.php.

Referenced by TYPO3\CMS\Form\Domain\Builder\ElementBuilder\getHtmlAttributes(), and TYPO3\CMS\Form\Domain\Builder\ElementBuilder\setHtmlAttributes().

◆ $typoScriptRepository

TYPO3\CMS\Form\Domain\Builder\ElementBuilder::$typoScriptRepository
protected

Definition at line 44 of file ElementBuilder.php.

Referenced by TYPO3\CMS\Form\Domain\Builder\ElementBuilder\injectTypoScriptRepository().

◆ $typoScriptService

TYPO3\CMS\Form\Domain\Builder\ElementBuilder::$typoScriptService
protected

Definition at line 49 of file ElementBuilder.php.

Referenced by TYPO3\CMS\Form\Domain\Builder\ElementBuilder\injectTypoScriptService().

◆ $userConfiguredElementTyposcript

TYPO3\CMS\Form\Domain\Builder\ElementBuilder::$userConfiguredElementTyposcript = []
protected

Definition at line 54 of file ElementBuilder.php.

Referenced by TYPO3\CMS\Form\Domain\Builder\ElementBuilder\getUserConfiguredElementTyposcript(), and TYPO3\CMS\Form\Domain\Builder\ElementBuilder\setUserConfiguredElementTyposcript().

◆ $wildcardPrefixes

TYPO3\CMS\Form\Domain\Builder\ElementBuilder::$wildcardPrefixes = []
protected

Definition at line 69 of file ElementBuilder.php.

Referenced by TYPO3\CMS\Form\Domain\Builder\ElementBuilder\getWildcardPrefixes(), and TYPO3\CMS\Form\Domain\Builder\ElementBuilder\setWildcardPrefixes().