| Methods |
public
|
getEntityCacheRegion(string $className): Region|null
Parameters
| $className |
The entity class.
|
|
#
|
public
|
getCollectionCacheRegion(string $className, string $association): Region|null
Parameters
| $className |
The entity class.
|
| $association |
The field name that represents the association.
|
|
#
|
public
|
containsEntity(string $className, mixed $identifier): bool
Determine whether the cache contains data for the given entity "instance".
Determine whether the cache contains data for the given entity "instance".
Parameters
| $className |
The entity class.
|
| $identifier |
The entity identifier
|
Returns
true if the underlying cache contains corresponding data; false otherwise.
|
#
|
public
|
evictEntity(string $className, mixed $identifier): void
Evicts the entity data for a particular entity "instance".
Evicts the entity data for a particular entity "instance".
Parameters
| $className |
The entity class.
|
| $identifier |
The entity identifier.
|
|
#
|
public
|
evictEntityRegion(string $className): void
Evicts all entity data from the given region.
Evicts all entity data from the given region.
Parameters
| $className |
The entity metadata.
|
|
#
|
public
|
evictEntityRegions(): void
Evict data from all entity regions.
Evict data from all entity regions.
|
#
|
public
|
containsCollection(string $className, string $association, mixed $ownerIdentifier): bool
Determine whether the cache contains data for the given collection.
Determine whether the cache contains data for the given collection.
Parameters
| $className |
The entity class.
|
| $association |
The field name that represents the association.
|
| $ownerIdentifier |
The identifier of the owning entity.
|
Returns
true if the underlying cache contains corresponding data; false otherwise.
|
#
|
public
|
evictCollection(string $className, string $association, mixed $ownerIdentifier): void
Evicts the cache data for the given identified collection instance.
Evicts the cache data for the given identified collection instance.
Parameters
| $className |
The entity class.
|
| $association |
The field name that represents the association.
|
| $ownerIdentifier |
The identifier of the owning entity.
|
|
#
|
public
|
evictCollectionRegion(string $className, string $association): void
Evicts all entity data from the given region.
Evicts all entity data from the given region.
Parameters
| $className |
The entity class.
|
| $association |
The field name that represents the association.
|
|
#
|
public
|
evictCollectionRegions(): void
Evict data from all collection regions.
Evict data from all collection regions.
|
#
|
public
|
containsQuery(string $regionName): bool
Determine whether the cache contains data for the given query.
Determine whether the cache contains data for the given query.
Parameters
| $regionName |
The cache name given to the query.
|
Returns
true if the underlying cache contains corresponding data; false otherwise.
|
#
|
public
|
evictQueryRegion(string|null $regionName = null): void
Evicts all cached query results under the given name, or default query cache if the region name is NULL.
Evicts all cached query results under the given name, or default query cache if the region name is NULL.
Parameters
| $regionName |
The cache name associated to the queries being cached.
|
|
#
|
public
|
evictQueryRegions(): void
Evict data from all query regions.
Evict data from all query regions.
|
#
|
public
|
getQueryCache(string|null $regionName = null): QueryCache
Get query cache by region name or create a new one if none exist.
Get query cache by region name or create a new one if none exist.
Parameters
| $regionName |
Query cache region name, or default query cache if the region name is NULL.
|
Returns
The Query Cache associated with the region name.
|
#
|
| Constants |
public
|
DEFAULT_QUERY_REGION_NAME = 'query_cache_region'
|
#
|
public
|
DEFAULT_TIMESTAMP_REGION_NAME = 'timestamp_cache_region'
|
#
|
public
|
MODE_GET = 1
May read items from the cache, but will not add items.
May read items from the cache, but will not add items.
|
#
|
public
|
MODE_PUT = 2
Will never read items from the cache,
but will add items to the cache as it reads them from the database.
Will never read items from the cache,
but will add items to the cache as it reads them from the database.
|
#
|
public
|
MODE_NORMAL = 3
May read items from the cache, and add items to the cache.
May read items from the cache, and add items to the cache.
|
#
|
public
|
MODE_REFRESH = 4
The query will never read items from the cache,
but will refresh items to the cache as it reads them from the database.
The query will never read items from the cache,
but will refresh items to the cache as it reads them from the database.
|
#
|