TYPO3\CMS\Backend\Form\Container\FilesControlContainer Class Reference

Inheritance diagram for TYPO3\CMS\Backend\Form\Container\FilesControlContainer:

Public Member Functions
	__construct (private readonly IconFactory $iconFactory, private readonly InlineStackProcessor $inlineStackProcessor, private readonly EventDispatcherInterface $eventDispatcher, private readonly OnlineMediaHelperRegistry $onlineMediaHelperRegistry, private readonly DefaultUploadFolderResolver $defaultUploadFolderResolver, private readonly HashService $hashService,)
array	render ()
‪Public Member Functions inherited from ‪TYPO3\CMS\Backend\Form\Container\AbstractContainer
	injectNodeFactory (NodeFactory $nodeFactory)
	injectBackendViewFactory (BackendViewFactory $backendViewFactory)
‪Public Member Functions inherited from ‪TYPO3\CMS\Backend\Form\AbstractNode
	setData (array $data)

Public Attributes
const	NODE_TYPE_IDENTIFIER = 'file'

Protected Member Functions
	getFileSelectors (array $inlineConfiguration, FileExtensionFilter $fileExtensionFilter)
	extractFlexFormParts (string $formElementName)
	getLanguageService ()
‪Protected Member Functions inherited from ‪TYPO3\CMS\Backend\Form\Container\AbstractContainer
array	renderFieldInformation ()
array	renderFieldControl ()
array	renderFieldWizard ()
	explodeSingleFieldShowItemConfiguration (string $field)
	renderTabMenu (array $menuItems, string $domId)
	wrapWithFieldsetAndLegend (string $fieldContent)
	getBackendUserAuthentication ()
‪Protected Member Functions inherited from ‪TYPO3\CMS\Backend\Form\AbstractNode
	initializeResultArray ()
array	mergeChildReturnIntoExistingResult (array $existing, array $childReturn, bool $mergeHtml=true)
	getValidationDataAsJsonString (array $config)

Protected Attributes
array	$fileReferenceData = []
array	$javaScriptModules = []
	$defaultFieldInformation
	$defaultFieldWizard
‪Protected Attributes inherited from ‪TYPO3\CMS\Backend\Form\Container\AbstractContainer
NodeFactory	$nodeFactory
BackendViewFactory	$backendViewFactory
‪Protected Attributes inherited from ‪TYPO3\CMS\Backend\Form\AbstractNode
array	$data = []
array	$defaultFieldInformation = array( )
array	$defaultFieldControl = array( )
array	$defaultFieldWizard = array( )

Private Attributes
const	FILE_REFERENCE_TABLE = 'sys_file_reference'

Detailed Description

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.

Definition at line 48 of file FilesControlContainer.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Backend\Form\Container\FilesControlContainer::__construct	(	private readonly IconFactory	$iconFactory,
		private readonly InlineStackProcessor	$inlineStackProcessor,
		private readonly EventDispatcherInterface	$eventDispatcher,
		private readonly OnlineMediaHelperRegistry	$onlineMediaHelperRegistry,
		private readonly DefaultUploadFolderResolver	$defaultUploadFolderResolver,
		private readonly HashService	$hashService
	)

Definition at line 76 of file FilesControlContainer.php.

Member Function Documentation

extractFlexFormParts()

TYPO3\CMS\Backend\Form\Container\FilesControlContainer::extractFlexFormParts ( string  $formElementName )

protected

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

Definition at line 424 of file FilesControlContainer.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

Referenced by TYPO3\CMS\Backend\Form\Container\FilesControlContainer\render().

getFileSelectors()

TYPO3\CMS\Backend\Form\Container\FilesControlContainer::getFileSelectors ( array  $inlineConfiguration, FileExtensionFilter  $fileExtensionFilter  )

protected

Generate buttons to select, reference and upload files.

Definition at line 304 of file FilesControlContainer.php.

References TYPO3\CMS\Core\Page\JavaScriptModuleInstruction\create(), TYPO3\CMS\Core\Utility\StringUtility\escapeCssSelector(), TYPO3\CMS\Backend\Form\Container\FilesControlContainer\FILE_REFERENCE_TABLE, TYPO3\CMS\Core\Resource\Filter\FileExtensionFilter\getAllowedFileExtensions(), TYPO3\CMS\Backend\Form\Container\AbstractContainer\getBackendUserAuthentication(), TYPO3\CMS\Core\Resource\Filter\FileExtensionFilter\getDisallowedFileExtensions(), TYPO3\CMS\Backend\Form\Container\FilesControlContainer\getLanguageService(), TYPO3\CMS\Core\Resource\Folder\getStorage(), and TYPO3\CMS\Core\Resource\Filter\FileExtensionFilter\isAllowed().

Referenced by TYPO3\CMS\Backend\Form\Container\FilesControlContainer\render().

getLanguageService()

TYPO3\CMS\Backend\Form\Container\FilesControlContainer::getLanguageService ( )

protected

Definition at line 437 of file FilesControlContainer.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Backend\Form\Container\FilesControlContainer\getFileSelectors(), and TYPO3\CMS\Backend\Form\Container\FilesControlContainer\render().

render()

array TYPO3\CMS\Backend\Form\Container\FilesControlContainer::render

(

)

Entry method

Returns

‪array As defined in initializeResultArray() of AbstractNode

Reimplemented from TYPO3\CMS\Backend\Form\AbstractNode.

Definition at line 90 of file FilesControlContainer.php.

References TYPO3\CMS\Backend\Form\Container\FilesControlContainer\$fileReferenceData, $GLOBALS, TYPO3\CMS\Core\Utility\MathUtility\canBeInterpretedAsInteger(), TYPO3\CMS\Core\Page\JavaScriptModuleInstruction\create(), TYPO3\CMS\Backend\Form\Container\FilesControlContainer\extractFlexFormParts(), TYPO3\CMS\Backend\Form\Container\FilesControlContainer\FILE_REFERENCE_TABLE, TYPO3\CMS\Backend\Form\Container\FilesControlContainer\getFileSelectors(), TYPO3\CMS\Backend\Form\Container\FilesControlContainer\getLanguageService(), TYPO3\CMS\Backend\Form\AbstractNode\getValidationDataAsJsonString(), TYPO3\CMS\Backend\Form\AbstractNode\initializeResultArray(), TYPO3\CMS\Backend\Form\AbstractNode\mergeChildReturnIntoExistingResult(), TYPO3\CMS\Backend\Form\Container\FileReferenceContainer\NODE_TYPE_IDENTIFIER, TYPO3\CMS\Backend\Form\Container\AbstractContainer\renderFieldInformation(), TYPO3\CMS\Backend\Form\Container\AbstractContainer\renderFieldWizard(), and TYPO3\CMS\Backend\Form\Container\AbstractContainer\wrapWithFieldsetAndLegend().

Member Data Documentation

$defaultFieldInformation

TYPO3\CMS\Backend\Form\Container\FilesControlContainer::$defaultFieldInformation

protected

Initial value:

= array( 
        'tcaDescription' => [
            'renderType' => 'tcaDescription',
        ],
     )

Definition at line 64 of file FilesControlContainer.php.

$defaultFieldWizard

TYPO3\CMS\Backend\Form\Container\FilesControlContainer::$defaultFieldWizard

protected

Initial value:

= array( 
        'localizationStateSelector' => [
            'renderType' => 'localizationStateSelector',
        ],
     )

Definition at line 70 of file FilesControlContainer.php.

$fileReferenceData

array TYPO3\CMS\Backend\Form\Container\FilesControlContainer::$fileReferenceData = []

protected

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

Definition at line 57 of file FilesControlContainer.php.

Referenced by TYPO3\CMS\Backend\Form\Container\FilesControlContainer\render().

$javaScriptModules

array TYPO3\CMS\Backend\Form\Container\FilesControlContainer::$javaScriptModules = []

protected

Definition at line 62 of file FilesControlContainer.php.

FILE_REFERENCE_TABLE

const TYPO3\CMS\Backend\Form\Container\FilesControlContainer::FILE_REFERENCE_TABLE = 'sys_file_reference'

private

Definition at line 52 of file FilesControlContainer.php.

Referenced by TYPO3\CMS\Backend\Form\Container\FilesControlContainer\getFileSelectors(), and TYPO3\CMS\Backend\Form\Container\FilesControlContainer\render().

NODE_TYPE_IDENTIFIER

const TYPO3\CMS\Backend\Form\Container\FilesControlContainer::NODE_TYPE_IDENTIFIER = 'file'

Definition at line 50 of file FilesControlContainer.php.