TYPO3\CMS\Core\Collection\PersistableCollectionInterface Interface Reference

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

Public Member Functions
	getIdentifier ()
	setIdentifier ($id)
	persist ()
	loadContents ()

Static Public Member Functions
static	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 25 of file PersistableCollectionInterface.php.

Member Function Documentation

getIdentifier()

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\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

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.

Returns

void

Implemented in TYPO3\CMS\Core\Category\Collection\CategoryCollection, TYPO3\CMS\Core\Collection\StaticRecordCollection, TYPO3\CMS\Core\Resource\Collection\FolderBasedFileCollection, and TYPO3\CMS\Core\Resource\Collection\CategoryBasedFileCollection.

persist()

TYPO3\CMS\Core\Collection\PersistableCollectionInterface::persist

(

)

Persists current collection state to underlying storage

Returns

void

Referenced by TYPO3\CMS\Core\Collection\AbstractRecordCollection\create().

setIdentifier()

TYPO3\CMS\Core\Collection\PersistableCollectionInterface::setIdentifier

(

$id

)

Sets the identifier of the collection

Parameters

int | string

$id

Returns

void

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