TYPO3  7.6
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
ElementBuilder Class Reference

Public Member Functions

 injectTypoScriptRepository (\TYPO3\CMS\Form\Domain\Repository\TypoScriptRepository $typoScriptRepository)
 
 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=array())
 

Protected Attributes

 $typoScriptRepository
 
 $userConfiguredElementTyposcript = array()
 
 $htmlAttributes = array()
 
 $additionalArguments = array()
 
 $wildcardPrefixes = array()
 
 $formBuilder
 
 $element
 

Detailed Description

Builder for Element domain models.

Definition at line 23 of file ElementBuilder.php.

Member Function Documentation

arrayKeyExists (   $needle,
array  $haystack = array() 
)
protected

Check if a needle exists in a array.

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

Definition at line 452 of file ElementBuilder.php.

Referenced by ElementBuilder\moveAllOtherUserdefinedPropertiesToAdditionalArguments(), and ElementBuilder\overlayUserdefinedHtmlAttributeValues().

getAdditionalArguments ( )

Get the current additional arguments

Returns
array

Definition at line 484 of file ElementBuilder.php.

References ElementBuilder\$additionalArguments.

Referenced by FormBuilder\setAttributes().

getHtmlAttributes ( )

Get the current html attributes

Returns
array

Definition at line 464 of file ElementBuilder.php.

References ElementBuilder\$htmlAttributes.

Referenced by FormBuilder\setAttributes().

getUserConfiguredElementTyposcript ( )

Get the current Element

Returns
array

Definition at line 524 of file ElementBuilder.php.

References ElementBuilder\$userConfiguredElementTyposcript.

getWildcardPrefixes ( )

Get the current wildcard prefixes

Returns
array

Definition at line 504 of file ElementBuilder.php.

References ElementBuilder\$wildcardPrefixes.

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

Definition at line 80 of file ElementBuilder.php.

References ElementBuilder\$typoScriptRepository.

moveAllOtherUserdefinedPropertiesToAdditionalArguments ( )

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

Returns
void

Definition at line 314 of file ElementBuilder.php.

References ElementBuilder\arrayKeyExists(), and MathUtility\canBeInterpretedAsInteger().

Referenced by FormBuilder\setAttributes().

moveHtmlAttributesToAdditionalArguments ( )

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

Returns
void

Definition at line 279 of file ElementBuilder.php.

Referenced by FormBuilder\setAttributes().

overlayFixedHtmlAttributeValues ( )

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

Returns
void

Definition at line 263 of file ElementBuilder.php.

Referenced by FormBuilder\setAttributes().

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 182 of file ElementBuilder.php.

References ElementBuilder\arrayKeyExists(), and MathUtility\canBeInterpretedAsInteger().

Referenced by FormBuilder\setAttributes().

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 436 of file ElementBuilder.php.

Referenced by ElementBuilder\setNameAndId().

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 415 of file ElementBuilder.php.

Referenced by ElementBuilder\setNameAndId().

setAdditionalArguments ( array  $additionalArguments)

Set the current additional arguments

Parameters
array$additionalArguments

Definition at line 494 of file ElementBuilder.php.

References ElementBuilder\$additionalArguments.

setElement ( Element  $element)
Parameters
Element$element

Definition at line 96 of file ElementBuilder.php.

References ElementBuilder\$element.

setElementPartialPath ( )
protected

Set the fluid partial path to the element

Returns
void

Definition at line 116 of file ElementBuilder.php.

Referenced by ElementBuilder\setPartialPaths().

setFormBuilder ( FormBuilder  $formBuilder)
Parameters
FormBuilder$formBuilder

Definition at line 88 of file ElementBuilder.php.

References ElementBuilder\$formBuilder.

setHtmlAttributes ( array  $htmlAttributes)

Set the current html attributes

Parameters
array$htmlAttributes

Definition at line 474 of file ElementBuilder.php.

References ElementBuilder\$htmlAttributes.

Referenced by FormBuilder\setAttributes().

setHtmlAttributeWildcards ( )

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

Returns
void

Definition at line 163 of file ElementBuilder.php.

Referenced by FormBuilder\setAttributes().

setNameAndId ( )

Set the name and id attribute

Returns
array

Definition at line 386 of file ElementBuilder.php.

References ElementBuilder\sanitizeIdAttribute(), and ElementBuilder\sanitizeNameAttribute().

Referenced by FormBuilder\setAttributes().

setPartialPaths ( )

Set the fluid partial path to the element

Returns
void

Definition at line 106 of file ElementBuilder.php.

References ElementBuilder\setElementPartialPath().

setUserConfiguredElementTyposcript ( array  $userConfiguredElementTyposcript)

Set the current Element

Parameters
array$userConfiguredElementTyposcript

Definition at line 534 of file ElementBuilder.php.

References ElementBuilder\$userConfiguredElementTyposcript.

setViewHelperDefaulArgumentsToAdditionalArguments ( )

Set the viewhelper default arguments in the additionalArguments array

Returns
void

Definition at line 297 of file ElementBuilder.php.

Referenced by FormBuilder\setAttributes().

setVisibility ( )

Set the fluid partial path to the element

Returns
void

Definition at line 132 of file ElementBuilder.php.

References elseif.

setWildcardPrefixes ( array  $wildcardPrefixes)

Set the current wildcard prefixes

Parameters
array$wildcardPrefixes

Definition at line 514 of file ElementBuilder.php.

References ElementBuilder\$wildcardPrefixes.

Member Data Documentation

$additionalArguments = array()
protected
$element
protected

Definition at line 74 of file ElementBuilder.php.

Referenced by ElementBuilder\setElement().

$formBuilder
protected

Definition at line 69 of file ElementBuilder.php.

Referenced by ElementBuilder\setFormBuilder().

$htmlAttributes = array()
protected
$typoScriptRepository
protected

Definition at line 44 of file ElementBuilder.php.

Referenced by ElementBuilder\injectTypoScriptRepository().

$userConfiguredElementTyposcript = array()
protected
$wildcardPrefixes = array()
protected