Inheritance diagram for TYPO3\CMS\Frontend\Resource\FileCollector:

Public Member Functions
	addFiles (array $fileUids=[])

	addFilesFromRelation ($relationTable, $relationField, array $referenceRecord)

	addFileReferences (array $fileReferenceUids=[])

	addFilesFromFileCollections (array $fileCollectionUids=[])

	addFilesFromFileCollection ($fileCollectionUid=null)

	addFilesFromFolders (array $folderIdentifiers=[], $recursive=false)

	addFilesFromFolder ($folderIdentifier, $recursive=false)

	sort ($sortingProperty='', $sortingOrder='ascending')

	addFileObject (FileInterface $file)

	addFileObjects ($files)

	getFiles ()

	count ()

Protected Member Functions
	getLogger ()

	getResourceFactory ()

	getFileCollectionRepository ()

	getFileRepository ()

Protected Attributes
	$files = []

	$fileRepository

	$fileCollectionRepository

	$resourceFactory

Detailed Description

Object to collect files from various sources during runtime Sources can be file references, file collections or folders

Use in FILES Content Object or for a Fluid Data Processor

Is not persisted, use only in FE.

Definition at line 34 of file FileCollector.php.

Member Function Documentation

◆ addFileObject()

TYPO3\CMS\Frontend\Resource\FileCollector::addFileObject ( FileInterface $file )

Add a file object to the collection

Parameters

FileInterface $file The file object

Returns: void

Definition at line 244 of file FileCollector.php.

Referenced by TYPO3\CMS\Frontend\Resource\FileCollector\addFileReferences(), and TYPO3\CMS\Frontend\Resource\FileCollector\addFiles().

◆ addFileObjects()

TYPO3\CMS\Frontend\Resource\FileCollector::addFileObjects ( $files )

Add multiple file objects to the collection

Parameters

FileInterface[] $files The file objects

Returns: void

Definition at line 255 of file FileCollector.php.

References TYPO3\CMS\Frontend\Resource\FileCollector\$files.

Referenced by TYPO3\CMS\Frontend\Resource\FileCollector\addFilesFromFileCollection(), TYPO3\CMS\Frontend\Resource\FileCollector\addFilesFromFolder(), and TYPO3\CMS\Frontend\Resource\FileCollector\addFilesFromRelation().

◆ addFileReferences()

TYPO3\CMS\Frontend\Resource\FileCollector::addFileReferences ( array $fileReferenceUids = [] )

Add files from UIDs of a reference

Parameters

array $fileReferenceUids

Returns: void

Definition at line 113 of file FileCollector.php.

References TYPO3\CMS\Frontend\Resource\FileCollector\addFileObject(), and TYPO3\CMS\Frontend\Resource\FileCollector\getFileRepository().

◆ addFiles()

TYPO3\CMS\Frontend\Resource\FileCollector::addFiles ( array $fileUids = [] )

Add files

Parameters

array $fileUids

Definition at line 69 of file FileCollector.php.

References TYPO3\CMS\Frontend\Resource\FileCollector\addFileObject(), TYPO3\CMS\Frontend\Resource\FileCollector\getLogger(), and TYPO3\CMS\Frontend\Resource\FileCollector\getResourceFactory().

◆ addFilesFromFileCollection()

TYPO3\CMS\Frontend\Resource\FileCollector::addFilesFromFileCollection ( $fileCollectionUid = null )

Add files to the collection from one single file collection

Parameters

int $fileCollectionUid The file collections uid

Returns: void

Definition at line 140 of file FileCollector.php.

References TYPO3\CMS\Frontend\Resource\FileCollector\$files, TYPO3\CMS\Frontend\Resource\FileCollector\addFileObjects(), TYPO3\CMS\Frontend\Resource\FileCollector\getFileCollectionRepository(), and TYPO3\CMS\Frontend\Resource\FileCollector\getLogger().

Referenced by TYPO3\CMS\Frontend\Resource\FileCollector\addFilesFromFileCollections().

◆ addFilesFromFileCollections()

TYPO3\CMS\Frontend\Resource\FileCollector::addFilesFromFileCollections ( array $fileCollectionUids = [] )

Add files to the collection from multiple file collections

Parameters

array $fileCollectionUids The file collections uids

Returns: void

Definition at line 127 of file FileCollector.php.

References TYPO3\CMS\Frontend\Resource\FileCollector\addFilesFromFileCollection().

◆ addFilesFromFolder()

TYPO3\CMS\Frontend\Resource\FileCollector::addFilesFromFolder	(	$folderIdentifier,
		$recursive = `false`
	)

Add files to the collection from one single folder

Parameters

string	$folderIdentifier	The folder identifier
bool	$recursive	Add files recursive from given folders

Definition at line 182 of file FileCollector.php.

References TYPO3\CMS\Frontend\Resource\FileCollector\$files, TYPO3\CMS\Frontend\Resource\FileCollector\addFileObjects(), TYPO3\CMS\Core\Resource\Folder\FILTER_MODE_USE_OWN_AND_STORAGE_FILTERS, TYPO3\CMS\Frontend\Resource\FileCollector\getLogger(), and TYPO3\CMS\Frontend\Resource\FileCollector\getResourceFactory().

Referenced by TYPO3\CMS\Frontend\Resource\FileCollector\addFilesFromFolders().

◆ addFilesFromFolders()

TYPO3\CMS\Frontend\Resource\FileCollector::addFilesFromFolders	(	array	$folderIdentifiers = `[]`,
			$recursive = `false`
	)

Add files to the collection from multiple folders

Parameters

array	$folderIdentifiers	The folder identifiers
bool	$recursive	Add files recursive from given folders

Returns: void

Definition at line 169 of file FileCollector.php.

References TYPO3\CMS\Frontend\Resource\FileCollector\addFilesFromFolder().

◆ addFilesFromRelation()

TYPO3\CMS\Frontend\Resource\FileCollector::addFilesFromRelation	(		$relationTable,
			$relationField,
		array	$referenceRecord
	)

Add files to the collection from a relation

Parameters

string	$relationTable	The table of the relation (e.g. tt_content or pages)
string	$relationField	The field which holds the files (e.g. media or images)
array	$referenceRecord	the record which is referencing the files