Static Public Member Functions
static	clearActiveExtensions ($cacheItem)
	Clears active extensions list cache.
static	clearAll ($cacheList=false)
	Clears all cache items.
static	clearByID ($idList, $cacheList=false)
	Finds all cache item which has ID equal to one of the IDs in $idList.
static	clearByTag ($tagName, $cacheList=false)
	Finds all cache item which has the tag $tagName and clears them.
static	clearClassID ($cacheItem)
	Clears all content class identifier cache files from var/cache.
static	clearContentCache ($cacheItem)
	Clears all content caches by setting a new expiry value for the key content-view-cache.
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.
static	clearDesignBaseCache ($cacheItem)
	Clears the design base cache.
static	clearGlobalINICache ($cacheItem)
	Clear global ini cache.
static	clearImageAlias ($cacheItem)
	Sets the image alias timestamp to the current timestamp, this causes all image aliases to be recreated on viewing.
static	clearItem ($cacheItem, $purge=false, $reporter=false, $iterationSleep=false, $iterationMax=false, $expiry=false)
	Clears or purges the cache item $cacheItem.
static	clearSortKey ($cacheItem)
	Clears all datatype sortkey cache files from var/cache.
static	clearStateLimitations ($cacheItem)
	Clears all state limitation cache files.
static	clearTemplateBlockCache ($cacheItem)
	Removes all template block cache files and subtree entries.
static	clearTemplateOverrideCache ($cacheItem)
	Removes all template override cache files, subtree entries and clears in memory override cache.
static	clearTextToImageCache ($cacheItem)
	Clear texttoimage cache.
static	clearTSTranslationCache ($cacheItem)
	Clears the .ts translation cache.
static	clearUserInfoCache ($cacheItem)
	Clears all user-info caches by setting a new expiry value for the key user-info-cache.
static	fetchByID ($id, $cacheInfoList=false)
	Finds the first entry with the ID $id.
static	fetchByIDList ($idList, $cacheInfoList=false)
	Finds the entries matching and ID in the list $idList.
static	fetchByTag ($tagName, $cacheInfoList=false)
	Finds all cache entries using tag $tagName.
static	fetchIDList ($cacheInfoList=false)
	Goes through the cache info list $cacheInfoList and finds all the unique ids.
static	fetchList ()
	Return a list of all cache items in the system.
static	fetchTagList ($cacheInfoList=false)
	Goes through the cache info list $cacheInfoList and finds all the unique tags.
static	purgeImageAlias ($cacheItem)
	Purges the image aliases of all ezimage attribute.
static	purgeTextToImageCache ($cacheItem)
	Purge texttoimage cache.
Static Private Member Functions
static	purgeImageAliasForObject (array $cacheItem, eZContentObject $object, array $imageIdentifiers)
	The purge the image aliases in all versions of the content object.

Detailed Description

Definition at line 21 of file kernel/classes/ezcache.php.

Member Function Documentation

static eZCache::clearActiveExtensions ( $ cacheItem ) [static]

Clears active extensions list cache.

Definition at line 743 of file kernel/classes/ezcache.php.

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

Clears all cache items.

Parameters:

bool $cacheList

Returns:: bool True

Definition at line 360 of file kernel/classes/ezcache.php.

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	$idList	The cache ID list
bool \| array	$cacheList	The list of caches, default false

Definition at line 403 of file kernel/classes/ezcache.php.

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	$tagName	The tag name
bool \| array	$cacheList	The list of caches, default false

Definition at line 378 of file kernel/classes/ezcache.php.

Referenced by removeRelatedCache().

static eZCache::clearClassID ( $ cacheItem ) [static]

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

Definition at line 660 of file kernel/classes/ezcache.php.

Referenced by eZCacheClearClassID().

static eZCache::clearContentCache ( $ cacheItem ) [static]

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

Definition at line 695 of file kernel/classes/ezcache.php.

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.

Definition at line 625 of file kernel/classes/ezcache.php.

Referenced by eZCacheClearContentTreeMenu().

static eZCache::clearDesignBaseCache ( $ cacheItem ) [static]

Clears the design base cache.

Parameters:

$cacheItem array the cache item that describes the cache tag/id

Definition at line 759 of file kernel/classes/ezcache.php.

static eZCache::clearGlobalINICache ( $ cacheItem ) [static]

Clear global ini cache.

Definition at line 706 of file kernel/classes/ezcache.php.

Referenced by eZCacheClearGlobalINI().

static eZCache::clearImageAlias ( $ cacheItem ) [static]

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

Definition at line 516 of file kernel/classes/ezcache.php.

Referenced by eZCacheClearImageAlias(), and purgeImageAlias().

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:

$cacheItem	Cache item array taken from fetchList()
$purge	Controls whether clearing/invalidation or purge is used.
$reporter	Callback which is called when the system has purged files from the system, called with filename and purge count as parameters.
$iterationSleep	The amount of microseconds to sleep between each purge iteration, false means no sleep.
$iterationMax	The maximum number of items to purge in one iteration, false means use default limit.
$expiry	A 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.

Definition at line 438 of file kernel/classes/ezcache.php.

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

static eZCache::clearSortKey ( $ cacheItem ) [static]

Clears all datatype sortkey cache files from var/cache.

Definition at line 673 of file kernel/classes/ezcache.php.

Referenced by eZCacheClearSortKey().

static eZCache::clearStateLimitations ( $ cacheItem ) [static]

Clears all state limitation cache files.

Definition at line 732 of file kernel/classes/ezcache.php.

static eZCache::clearTemplateBlockCache ( $ cacheItem ) [static]

Removes all template block cache files and subtree entries.

Definition at line 636 of file kernel/classes/ezcache.php.

Referenced by eZCacheClearTemplateBlockCache().

static eZCache::clearTemplateOverrideCache ( $ cacheItem ) [static]

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

Since:: 4.2

Definition at line 650 of file kernel/classes/ezcache.php.

static eZCache::clearTextToImageCache ( $ cacheItem ) [static]

Clear texttoimage cache.

Definition at line 714 of file kernel/classes/ezcache.php.

static eZCache::clearTSTranslationCache ( $ cacheItem ) [static]

Clears the .ts translation cache.

Parameters:

array $cacheItem

Returns:: void

Definition at line 779 of file kernel/classes/ezcache.php.

static eZCache::clearUserInfoCache ( $ cacheItem ) [static]

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

Definition at line 684 of file kernel/classes/ezcache.php.

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

Finds the first entry with the ID $id.

Parameters:

string	$id	The entry id.
	array\|bool	The list of cache info per entry

Returns:: array The cache info structure.

Definition at line 320 of file kernel/classes/ezcache.php.

static eZCache::fetchByIDList	(	$	idList,
		$	cacheInfoList = `false`
	)		`[static]`

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

Parameters:

array	$idList	The list of cache ID
	array\|bool	The list of cache info per entry

Returns:: array An array with cache info structures.

Definition at line 340 of file kernel/classes/ezcache.php.

static eZCache::fetchByTag	(	$	tagName,
		$	cacheInfoList = `false`
	)		`[static]`

Finds all cache entries using tag $tagName.

Parameters:

string	$tagName	The tag name
bool \| array	$cacheInfoList	The list of cache info per entry

Returns:: array An array with cache items.

Definition at line 298 of file kernel/classes/ezcache.php.

static eZCache::fetchIDList ( $ cacheInfoList = false ) [static]

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

Parameters:

bool | array $cacheInfoList If 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.

Definition at line 278 of file kernel/classes/ezcache.php.

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()

Definition at line 28 of file kernel/classes/ezcache.php.

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

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

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

Parameters:

bool | array $cacheInfoList If 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.