Inheritance diagram for TYPO3\CMS\Core\Resource\Collection\FolderBasedFileCollection:

Public Member Functions
	loadContents ()

string	getItemsCriteria ()

	fromArray (array $array)

‪Public Member Functions inherited from ‪TYPO3\CMS\Core\Resource\Collection\AbstractFileCollection
	setDescription ($description)

string	key ()

array	toArray ()

array	getItems ()

	setItemsCriteria ($itemsCriteria)

	add (FileInterface $data)

	addAll (CollectionInterface $other)

	remove (File $file)

	removeAll ()

‪Public Member Functions inherited from ‪TYPO3\CMS\Core\Collection\AbstractRecordCollection
	__construct ()

T null	current ()

	next ()

bool	valid ()

	rewind ()

	__serialize ()

	__unserialize (array $arrayRepresentation)

int	count ()

string	getTitle ()

int	getUid ()

string	getDescription ()

	setTitle ($title)

string	getItemTableName ()

	setItemTableName ($tableName)

	usort ($callbackFunction)

	moveItemAt ($currentPosition, $newPosition=0)

int	getIdentifier ()

	setIdentifier ($id)

	persist ()

Protected Member Functions
array	getPersistableDataArray ()

‪Protected Member Functions inherited from ‪TYPO3\CMS\Core\Resource\Collection\AbstractFileCollection
string	getItemUidList ($includeTableName=false)

Protected Attributes
TYPO3 CMS Core Resource Folder	$folder

bool	$recursive

‪Protected Attributes inherited from ‪TYPO3\CMS\Core\Resource\Collection\AbstractFileCollection
mixed	$itemsCriteria

string	$itemTableName = 'sys_file'

‪Protected Attributes inherited from ‪TYPO3\CMS\Core\Collection\AbstractRecordCollection
int	$uid = 0

string	$title

string	$description

string	$itemTableName

SplDoublyLinkedList	$storage

Static Protected Attributes
static string	$storageTableName = 'sys_file_collection'

static string	$type = 'folder'

static string	$itemsCriteriaField = 'folder'

‪Static Protected Attributes inherited from ‪TYPO3\CMS\Core\Resource\Collection\AbstractFileCollection
static string	$storageTableName = 'sys_file_collection'

static string	$type

static string	$itemsCriteriaField

‪Static Protected Attributes inherited from ‪TYPO3\CMS\Core\Collection\AbstractRecordCollection
static string	$storageItemsField = 'items'

static string	$storageTableName = ''

Additional Inherited Members
‪Static Public Member Functions inherited from ‪TYPO3\CMS\Core\Collection\AbstractRecordCollection
static CollectionInterface	load ($id, $fillItems=false)

static CollectionInterface	create (array $collectionRecord, $fillItems=false)

‪Static Protected Member Functions inherited from ‪TYPO3\CMS\Core\Collection\AbstractRecordCollection
static	getCollectionDatabaseTable ()

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 26 of file FolderBasedFileCollection.php.

Member Function Documentation

◆ fromArray()

TYPO3\CMS\Core\Resource\Collection\FolderBasedFileCollection::fromArray ( array $array )

Similar to method in \TYPO3\CMS\Core\Collection\AbstractRecordCollection, but without $this->itemTableName= $array['table_name'], but with $this->storageItemsFieldContent = $array[self::$storageItemsField];

Reimplemented from TYPO3\CMS\Core\Resource\Collection\AbstractFileCollection.

Definition at line 101 of file FolderBasedFileCollection.php.

References TYPO3\CMS\Core\Collection\AbstractRecordCollection\$storage, TYPO3\CMS\Redirects\Message\description, and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

◆ getItemsCriteria()

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

Gets the items criteria.

Returns: ‪string

Reimplemented from TYPO3\CMS\Core\Resource\Collection\AbstractFileCollection.

Definition at line 75 of file FolderBasedFileCollection.php.

◆ getPersistableDataArray()

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

protected

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

Returns: ‪array

Reimplemented from TYPO3\CMS\Core\Resource\Collection\AbstractFileCollection.

Definition at line 86 of file FolderBasedFileCollection.php.

References TYPO3\CMS\Core\Resource\Collection\FolderBasedFileCollection\$type, TYPO3\CMS\Core\Collection\AbstractRecordCollection\getDescription(), and TYPO3\CMS\Core\Collection\AbstractRecordCollection\getTitle().

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

Implements TYPO3\CMS\Core\Collection\PersistableCollectionInterface.

Definition at line 60 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.