TYPO3  7.6
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
FileCollector Class Reference
Inheritance diagram for FileCollector:

Public Member Functions

 addFiles (array $fileUids=array())
 
 addFilesFromRelation ($relationTable, $relationField, array $referenceRecord)
 
 addFileReferences (array $fileReferenceUids=array())
 
 addFilesFromFileCollections (array $fileCollectionUids=array())
 
 addFilesFromFileCollection ($fileCollectionUid=null)
 
 addFilesFromFolders (array $folderIdentifiers=array(), $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 = array()
 
 $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 ( FileInterface  $file)

Add a file object to the collection

Parameters
FileInterface$fileThe file object
Returns
void

Definition at line 244 of file FileCollector.php.

Referenced by FileCollector\addFileReferences(), and FileCollector\addFiles().

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 FileCollector\$files.

Referenced by FileCollector\addFilesFromFileCollection(), FileCollector\addFilesFromFolder(), and FileCollector\addFilesFromRelation().

addFileReferences ( array  $fileReferenceUids = array())

Add files from UIDs of a reference

Parameters
array$fileReferenceUids
Returns
void

Definition at line 113 of file FileCollector.php.

References FileCollector\addFileObject(), and FileCollector\getFileRepository().

addFiles ( array  $fileUids = array())

Add files

Parameters
array$fileUids

Definition at line 69 of file FileCollector.php.

References FileCollector\addFileObject(), FileCollector\getLogger(), and FileCollector\getResourceFactory().

addFilesFromFileCollection (   $fileCollectionUid = null)

Add files to the collection from one single file collection

Parameters
int$fileCollectionUidThe file collections uid
Returns
void

Definition at line 140 of file FileCollector.php.

References FileCollector\$files, FileCollector\addFileObjects(), FileCollector\getFileCollectionRepository(), and FileCollector\getLogger().

Referenced by FileCollector\addFilesFromFileCollections().

addFilesFromFileCollections ( array  $fileCollectionUids = array())

Add files to the collection from multiple file collections

Parameters
array$fileCollectionUidsThe file collections uids
Returns
void

Definition at line 127 of file FileCollector.php.

References FileCollector\addFilesFromFileCollection().

addFilesFromFolder (   $folderIdentifier,
  $recursive = false 
)

Add files to the collection from one single folder

Parameters
string$folderIdentifierThe folder identifier
bool$recursiveAdd files recursive from given folders

Definition at line 182 of file FileCollector.php.

References FileCollector\$files, FileCollector\addFileObjects(), Folder\FILTER_MODE_USE_OWN_AND_STORAGE_FILTERS, FileCollector\getLogger(), and FileCollector\getResourceFactory().

Referenced by FileCollector\addFilesFromFolders().

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

Add files to the collection from multiple folders

Parameters
array$folderIdentifiersThe folder identifiers
bool$recursiveAdd files recursive from given folders
Returns
void

Definition at line 169 of file FileCollector.php.

References FileCollector\addFilesFromFolder().

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

Add files to the collection from a relation

Parameters
string$relationTableThe table of the relation (e.g. tt_content or pages)
string$relationFieldThe field which holds the files (e.g. media or images)
array$referenceRecordthe record which is referencing the files
Returns
void

Definition at line 94 of file FileCollector.php.

References $GLOBALS, FileCollector\addFileObjects(), and FileCollector\getFileRepository().

Referenced by FilesContentObject\addFileReferences().

count ( )
Returns
int

Definition at line 273 of file FileCollector.php.

Referenced by FileCollector\sort().

getFileCollectionRepository ( )
protected
Returns
FileCollectionRepository

Definition at line 300 of file FileCollector.php.

References FileCollector\$fileCollectionRepository, and GeneralUtility\makeInstance().

Referenced by FileCollector\addFilesFromFileCollection().

getFileRepository ( )
protected
getFiles ( )

Final getter method to fetch the accumulated data

Returns
array

Definition at line 265 of file FileCollector.php.

References FileCollector\$files.

getLogger ( )
protected
getResourceFactory ( )
protected
Returns
ResourceFactory

Definition at line 289 of file FileCollector.php.

References FileCollector\$resourceFactory, and GeneralUtility\makeInstance().

Referenced by FileCollector\addFiles(), and FileCollector\addFilesFromFolder().

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

Sort the file objects based on a property

Parameters
string$sortingPropertyThe sorting property
string$sortingOrdercan be ascending or descending or "random"
Returns
void

Definition at line 208 of file FileCollector.php.

References FileCollector\count(), FileInterface\getProperty(), and FileInterface\hasProperty().

Member Data Documentation

$fileCollectionRepository
protected

Definition at line 55 of file FileCollector.php.

Referenced by FileCollector\getFileCollectionRepository().

$fileRepository
protected

Definition at line 48 of file FileCollector.php.

Referenced by FileCollector\getFileRepository().

$files = array()
protected
$resourceFactory
protected

Definition at line 62 of file FileCollector.php.

Referenced by FileCollector\getResourceFactory().