FlexFormEntryContainer

class \TYPO3\CMS\Backend\Form\Container\FlexFormEntryContainer

Extends
AbstractContainer

Entry container to a flex form element. This container is created by SingleFieldContainer if a type='flex' field is rendered.

It either forks a FlexFormTabsContainer or a FlexFormNoTabsContainer.

Table of Contents

Properties

$backendViewFactory  : BackendViewFactory
$data  : array
Main data array to work on, given from parent to child elements
$defaultFieldControl  : array
A list of default field controls added to the element / container.
$defaultFieldInformation  : array
A list of default field information added to the element / container.
$defaultFieldWizard  : array
A list of default field wizards added to the element / container.
$nodeFactory  : NodeFactory

Methods

injectBackendViewFactory()  : mixed
injectNodeFactory()  : void
Injection of NodeFactory, which is used in this abstract already.
render()  : array
Entry method
setData()  : void
Retrieve the current data array from NodeFactory.
explodeSingleFieldShowItemConfiguration()  : array
A single field of TCA 'types' 'showitem' can have three semicolon separated configuration options: fieldName: Name of the field to be found in TCA 'columns' section fieldLabel: An alternative field label paletteName: Name of a palette to be found in TCA 'palettes' section that is rendered after this field
getBackendUserAuthentication()  : BackendUserAuthentication
getLanguageService()  : LanguageService
getValidationDataAsJsonString()  : string
Build JSON string for validations rules.
initializeResultArray()  : array{additionalInlineLanguageLabelFiles: list, stylesheetFiles: list, javaScriptModules: list, inlineData: array, html: string}
Initialize the array that is returned to parent after calling. This structure is identical for *all* nodes. Parent will merge the return of a child with its own stuff and in itself return an array of the same structure.
mergeChildReturnIntoExistingResult()  : array
Merge existing data with a child return array.
renderDescription()  : string
renderFieldControl()  : array
Merge field control configuration with default controls and render them.
renderFieldInformation()  : array
Merge field information configuration with default and render them.
renderFieldWizard()  : array
Merge field wizard configuration with default wizards and render them.
renderTabMenu()  : string
Render tabs with label and content. Used by TabsContainer and FlexFormTabsContainer.
wrapWithFieldsetAndLegend()  : string

Properties

$data

Main data array to work on, given from parent to child elements

protected array $data = []

$defaultFieldControl

A list of default field controls added to the element / container.

protected array $defaultFieldControl = []

This property is often reset by single elements.

$defaultFieldInformation

A list of default field information added to the element / container.

protected array $defaultFieldInformation = []

$defaultFieldWizard

A list of default field wizards added to the element / container.

protected array $defaultFieldWizard = []

This property is often reset by single elements.

Methods

injectNodeFactory()

Injection of NodeFactory, which is used in this abstract already.

public injectNodeFactory(NodeFactory $nodeFactory) : void

Using inject* method to not pollute __construct() for inheriting classes.

Parameters

$nodeFactory : NodeFactory

render()

Entry method

public render() : array

Return values

array —

As defined in initializeResultArray() of AbstractNode

setData()

Retrieve the current data array from NodeFactory.

public setData(array $data) : void

Parameters

$data : array

explodeSingleFieldShowItemConfiguration()

A single field of TCA 'types' 'showitem' can have three semicolon separated configuration options: fieldName: Name of the field to be found in TCA 'columns' section fieldLabel: An alternative field label paletteName: Name of a palette to be found in TCA 'palettes' section that is rendered after this field

protected explodeSingleFieldShowItemConfiguration(string $field) : array

Parameters

$field : string

Semicolon separated field configuration

Tags

throws
RuntimeException

Return values

array

getValidationDataAsJsonString()

Build JSON string for validations rules.

protected getValidationDataAsJsonString(array $config) : string

Parameters

$config : array

Return values

string

initializeResultArray()

Initialize the array that is returned to parent after calling. This structure is identical for *all* nodes. Parent will merge the return of a child with its own stuff and in itself return an array of the same structure.

protected initializeResultArray() : array{additionalInlineLanguageLabelFiles: list, stylesheetFiles: list, javaScriptModules: list, inlineData: array, html: string}

Return values

array{additionalInlineLanguageLabelFiles: list, stylesheetFiles: list, javaScriptModules: list, inlineData: array, html: string}

mergeChildReturnIntoExistingResult()

Merge existing data with a child return array.

protected mergeChildReturnIntoExistingResult(array $existing, array $childReturn[, bool $mergeHtml = true ]) : array

The incoming $childReturn array should be initialized using initializeResultArray() beforehand.

Parameters

$existing : array

Currently merged array

$childReturn : array

Array returned by child

$mergeHtml : bool = true

If false, the ['html'] section of $childReturn will NOT be added to $existing

Return values

array —

Result array

renderDescription()

protected renderDescription() : string

Return values

string

renderFieldControl()

Merge field control configuration with default controls and render them.

protected renderFieldControl() : array

Return values

array —

Result array

renderFieldInformation()

Merge field information configuration with default and render them.

protected renderFieldInformation() : array

Return values

array —

Result array

renderFieldWizard()

Merge field wizard configuration with default wizards and render them.

protected renderFieldWizard() : array

Return values

array —

Result array

renderTabMenu()

Render tabs with label and content. Used by TabsContainer and FlexFormTabsContainer.

protected renderTabMenu(array $menuItems, string $domId) : string

Re-uses the template Tabs.fluid.html which is also used by ModuleTemplate.php.

Parameters

$menuItems : array

Tab elements, each element is an array with "label" and "content"

$domId : string

DOM id attribute, will be appended with an iteration number per tab.

Return values

string

wrapWithFieldsetAndLegend()

protected wrapWithFieldsetAndLegend(string $fieldContent) : string

Parameters

$fieldContent : string

Return values

string
On this page