interface CachedCollectionPersister implements CachedPersister, CollectionPersister (View source)

Interface for second level cache collection persisters.

Methods

afterTransactionComplete()

Perform whatever processing is encapsulated here after completion of the transaction.

afterTransactionRolledBack()

Perform whatever processing is encapsulated here after completion of the rolled-back.

getCacheRegion()

Gets the The region access.

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.

PersistentCollection|mixed[]|null
loadCollectionCache(PersistentCollection $collection, CollectionCacheKey $key)

Loads a collection from cache

void
storeCollectionCache(CollectionCacheKey $key, $elements)

Stores a collection into cache

Details

afterTransactionComplete()

Perform whatever processing is encapsulated here after completion of the transaction.

afterTransactionRolledBack()

Perform whatever processing is encapsulated here after completion of the rolled-back.

Region getCacheRegion()

Gets the The region access.

Return Value

Region

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[]

ClassMetadata getSourceEntityMetadata()

Return Value

ClassMetadata

ClassMetadata getTargetEntityMetadata()

Return Value

ClassMetadata

PersistentCollection|mixed[]|null loadCollectionCache(PersistentCollection $collection, CollectionCacheKey $key)

Loads a collection from cache

Parameters

PersistentCollection $collection
CollectionCacheKey $key

Return Value

PersistentCollection|mixed[]|null

void storeCollectionCache(CollectionCacheKey $key, $elements)

Stores a collection into cache

Parameters

CollectionCacheKey $key
$elements

Return Value

void