eZPublish  3.8
eZCache Class Reference

Main class for dealing with caches in eZ publish. More...

Public Member Functions

 eZCache ()
 

Static Public Member Functions

 clearAll ($cacheList=false)
 
 clearByID ($idList, $cacheList=false)
 
 clearByTag ($tagName, $cacheList=false)
 
 clearGlobalINICache ()
 
 fetchByID ($id, $cacheInfoList=false)
 
 fetchByIDList ($idList, $cacheInfoList=false)
 
 fetchByTag ($tagName, $cacheInfoList=false)
 
 fetchIDList ($cacheInfoList=false)
 
 fetchList ()
 
 fetchTagList ($cacheInfoList=false)
 

Private Member Functions

 clearClassID ($cacheItem)
 
 clearImageAlias ($cacheItem)
 
 clearSortKey ($cacheItem)
 
 clearTemplateBlockCache ($cacheItem)
 

Static Private Member Functions

 clearItem ($cacheItem)
 

Detailed Description

Main class for dealing with caches in eZ publish.

Has methods for clearing the various caches according to tag, id or all caches. It also has information for all the caches.

Member Function Documentation

eZCache::clearAll (   $cacheList = false)
static

Clears all cache items.

eZCache::clearByID (   $idList,
  $cacheList = false 
)
static

Finds all cache item which has ID equal to one of the IDs in $idList. You can also submit a single id to $idList.

eZCache::clearByTag (   $tagName,
  $cacheList = false 
)
static

Finds all cache item which has the tag $tagName and clears them.

Referenced by removeRelatedCache().

eZCache::clearClassID (   $cacheItem)
private

Clears all content class identifier cache files from var/cache.

Referenced by eZCacheClearClassID().

eZCache::clearGlobalINICache ( )
static

Clear global ini cache

Referenced by eZCacheClearGlobalINI().

eZCache::clearImageAlias (   $cacheItem)
private

Sets the image alias timestamp to the current timestamp, this causes all image aliases to be recreated on viewing.

Referenced by eZCacheClearImageAlias().

eZCache::clearItem (   $cacheItem)
staticprivate

Clears the cache item $cacheItem.

Referenced by clearAll(), clearByID(), and clearByTag().

eZCache::clearSortKey (   $cacheItem)
private

Clears all datatype sortkey cache files from var/cache.

Referenced by eZCacheClearSortKey().

eZCache::clearTemplateBlockCache (   $cacheItem)
private

Removes all template block cache files and subtree entries.

Referenced by eZCacheClearTemplateBlockCache().

eZCache::eZCache ( )

Constructor

eZCache::fetchByID (   $id,
  $cacheInfoList = false 
)
static

Finds the first entry with the ID $id.

Returns
The cache info structure.
eZCache::fetchByIDList (   $idList,
  $cacheInfoList = false 
)
static

Finds the entries matching and ID in the list $idList.

Returns
An array with cache info structures.
eZCache::fetchByTag (   $tagName,
  $cacheInfoList = false 
)
static

Finds all cache entries using tag $tagName.

Returns
An array with cache items.
eZCache::fetchIDList (   $cacheInfoList = false)
static

Goes through the cache info list $cacheInfoList and finds all the unique ids.

Returns
An array with id strings.
Parameters
$cacheInfoListIf false the list will automatically be fetched, if multiple eZCache functions are called it is a good idea to call fetchList() yourself and pass it as a parameter.
eZCache::fetchList ( )
static
Returns
a list of all cache items in the system.

Referenced by clearAll(), clearByID(), clearByTag(), fetchByID(), fetchByIDList(), fetchByTag(), fetchIDList(), and fetchTagList().

eZCache::fetchTagList (   $cacheInfoList = false)
static

Goes through the cache info list $cacheInfoList and finds all the unique tags.

Returns
An array with tag strings.
Parameters
$cacheInfoListIf false the list will automatically be fetched, if multiple eZCache functions are called it is a good idea to call fetchList() yourself and pass it as a parameter.

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