FileReferenceContainer
class \
- Extends
- AbstractContainer
Render a single file reference.
This container is called by FilesControlContainer to render a single file (reference). The container is also called by FormEngine for an incoming ajax request to expand an existing file (reference) or to create a new one.
This container creates the outer HTML of single file (references) - e.g. drag and drop and delete buttons. For rendering of the record itself processing is handed over to FullRecordContainer.
Table of Contents
Constants
- NODE_TYPE_IDENTIFIER : mixed = 'fileReferenceContainer'
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.
- $eventDispatcher : EventDispatcherInterface
- $fileReferenceData : array
- File reference data used for JSON output
- $iconFactory : IconFactory
- $inlineStackProcessor : InlineStackProcessor
- $nodeFactory : NodeFactory
- Instance of the node factory to create sub elements, container and single element expansions.
Methods
- __construct() : mixed
- Set data to data array and register node factory to render sub elements
- render() : array
- Handler for single nodes
- 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
- getLabelFieldForRecord() : string
- getLanguageService() : LanguageService
- getRecordTitle() : string
- getTitleForRecord() : string
- getValidationDataAsJsonString() : string
- Build JSON string for validations rules.
- initializeResultArray() : array
- 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.
- 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.
- renderFileHeader() : string
- Renders the HTML header for the file, such as the title, toggle-function, drag'n'drop, etc.
- renderFileReference() : array
- renderFileReferenceHeaderControl() : string
- Render the control-icons for a file reference (e.g. create new, sorting, delete, disable/enable).
- renderTabMenu() : string
- Render tabs with label and content. Used by TabsContainer and FlexFormTabsContainer.
Constants
NODE_TYPE_IDENTIFIER
public
mixed
NODE_TYPE_IDENTIFIER
= 'fileReferenceContainer'
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.
$eventDispatcher
protected
EventDispatcherInterface
$eventDispatcher
$fileReferenceData
File reference data used for JSON output
protected
array
$fileReferenceData
= []
$iconFactory
protected
IconFactory
$iconFactory
$inlineStackProcessor
protected
InlineStackProcessor
$inlineStackProcessor
$nodeFactory
Instance of the node factory to create sub elements, container and single element expansions.
Deprecated
since TYPO3 v12.4. will be removed in TYPO3 v13.0.
protected
NodeFactory
$nodeFactory
Methods
__construct()
Set data to data array and register node factory to render sub elements
public
__construct(NodeFactory $nodeFactory, array $data) : mixed
Parameters
- $nodeFactory : NodeFactory
- $data : array
render()
Handler for single nodes
public
render() : array
Return values
array —As defined in initializeResultArray() of AbstractNode
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
Return values
arraygetBackendUserAuthentication()
protected
getBackendUserAuthentication() : BackendUserAuthentication
Return values
BackendUserAuthenticationgetLabelFieldForRecord()
protected
getLabelFieldForRecord(array $databaseRow, array $fileRecord, string $field) : string
Parameters
- $databaseRow : array
- $fileRecord : array
- $field : string
Return values
stringgetLanguageService()
protected
getLanguageService() : LanguageService
Return values
LanguageServicegetRecordTitle()
protected
getRecordTitle() : string
Return values
stringgetTitleForRecord()
protected
getTitleForRecord(array $databaseRow, array $fileRecord) : string
Parameters
- $databaseRow : array
- $fileRecord : array
Return values
stringgetValidationDataAsJsonString()
Build JSON string for validations rules.
protected
getValidationDataAsJsonString(array $config) : string
Parameters
- $config : array
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
Return values
arraymergeChildReturnIntoExistingResult()
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
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
renderFileHeader()
Renders the HTML header for the file, such as the title, toggle-function, drag'n'drop, etc.
protected
renderFileHeader(string $ariaAttributesString) : string
Later on the command-icons are inserted here, too.
Parameters
- $ariaAttributesString : string
Return values
stringrenderFileReference()
protected
renderFileReference(array $data) : array
Parameters
- $data : array
Return values
arrayrenderFileReferenceHeaderControl()
Render the control-icons for a file reference (e.g. create new, sorting, delete, disable/enable).
protected
renderFileReferenceHeaderControl() : string
Return values
stringrenderTabMenu()
Render tabs with label and content. Used by TabsContainer and FlexFormTabsContainer.
protected
renderTabMenu(array $menuItems, string $domId[, int $defaultTabIndex = 1 ]) : string
Re-uses the template Tabs.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.
- $defaultTabIndex : int = 1