interface CollectionPersister (View source)

Define the behavior that should be implemented by all collection persisters.

Methods

void
delete(PersistentCollection $collection)

Deletes the persistent state represented by the given collection.

void
update(PersistentCollection $collection)

Updates the given collection, synchronizing its state with the database by inserting, updating and deleting individual elements.

int
count(PersistentCollection $collection)

Counts the size of this persistent collection.

mixed[]
slice(PersistentCollection $collection, $offset, $length = null)

Slices elements.

bool
contains(PersistentCollection $collection, $element)

Checks for existence of an element.

bool
containsKey(PersistentCollection $collection, $key)

Checks for existence of a key.

mixed
removeElement(PersistentCollection $collection, $element)

Removes an element.

mixed
get(PersistentCollection $collection, $index)

Gets an element by key.

mixed[]
loadCriteria(PersistentCollection $collection, Criteria $criteria)

Loads association entities matching the given Criteria object.

Details

void delete(PersistentCollection $collection)

Deletes the persistent state represented by the given collection.

Parameters

PersistentCollection $collection

Return Value

void

void update(PersistentCollection $collection)

Updates the given collection, synchronizing its state with the database by inserting, updating and deleting individual elements.

Parameters

PersistentCollection $collection

Return Value

void

int count(PersistentCollection $collection)

Counts the size of this persistent collection.

Parameters

PersistentCollection $collection

Return Value

int

mixed[] slice(PersistentCollection $collection, $offset, $length = null)

Slices elements.

Parameters

PersistentCollection $collection
$offset
$length

Return Value

mixed[]

bool contains(PersistentCollection $collection, $element)

Checks for existence of an element.

Parameters

PersistentCollection $collection
$element

Return Value

bool

bool containsKey(PersistentCollection $collection, $key)

Checks for existence of a key.

Parameters

PersistentCollection $collection
$key

Return Value

bool

mixed removeElement(PersistentCollection $collection, $element)

Removes an element.

Parameters

PersistentCollection $collection
$element

Return Value

mixed

mixed get(PersistentCollection $collection, $index)

Gets an element by key.

Parameters

PersistentCollection $collection
$index

Return Value

mixed

mixed[] loadCriteria(PersistentCollection $collection, Criteria $criteria)

Loads association entities matching the given Criteria object.

Parameters

PersistentCollection $collection
Criteria $criteria

Return Value

mixed[]