TYPO3CMS  8
 All Classes Namespaces Files Functions Variables Pages
FolderBasedFileCollection Class Reference
Inheritance diagram for FolderBasedFileCollection:
AbstractFileCollection AbstractRecordCollection RecordCollectionInterface PersistableCollectionInterface SortableCollectionInterface CollectionInterface NameableCollectionInterface

Public Member Functions

 loadContents ()
 
 getItemsCriteria ()
 
- Public Member Functions inherited from AbstractFileCollection
 setDescription ($description)
 
 setTitle ($title)
 
 fromArray (array $array)
 
 getItemsCriteria ()
 
 setItemsCriteria ($itemsCriteria)
 
 add (FileInterface $data)
 
 removeAll ()
 
- Public Member Functions inherited from 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 PersistableCollectionInterface
 persist ()
 

Protected Member Functions

 getPersistableDataArray ()
 
- Protected Member Functions inherited from AbstractFileCollection
 getPersistableDataArray ()
 
- Protected Member Functions inherited from AbstractRecordCollection
 getPersistableDataArray ()
 
 getItemUidList ($includeTableName=true)
 

Protected Attributes

 $folder
 
 $recursive
 
- Protected Attributes inherited from AbstractFileCollection
 $itemsCriteria
 
 $itemTableName = 'sys_file'
 
- Protected Attributes inherited from 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 AbstractFileCollection
static $storageTableName = 'sys_file_collection'
 
static $type
 
static $itemsCriteriaField
 
- Static Protected Attributes inherited from AbstractRecordCollection
static $storageTableName = 'sys_collection'
 
static $storageItemsField = 'items'
 

Additional Inherited Members

- Static Public Member Functions inherited from 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 25 of file core/Classes/Resource/Collection/FolderBasedFileCollection.php.

Member Function Documentation

getItemsCriteria ( )

Gets the items criteria.

Returns
string

Definition at line 81 of file core/Classes/Resource/Collection/FolderBasedFileCollection.php.

getPersistableDataArray ( )
protected

Returns an array of the persistable properties and contents which are processable by DataHandler.

Returns
array

Definition at line 92 of file core/Classes/Resource/Collection/FolderBasedFileCollection.php.

References AbstractRecordCollection\getDescription(), and AbstractRecordCollection\getTitle().

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 PersistableCollectionInterface.

Definition at line 66 of file core/Classes/Resource/Collection/FolderBasedFileCollection.php.

References AbstractFileCollection\add(), and Folder\FILTER_MODE_USE_OWN_AND_STORAGE_FILTERS.

Member Data Documentation

$folder
protected
$itemsCriteriaField = 'folder'
staticprotected
$recursive
protected
$storageTableName = 'sys_file_collection'
staticprotected
$type = 'folder'
staticprotected