eZPublishCommunityProject(LegacyStack)  2013.9
ezpRestCacheStorageCluster Class Reference
+ Inheritance diagram for ezpRestCacheStorageCluster:
+ Collaboration diagram for ezpRestCacheStorageCluster:

Public Member Functions

 __construct ($location, $options=array())
 Creates a new cache storage for a given location through eZ Publish cluster mechanism Options can contain the 'ttl' ( Time-To-Life ). More...
 
 abortCacheGeneration ()
 Aborts current cache generation Useful in case of a problem during generation of content (ie. More...
 
 clusterRetrieve ($file, $mtime, $args)
 Retrieve callback for cluster processCache() method. More...
 
 countDataItems ($id=null, $attributes=array())
 Return the number of items in the cache matching a certain criteria. More...
 
 delete ($id=null, $attributes=array(), $search=false)
 Delete data from the cache. More...
 
 getRemainingLifetime ($id, $attributes=array())
 Returns the time ( in seconds ) that remains for a cache object, before it gets outdated. More...
 
 restore ($id, $attributes=array(), $search=false)
 Restore data from the cache. More...
 
 store ($id, $data, $attributes=array())
 (non-PHPdoc) More...
 

Public Attributes

 $isCacheEnabled = true
 

Protected Attributes

 $clusterCacheFile
 

Constructor & Destructor Documentation

ezpRestCacheStorageCluster::__construct (   $location,
  $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$locationPath to the cache location inside the cluster
array(string=>string)$options Options for the cache.

Member Function Documentation

ezpRestCacheStorageCluster::abortCacheGeneration ( )

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

exception)

Exceptions
ezpCacheClusterException
ezpRestCacheStorageCluster::clusterRetrieve (   $file,
  $mtime,
  $args 
)

Retrieve callback for cluster processCache() method.

Parameters
string$fileFilepath
int$mtimeFile modification time
array$argsExtra args passed to the cluster processCache() method
Returns
string
ezpRestCacheStorageCluster::countDataItems (   $id = null,
  $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$idThe item ID.
array(string=>string)$attributes Attributes that describe the item
Returns
int The number of cache data items found matching the criteria
ezpRestCacheStorageCluster::delete (   $id = null,
  $attributes = array(),
  $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 ezcCacheStorage::restore() ).

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

Parameters
string$idThe item ID.
array(string=>string)$attributes Attributes that describe the cached data.
bool$searchWhether to search for items if not found directly. Default is false.
ezpRestCacheStorageCluster::getRemainingLifetime (   $id,
  $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$idThe item ID.
array(string=>string)$attributes Attributes that describe the public
Returns
int The remaining lifetime ( 0 if nonexists or outdated ).
ezpRestCacheStorageCluster::restore (   $id,
  $attributes = array(),
  $search = false 
)

Restore data from the cache.

Restores the data associated with the given cache and returns it. Please see 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$idThe item ID.
array(string=>string)$attributes Attributes that describe the cached data.
bool$searchWhether to search for items if not found directly. Default is false.
Returns
mixed The cached data on success, otherwise false.
ezpRestCacheStorageCluster::store (   $id,
  $data,
  $attributes = array() 
)

(non-PHPdoc)

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

Member Data Documentation

ezpRestCacheStorageCluster::$clusterCacheFile
protected
ezpRestCacheStorageCluster::$isCacheEnabled = true

The documentation for this class was generated from the following file: