FieldInformation

class \TYPO3\CMS\Backend\Form\NodeExpansion\FieldInformation

Extends
AbstractNode

Field information are additional HTML on a single node level that are typically shown between the label and the main element. They are registered in ['config']['fieldInformation'] TCA section and each element may merge that with default registered information.

Field information must not add additional functionality to the element. They are only allowed to add "informational" stuff like links, div and spans and similar.

Table of Contents

Properties

$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.

Methods

__construct()  : mixed
render()  : array
Order the list of field information to be rendered with the ordering service, then call each information element through the node factory and merge their results.
setData()  : void
Retrieve the current data array from NodeFactory.
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.

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

render()

Order the list of field information to be rendered with the ordering service, then call each information element through the node factory and merge their results.

public render() : array

Return values

array —

Result array

setData()

Retrieve the current data array from NodeFactory.

public setData(array $data) : void

Parameters

$data : 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

On this page