JCacheStorage
Description
Abstract cache storage handler
Located in /joomla/cache/storage.php (line 26)
JObject (Subpackage Base)
JCacheStorage (Subpackage Cache)
Direct descendents
| Class | Description |
|---|---|
|
JCacheStorageEaccelerator
|
eAccelerator cache storage handler |
|
JCacheStorageApc
|
APC cache storage handler |
|
JCacheStorageMemcache
|
Memcache cache storage handler |
|
JCacheStorageXCache
|
XCache cache storage handler |
|
JCacheStorageFile
|
File cache storage handler |
Method Summary
static 
Variables
Methods
Constructor
JCacheStorage
__construct
([array $options = array()])
- array $options: optional parameters
Redefinition of:
- JObject::__construct()
- Class constructor, overridden in descendant classes.
Redefined in descendants as:
- JCacheStorageEaccelerator::__construct() : Constructor
- JCacheStorageApc::__construct() : Constructor
- JCacheStorageMemcache::__construct() : Constructor
- JCacheStorageXCache::__construct() : Constructor
- JCacheStorageFile::__construct() : Constructor
Clean cache for a group given a mode.
group mode : cleans all cache in the group notgroup mode : cleans all cache not in the group
boolean
clean
(string $group, string $mode)
- string $group: The cache data group
- string $mode: The mode for cleaning cache [group|notgroup]
Redefined in descendants as:
- JCacheStorageEaccelerator::clean() : Clean cache for a group given a mode.
- JCacheStorageApc::clean() : Clean cache for a group given a mode.
- JCacheStorageMemcache::clean() : Clean cache for a group given a mode.
- JCacheStorageXCache::clean() : Clean cache for a group given a mode.
- JCacheStorageFile::clean() : Clean cache for a group given a mode.
Garbage collect expired cache data
boolean
gc
()
Redefined in descendants as:
- JCacheStorageEaccelerator::gc() : Garbage collect expired cache data
- JCacheStorageMemcache::gc() : Garbage collect expired cache data
- JCacheStorageFile::gc() : Garbage collect expired cache data
Get cached data by id and group
mixed
get
(string $id, string $group, boolean $checkTime)
- string $id: The cache data id
- string $group: The cache data group
- boolean $checkTime: True to verify cache time expiration threshold
Redefinition of:
- JObject::get()
- Returns a property of the object or the default value if the property is not set.
Redefined in descendants as:
- JCacheStorageEaccelerator::get() : Get cached data by id and group
- JCacheStorageApc::get() : Get cached data from APC by id and group
- JCacheStorageMemcache::get() : Get cached data from memcache by id and group
- JCacheStorageXCache::get() : Get cached data by id and group
- JCacheStorageFile::get() : Get cached data from a file by id and group
Returns a reference to a cache storage hanlder object, only creating it if it doesn't already exist.
object A
&getInstance
([string $handler = 'file'], [ $options = array()])
- string $handler: The cache storage handler to instantiate
- $options
Remove a cached data entry by id and group
boolean
remove
(string $id, string $group)
- string $id: The cache data id
- string $group: The cache data group
Redefined in descendants as:
- JCacheStorageEaccelerator::remove() : Remove a cached data entry by id and group
- JCacheStorageApc::remove() : Remove a cached data entry by id and group
- JCacheStorageMemcache::remove() : Remove a cached data entry by id and group
- JCacheStorageXCache::remove() : Remove a cached data entry by id and group
- JCacheStorageFile::remove() : Remove a cached data file by id and group
Store the data to cache by id and group
boolean
store
(string $id, string $group, string $data)
- string $id: The cache data id
- string $group: The cache data group
- string $data: The data to store in cache
Redefined in descendants as:
- JCacheStorageEaccelerator::store() : Store the data to by id and group
- JCacheStorageApc::store() : Store the data to APC by id and group
- JCacheStorageMemcache::store() : Store the data to memcache by id and group
- JCacheStorageXCache::store() : Store the data by id and group
- JCacheStorageFile::store() : Store the data to a file by id and group
Test to see if the storage handler is available.
boolean
test
()
Redefined in descendants as:
- JCacheStorageEaccelerator::test() : Test to see if the cache storage is available.
- JCacheStorageApc::test() : Test to see if the cache storage is available.
- JCacheStorageMemcache::test() : Test to see if the cache storage is available.
- JCacheStorageXCache::test() : Test to see if the cache storage is available.
- JCacheStorageFile::test() : Test to see if the cache storage is available.
Inherited Methods
Inherited From JObject
JObject::JObject()
JObject::get()