TYPO3  7.6
Public Member Functions | Static Public Member Functions | List of all members
PersistableCollectionInterface Interface Reference
Inheritance diagram for PersistableCollectionInterface:
AbstractRecordCollection CategoryCollection StaticRecordCollection AbstractFileCollection CategoryCollection CategoryBasedFileCollection FolderBasedFileCollection StaticFileCollection

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 ( )

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

static 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$fillItemsPopulates the entries directly on load, might be bad for memory on large collections
Returns

Implemented in AbstractRecordCollection.

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 CategoryCollection, StaticRecordCollection, FolderBasedFileCollection, and CategoryBasedFileCollection.

persist ( )

Persists current collection state to underlying storage

Returns
void
setIdentifier (   $id)

Sets the identifier of the collection

Parameters
int | string$id
Returns
void

Implemented in AbstractRecordCollection.