Joomla! Documentation™

The "API17" namespace is an archived namespace. This page contains information for a Joomla! version which is no longer supported. It exists only as a historical reference, it will not be improved and its content may be incomplete and/or contain broken links.

JCacheStorage

Description

JCacheStorage is an abstract class. The class needs to be extended by concrete storage handlers. The Joomla Framework currently provides the handlers JCacheStorageApc, JCacheStorageEaccelarator, JCacheStorageFile, JCacheStorageMemcache, JCacheStorageXCache, JCacheStorageXcache

Methods

Visibility	Method name	Description
public	__construct	Constructor.
public	clean	Clean cache for a group given a mode.
public	gc	Garbage collect expired cache data.
public	get	Get cached data by id and group.
public	getAll	Get all cached data.
public	lock	Lock cached item.
public	remove	Remove a cached data entry by id and group.
public	store	Store the data to cache by id and group.
public	unlock	Unlock cached item.
public static	addIncludePath	Add a directory where should search for handlers.
public static	getInstance	Returns a cache storage handler object, only creating it if it doesn't already exist.
public static	test	Test to see if the storage handler is available.
protected	_getCacheId	Get a cache_id string from an id/group pair.

• Defined in libraries/joomla/cache/storage.php
• Extended by
  • JCacheStorageApc
  • JCacheStorageCachelite
  • JCacheStorageEaccelerator
  • JCacheStorageFile
  • JCacheStorageMemcache
  • JCacheStorageWincache
  • JCacheStorageXcache

Importing

jimport( 'joomla.cache.storage' );

See also

• JCacheStorage source code on BitBucket
• Subpackage Cache
• Other versions of JCacheStorage