FilesControlContainer extends AbstractContainer

Files entry container.

This container is the entry step to rendering a file reference. It is created by SingleFieldContainer.

The code creates the main structure for the single file reference, initializes the inlineData array, that is manipulated and also returned in its manipulated state. The "control" stuff of file references is rendered here, for example the "create new" button.

For each existing file reference, a FileReferenceContainer is called for further processing.

Table of Contents

Properties

$backendViewFactory  : BackendViewFactory
$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  : mixed
$defaultFieldWizard  : mixed
$fileReferenceData  : array<string|int, mixed>
Inline data array used in JS, returned as JSON object to frontend
$javaScriptModules  : array<int, JavaScriptModuleInstruction|string|array<string, string>>
$nodeFactory  : NodeFactory

Methods

__construct()  : mixed
injectBackendViewFactory()  : mixed
injectNodeFactory()  : void
Injection of NodeFactory, which is used in this abstract already.
render()  : array<string|int, mixed>
Entry method
setData()  : void
Retrieve the current data array from NodeFactory.
explodeSingleFieldShowItemConfiguration()  : array<string|int, mixed>
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
extractFlexFormParts()  : array<string|int, mixed>|null
Extracts FlexForm parts of a form element name like data[table][uid][field][sDEF][lDEF][FlexForm][vDEF]
getBackendUserAuthentication()  : BackendUserAuthentication
getFileSelectors()  : array<string|int, mixed>
Generate buttons to select, reference and upload files.
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.
renderFieldControl()  : array<string|int, mixed>
Merge field control configuration with default controls and render them.
renderFieldInformation()  : array<string|int, mixed>
Merge field information configuration with default and render them.
renderFieldWizard()  : array<string|int, mixed>
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<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

protected mixed $defaultFieldInformation = ['tcaDescription' => ['renderType' => 'tcaDescription']]

$defaultFieldWizard

protected mixed $defaultFieldWizard = ['localizationStateSelector' => ['renderType' => 'localizationStateSelector']]

$fileReferenceData

Inline data array used in JS, returned as JSON object to frontend

protected array<string|int, mixed> $fileReferenceData = []

Methods

__construct()

public __construct(IconFactory $iconFactory, InlineStackProcessor $inlineStackProcessor, EventDispatcherInterface $eventDispatcher, OnlineMediaHelperRegistry $onlineMediaHelperRegistry, DefaultUploadFolderResolver $defaultUploadFolderResolver, HashService $hashService) : mixed
Parameters
$iconFactory : IconFactory
$inlineStackProcessor : InlineStackProcessor
$eventDispatcher : EventDispatcherInterface
$onlineMediaHelperRegistry : OnlineMediaHelperRegistry
$defaultUploadFolderResolver : DefaultUploadFolderResolver
$hashService : HashService

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<string|int, mixed>
Return values
array<string|int, mixed> —

As defined in initializeResultArray() of AbstractNode

setData()

Retrieve the current data array from NodeFactory.

public setData(array<string|int, mixed> $data) : void
Parameters
$data : array<string|int, mixed>

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<string|int, mixed>
Parameters
$field : string

Semicolon separated field configuration

Tags
throws
RuntimeException
Return values
array<string|int, mixed>

extractFlexFormParts()

Extracts FlexForm parts of a form element name like data[table][uid][field][sDEF][lDEF][FlexForm][vDEF]

protected extractFlexFormParts(string $formElementName) : array<string|int, mixed>|null
Parameters
$formElementName : string
Return values
array<string|int, mixed>|null

getFileSelectors()

Generate buttons to select, reference and upload files.

protected getFileSelectors(array<string|int, mixed> $inlineConfiguration, FileExtensionFilter $fileExtensionFilter) : array<string|int, mixed>
Parameters
$inlineConfiguration : array<string|int, mixed>
$fileExtensionFilter : FileExtensionFilter
Return values
array<string|int, mixed>

getValidationDataAsJsonString()

Build JSON string for validations rules.

protected getValidationDataAsJsonString(array<string|int, mixed> $config) : string
Parameters
$config : array<string|int, mixed>
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<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

renderFieldControl()

Merge field control configuration with default controls and render them.

protected renderFieldControl() : array<string|int, mixed>
Return values
array<string|int, mixed> —

Result array

renderFieldInformation()

Merge field information configuration with default and render them.

protected renderFieldInformation() : array<string|int, mixed>
Return values
array<string|int, mixed> —

Result array

renderFieldWizard()

Merge field wizard configuration with default wizards and render them.

protected renderFieldWizard() : array<string|int, mixed>
Return values
array<string|int, mixed> —

Result array

renderTabMenu()

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

protected renderTabMenu(array<string|int, mixed> $menuItems, string $domId) : string

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

Parameters
$menuItems : array<string|int, mixed>

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

        
    


            

                    

        

    

        

            
Search results