eZPublishCommunityProject(LegacyStack)  2013.5
eZCache Class Reference

Static Public Member Functions

static clearActiveExtensions ($cacheItem)
 Clears active extensions list cache. More...
 
static clearAll ($cacheList=false)
 Clears all cache items. More...
 
static clearByID ($idList, $cacheList=false)
 Finds all cache item which has ID equal to one of the IDs in $idList. More...
 
static clearByTag ($tagName, $cacheList=false)
 Finds all cache item which has the tag $tagName and clears them. More...
 
static clearClassID ($cacheItem)
 Clears all content class identifier cache files from var/cache. More...
 
static clearContentCache ($cacheItem)
 Clears all content caches by setting a new expiry value for the key content-view-cache. More...
 
static clearContentTreeMenu ($cacheItem)
 Sets the content tree menu timestamp to the current date and time, this is used as a GET parameter in the content/treemenu requests and thus forces a browser to load the content tree menu from a server rather than to use a cached copy. More...
 
static clearDesignBaseCache ($cacheItem)
 Clears the design base cache. More...
 
static clearGlobalINICache ($cacheItem)
 Clear global ini cache. More...
 
static clearImageAlias ($cacheItem)
 Sets the image alias timestamp to the current timestamp, this causes all image aliases to be recreated on viewing. More...
 
static clearItem ($cacheItem, $purge=false, $reporter=false, $iterationSleep=false, $iterationMax=false, $expiry=false)
 Clears or purges the cache item $cacheItem. More...
 
static clearSortKey ($cacheItem)
 Clears all datatype sortkey cache files from var/cache. More...
 
static clearStateLimitations ($cacheItem)
 Clears all state limitation cache files. More...
 
static clearTemplateBlockCache ($cacheItem)
 Removes all template block cache files and subtree entries. More...
 
static clearTemplateCompileCache ()
 Clear Template Compile cache. More...
 
static clearTemplateOverrideCache ($cacheItem)
 Removes all template override cache files, subtree entries and clears in memory override cache. More...
 
static clearTextToImageCache ($cacheItem)
 Clear texttoimage cache. More...
 
static clearTSTranslationCache ($cacheItem)
 Clears the .ts translation cache. More...
 
static clearUserInfoCache ($cacheItem)
 Clears all user-info caches by setting a new expiry value for the key user-info-cache. More...
 
static fetchByID ($id, $cacheInfoList=false)
 Finds the first entry with the ID $id. More...
 
static fetchByIDList ($idList, $cacheInfoList=false)
 Finds the entries matching and ID in the list $idList. More...
 
static fetchByTag ($tagName, $cacheInfoList=false)
 Finds all cache entries using tag $tagName. More...
 
static fetchIDList ($cacheInfoList=false)
 Goes through the cache info list $cacheInfoList and finds all the unique ids. More...
 
static fetchList ()
 Return a list of all cache items in the system. More...
 
static fetchTagList ($cacheInfoList=false)
 Goes through the cache info list $cacheInfoList and finds all the unique tags. More...
 
static purgeImageAlias ($cacheItem)
 Purges the image aliases of all ezimage attribute. More...
 
static purgeTextToImageCache ($cacheItem)
 Purge texttoimage cache. More...
 

Static Private Member Functions

static purgeImageAliasForObject (array $cacheItem, eZContentObject $object, array $imageIdentifiers)
 The purge the image aliases in all versions of the content object. More...
 

Member Function Documentation

static eZCache::clearActiveExtensions (   $cacheItem)
static

Clears active extensions list cache.

static eZCache::clearAll (   $cacheList = false)
static

Clears all cache items.

Parameters
bool$cacheList
Returns
bool True
static 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.

Parameters
array$idListThe cache ID list
bool | array$cacheListThe list of caches, default false

Referenced by eZStepFinal\init(), and eZStepCreateSites\initializePackage().

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

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

Parameters
string$tagNameThe tag name
bool | array$cacheListThe list of caches, default false

Referenced by removeRelatedCache().

static eZCache::clearClassID (   $cacheItem)
static

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

static eZCache::clearContentCache (   $cacheItem)
static

Clears all content caches by setting a new expiry value for the key content-view-cache.

static eZCache::clearContentTreeMenu (   $cacheItem)
static

Sets the content tree menu timestamp to the current date and time, this is used as a GET parameter in the content/treemenu requests and thus forces a browser to load the content tree menu from a server rather than to use a cached copy.

static eZCache::clearDesignBaseCache (   $cacheItem)
static

Clears the design base cache.

Parameters
$cacheItemarray the cache item that describes the cache tag/id
static eZCache::clearGlobalINICache (   $cacheItem)
static

Clear global ini cache.

static eZCache::clearImageAlias (   $cacheItem)
static

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

static eZCache::clearItem (   $cacheItem,
  $purge = false,
  $reporter = false,
  $iterationSleep = false,
  $iterationMax = false,
  $expiry = false 
)
static

Clears or purges the cache item $cacheItem.

If $purge is true then the system will ensure the entries are removed from local storage or database backend, otherwise it will use possible optimizations which might only invalidate the cache entry directly or use global expiry values.

Parameters
$cacheItemCache item array taken from fetchList()
$purgeControls whether clearing/invalidation or purge is used.
$reporterCallback which is called when the system has purged files from the system, called with filename and purge count as parameters.
$iterationSleepThe amount of microseconds to sleep between each purge iteration, false means no sleep.
$iterationMaxThe maximum number of items to purge in one iteration, false means use default limit.
$expiryA timestamp which is matched against all cache items, if the modification of the cache is older than the expiry the cache is purged, false means no expiry checking.

Referenced by clearAll(), clearByID(), clearByTag(), and eZCacheHelper\internalClear().

static eZCache::clearSortKey (   $cacheItem)
static

Clears all datatype sortkey cache files from var/cache.

static eZCache::clearStateLimitations (   $cacheItem)
static

Clears all state limitation cache files.

static eZCache::clearTemplateBlockCache (   $cacheItem)
static

Removes all template block cache files and subtree entries.

static eZCache::clearTemplateCompileCache ( )
static

Clear Template Compile cache.

static eZCache::clearTemplateOverrideCache (   $cacheItem)
static

Removes all template override cache files, subtree entries and clears in memory override cache.

Since
4.2
static eZCache::clearTextToImageCache (   $cacheItem)
static

Clear texttoimage cache.

static eZCache::clearTSTranslationCache (   $cacheItem)
static

Clears the .ts translation cache.

Parameters
array$cacheItem
Returns
void
static eZCache::clearUserInfoCache (   $cacheItem)
static

Clears all user-info caches by setting a new expiry value for the key user-info-cache.

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

Finds the first entry with the ID $id.

Parameters
string$idThe entry id.
array|boolThe list of cache info per entry
Returns
array The cache info structure.
static eZCache::fetchByIDList (   $idList,
  $cacheInfoList = false 
)
static

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

Parameters
array$idListThe list of cache ID
array|boolThe list of cache info per entry
Returns
array An array with cache info structures.
static eZCache::fetchByTag (   $tagName,
  $cacheInfoList = false 
)
static

Finds all cache entries using tag $tagName.

Parameters
string$tagNameThe tag name
bool | array$cacheInfoListThe list of cache info per entry
Returns
array An array with cache items.
static eZCache::fetchIDList (   $cacheInfoList = false)
static

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

Parameters
bool | array$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.
Returns
array An array with id strings.
static eZCache::fetchList ( )
static

Return a list of all cache items in the system.

Returns
array The list of cache items

caches the list of active extensions (per siteaccess and global)

See Also
eZExtension::activeExtensions()

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

static eZCache::fetchTagList (   $cacheInfoList = false)
static

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

Parameters
bool | array$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.
Returns
array An array with tag strings.
static eZCache::purgeImageAlias (   $cacheItem)
static

Purges the image aliases of all ezimage attribute.

The original image is kept.

Parameters
array$cacheItempublic
static eZCache::purgeImageAliasForObject ( array  $cacheItem,
eZContentObject  $object,
array  $imageIdentifiers 
)
staticprivate

The purge the image aliases in all versions of the content object.

Parameters
array$cacheItem
eZContentObject$object
array$imageIdentifiersarray of ezimage attribute identifiers
static eZCache::purgeTextToImageCache (   $cacheItem)
static

Purge texttoimage cache.


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