TYPO3 CMS  TYPO3_7-6
TYPO3\CMS\Core\Resource\Collection\FolderBasedFileCollection Class Reference
Inheritance diagram for TYPO3\CMS\Core\Resource\Collection\FolderBasedFileCollection:
TYPO3\CMS\Core\Resource\Collection\AbstractFileCollection TYPO3\CMS\Core\Collection\AbstractRecordCollection TYPO3\CMS\Core\Collection\RecordCollectionInterface TYPO3\CMS\Core\Collection\PersistableCollectionInterface TYPO3\CMS\Core\Collection\SortableCollectionInterface TYPO3\CMS\Core\Collection\CollectionInterface TYPO3\CMS\Core\Collection\NameableCollectionInterface

Public Member Functions

 loadContents ()
 
 getItemsCriteria ()
 
- Public Member Functions inherited from TYPO3\CMS\Core\Resource\Collection\AbstractFileCollection
 setDescription ($description)
 
 setTitle ($title)
 
 fromArray (array $array)
 
 getItemsCriteria ()
 
 setItemsCriteria ($itemsCriteria)
 
 add (\TYPO3\CMS\Core\Resource\FileInterface $data)
 
 removeAll ()
 
- Public Member Functions inherited from TYPO3\CMS\Core\Collection\AbstractRecordCollection
 __construct ()
 
 current ()
 
 next ()
 
 key ()
 
 valid ()
 
 rewind ()
 
 serialize ()
 
 unserialize ($serialized)
 
 count ()
 
 getTitle ()
 
 getUid ()
 
 getDescription ()
 
 setTitle ($title)
 
 setDescription ($desc)
 
 getItemTableName ()
 
 setItemTableName ($tableName)
 
 usort ($callbackFunction)
 
 moveItemAt ($currentPosition, $newPosition=0)
 
 getIdentifier ()
 
 setIdentifier ($id)
 
 toArray ()
 
 fromArray (array $array)
 
- Public Member Functions inherited from TYPO3\CMS\Core\Collection\PersistableCollectionInterface
 persist ()
 

Protected Member Functions

 getPersistableDataArray ()
 
- Protected Member Functions inherited from TYPO3\CMS\Core\Resource\Collection\AbstractFileCollection
 getPersistableDataArray ()
 
- Protected Member Functions inherited from TYPO3\CMS\Core\Collection\AbstractRecordCollection
 getPersistableDataArray ()
 
 getItemUidList ($includeTableName=true)
 

Protected Attributes

 $folder
 
 $recursive
 
- Protected Attributes inherited from TYPO3\CMS\Core\Resource\Collection\AbstractFileCollection
 $itemsCriteria
 
 $itemTableName = 'sys_file'
 
- Protected Attributes inherited from TYPO3\CMS\Core\Collection\AbstractRecordCollection
 $uid = 0
 
 $title
 
 $description
 
 $itemTableName
 
 $storage
 

Static Protected Attributes

static $storageTableName = 'sys_file_collection'
 
static $type = 'folder'
 
static $itemsCriteriaField = 'folder'
 
- Static Protected Attributes inherited from TYPO3\CMS\Core\Resource\Collection\AbstractFileCollection
static $storageTableName = 'sys_file_collection'
 
static $type
 
static $itemsCriteriaField
 
- Static Protected Attributes inherited from TYPO3\CMS\Core\Collection\AbstractRecordCollection
static $storageTableName = 'sys_collection'
 
static $storageItemsField = 'items'
 

Additional Inherited Members

- Static Public Member Functions inherited from TYPO3\CMS\Core\Collection\AbstractRecordCollection
static load ($id, $fillItems=false)
 
static create (array $collectionRecord, $fillItems=false)
 

Detailed Description

A collection containing a set of files to be represented as a (virtual) folder. This collection is persisted to the database with the accordant folder reference.

Definition at line 23 of file FolderBasedFileCollection.php.

Member Function Documentation

◆ getItemsCriteria()

TYPO3\CMS\Core\Resource\Collection\FolderBasedFileCollection::getItemsCriteria ( )

Gets the items criteria.

Returns
string

Definition at line 79 of file FolderBasedFileCollection.php.

◆ getPersistableDataArray()

TYPO3\CMS\Core\Resource\Collection\FolderBasedFileCollection::getPersistableDataArray ( )
protected

◆ loadContents()

TYPO3\CMS\Core\Resource\Collection\FolderBasedFileCollection::loadContents ( )

Populates the content-entries of the storage

Queries the underlying storage for entries of the collection and adds them to the collection data.

If the content entries of the storage had not been loaded on creation ($fillItems = false) this function is to be used for loading the contents afterwards.

Returns
void

Implements TYPO3\CMS\Core\Collection\PersistableCollectionInterface.

Definition at line 64 of file FolderBasedFileCollection.php.

References TYPO3\CMS\Core\Resource\Collection\AbstractFileCollection\add(), and TYPO3\CMS\Core\Resource\Folder\FILTER_MODE_USE_OWN_AND_STORAGE_FILTERS.

Member Data Documentation

◆ $folder

TYPO3\CMS\Core\Resource\Collection\FolderBasedFileCollection::$folder
protected

Definition at line 45 of file FolderBasedFileCollection.php.

◆ $itemsCriteriaField

TYPO3\CMS\Core\Resource\Collection\FolderBasedFileCollection::$itemsCriteriaField = 'folder'
staticprotected

Definition at line 38 of file FolderBasedFileCollection.php.

◆ $recursive

TYPO3\CMS\Core\Resource\Collection\FolderBasedFileCollection::$recursive
protected

Definition at line 50 of file FolderBasedFileCollection.php.

◆ $storageTableName

TYPO3\CMS\Core\Resource\Collection\FolderBasedFileCollection::$storageTableName = 'sys_file_collection'
staticprotected

Definition at line 28 of file FolderBasedFileCollection.php.

◆ $type

TYPO3\CMS\Core\Resource\Collection\FolderBasedFileCollection::$type = 'folder'
staticprotected

Definition at line 33 of file FolderBasedFileCollection.php.