FieldControl extends AbstractNode
Field controls are additional HTML on a single element level that are typically shown right aside the main element HTML.
They are restricted to only allow an icon as output.
The "edit popup" button next to a select field of a renderType "selectMultipleSideBySide" is an example of such an additional control.
The element itself must position any field controls at an appropriate place. For instance the "group" element shows them in a row vertically, while others display single controls next to each other.
Table of Contents
Properties
- $data : array<string|int, mixed>
- Main data array to work on, given from parent to child elements
- $defaultFieldControl : array<string|int, mixed>
- A list of default field controls added to the element / container.
- $defaultFieldInformation : array<string|int, mixed>
- A list of default field information added to the element / container.
- $defaultFieldWizard : array<string|int, mixed>
- A list of default field wizards added to the element / container.
Methods
- __construct() : mixed
- render() : array<string|int, mixed>
- Order the list of field wizards to be rendered with the ordering service, then call each wizard element through the node factory and merge their results.
- setData() : void
- Retrieve the current data array from NodeFactory.
- getLanguageService() : LanguageService
- getValidationDataAsJsonString() : string
- Build JSON string for validations rules.
- initializeResultArray() : array<string|int, mixed>
- 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<string|int, mixed>
- Merge existing data with a child return array.
Properties
$data
Main data array to work on, given from parent to child elements
protected
array<string|int, mixed>
$data
= []
$defaultFieldControl
A list of default field controls added to the element / container.
protected
array<string|int, mixed>
$defaultFieldControl
= []
This property is often reset by single elements.
$defaultFieldInformation
A list of default field information added to the element / container.
protected
array<string|int, mixed>
$defaultFieldInformation
= []
$defaultFieldWizard
A list of default field wizards added to the element / container.
protected
array<string|int, mixed>
$defaultFieldWizard
= []
This property is often reset by single elements.
Methods
__construct()
public
__construct(NodeFactory $nodeFactory, IconFactory $iconFactory, DependencyOrderingService $dependencyOrderingService) : mixed
Parameters
- $nodeFactory : NodeFactory
- $iconFactory : IconFactory
- $dependencyOrderingService : DependencyOrderingService
render()
Order the list of field wizards to be rendered with the ordering service, then call each wizard element through the node factory and merge their results.
public
render() : array<string|int, mixed>
Return values
array<string|int, mixed> —Result array
setData()
Retrieve the current data array from NodeFactory.
public
setData(array<string|int, mixed> $data) : void
Parameters
- $data : array<string|int, mixed>
getLanguageService()
protected
getLanguageService() : LanguageService
Return values
LanguageServicegetValidationDataAsJsonString()
Build JSON string for validations rules.
protected
getValidationDataAsJsonString(array<string|int, mixed> $config) : string
Parameters
- $config : array<string|int, mixed>
Return values
stringinitializeResultArray()
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<string|int, mixed>
Return values
array<string|int, mixed>mergeChildReturnIntoExistingResult()
Merge existing data with a child return array.
protected
mergeChildReturnIntoExistingResult(array<string|int, mixed> $existing, array<string|int, mixed> $childReturn[, bool $mergeHtml = true ]) : array<string|int, mixed>
The incoming $childReturn array should be initialized using initializeResultArray() beforehand.
Parameters
- $existing : array<string|int, mixed>
-
Currently merged array
- $childReturn : array<string|int, mixed>
-
Array returned by child
- $mergeHtml : bool = true
-
If false, the ['html'] section of $childReturn will NOT be added to $existing
Return values
array<string|int, mixed> —Result array