Class

ezpRestCacheStorageCluster

abstract class ezpRestCacheStorageCluster extends ezpRestCacheStorageFile implements ezcCacheStackableStorage, ezcCacheStackMetaDataStorage

File containing ezpRestCacheStorageCluster class

Properties

bool $isCacheEnabled Flag indicating if cache is enabled or not.

Methods

__construct(string $location, array(string=>string) $options = array())

Creates a new cache storage for a given location through eZ Publish cluster mechanism Options can contain the 'ttl' ( Time-To-Life ).

store($id, $data, $attributes = array())

(non-PHPdoc)

mixed restore(string $id, array(string=>string) $attributes = array(), bool $search = false)

Restore data from the cache.

string clusterRetrieve(string $file, int $mtime, array $args)

Retrieve callback for cluster processCache() method

delete(string $id = null, array(string=>string) $attributes = array(), bool $search = false)

Delete data from the cache.

int countDataItems(string $id = null, array(string=>string) $attributes = array())

Return the number of items in the cache matching a certain criteria.

int getRemainingLifetime(string $id, array(string=>string) $attributes = array())

Returns the time ( in seconds ) that remains for a cache object, before it gets outdated.

abortCacheGeneration()

Aborts current cache generation Useful in case of a problem during generation of content (ie.

Details

at line 37
public __construct(string $location, array(string=>string) $options = array())

Creates a new cache storage for a given location through eZ Publish cluster mechanism Options can contain the 'ttl' ( Time-To-Life ).

This is per default set to 1 day.

Parameters

string $location Path to the cache location inside the cluster
array(string=>string) $options Options for the cache.

at line 60
public store($id, $data, $attributes = array())

(non-PHPdoc)

Parameters

$id
$data
$attributes

See also

lib/ezc/Cache/src/storage/ezcCacheStorageFile::store()

at line 105
public mixed restore(string $id, array(string=>string) $attributes = array(), bool $search = false)

Restore data from the cache.

Restores the data associated with the given cache and returns it. Please see {@link ezcCacheStorage::store()} for more detailed information of cachable datatypes.

During access to cached data the caches are automatically expired. This means, that the ezcCacheStorage object checks before returning the data if it's still actual. If the cache has expired, data will be deleted and false is returned.

You should always provide the attributes you assigned, although the cache storages must be able to find a cache ID even without them. BEWARE: Finding cache data only by ID can be much slower than finding it by ID and attributes.

Parameters

string $id The item ID.
array(string=>string) $attributes Attributes that describe the cached data.
bool $search Whether to search for items if not found directly. Default is false.

Return Value

mixed The cached data on success, otherwise false.

at line 141
public string clusterRetrieve(string $file, int $mtime, array $args)

Retrieve callback for cluster processCache() method

Parameters

string $file Filepath
int $mtime File modification time
array $args Extra args passed to the cluster processCache() method

Return Value

string

at line 166
public delete(string $id = null, array(string=>string) $attributes = array(), bool $search = false)

Delete data from the cache.

Purges the cached data for a given ID and or attributes. Using an ID purges only the cache data for just this ID.

Additional attributes provided will matched additionally. This can give you an immense speed improvement against just searching for ID ( see {@link ezcCacheStorage::restore()} ).

If you only provide attributes for deletion of cache data, all cache data matching these attributes will be purged.

Parameters

string $id The item ID.
array(string=>string) $attributes Attributes that describe the cached data.
bool $search Whether to search for items if not found directly. Default is false.

at line 191
public int countDataItems(string $id = null, array(string=>string) $attributes = array())

Return the number of items in the cache matching a certain criteria.

This method determines if cache data described by the given ID and/or attributes exists. It returns the number of cache data items found.

Parameters

string $id The item ID.
array(string=>string) $attributes Attributes that describe the item

Return Value

int The number of cache data items found matching the criteria

at line 214
public int getRemainingLifetime(string $id, array(string=>string) $attributes = array())

Returns the time ( in seconds ) that remains for a cache object, before it gets outdated.

In case the cache object is already outdated or does not exist, this method returns 0.

Parameters

string $id The item ID.
array(string=>string) $attributes Attributes that describe the

Return Value

int The remaining lifetime ( 0 if nonexists or outdated ).

at line 241
public abortCacheGeneration()

Aborts current cache generation Useful in case of a problem during generation of content (ie.

exception)