Inheritance diagram for TYPO3\CMS\Core\Collection\PersistableCollectionInterface:

Public Member Functions
int string	getIdentifier ()

	setIdentifier ($id)

	persist ()

	loadContents ()

Static Public Member Functions
static TYPO3 CMS Core Collection CollectionInterface	load ($id, $fillItems=false)

Detailed Description

Interface for collection class being persistable

Collections are containers-classes handling the storage of data values (f.e. strings, records, relations) in a common and generic way, while the class manages the storage in an appropriate way itself

Definition at line 26 of file PersistableCollectionInterface.php.

Member Function Documentation

◆ getIdentifier()

int string TYPO3\CMS\Core\Collection\PersistableCollectionInterface::getIdentifier ( )

Get the identifier of the collection

For database stored collections, this will be an integer, session stored, registry stored or other collections might use a string as well

Returns: ‪int|string

Implemented in TYPO3\CMS\Core\Collection\AbstractRecordCollection.

◆ load()

static TYPO3 CMS Core Collection CollectionInterface TYPO3\CMS\Core\Collection\PersistableCollectionInterface::load	(	$id,
		$fillItems = `false`
	)

static

Loads the collections with the given id from persistence

For memory reasons, per default only f.e. title, database-table, identifier (what ever static data is defined) is loaded. Entries can be load on first access.

Parameters

int \| string	$id
bool	$fillItems	‪Populates the entries directly on load, might be bad for memory on large collections

Returns: ‪\TYPO3\CMS\Core\Collection\CollectionInterface

Implemented in TYPO3\CMS\Core\Collection\AbstractRecordCollection.

◆ loadContents()

TYPO3\CMS\Core\Collection\PersistableCollectionInterface::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.

Implemented in TYPO3\CMS\Core\Category\Collection\CategoryCollection, TYPO3\CMS\Core\Resource\Collection\FolderBasedFileCollection, TYPO3\CMS\Core\Resource\Collection\StaticFileCollection, TYPO3\CMS\Core\Resource\Collection\CategoryBasedFileCollection, TYPO3\CMS\Core\Tests\Unit\Resource\Collection\Fixtures\OtherTestingFileCollection, and TYPO3\CMS\Core\Tests\Unit\Resource\Collection\Fixtures\TestingFileCollection.