Class JCacheStorageXcache

Description

XCache cache storage handler

Located in /libraries/joomla/cache/storage/xcache.php (line 20)

JCacheStorage
   |
   --JCacheStorageXcache
Method Summary
static boolean test ()
boolean clean (string $group, [string $mode = null])
boolean gc ()
mixed get (string $id, string $group, [boolean $checkTime = true])
array getAll ()
boolean remove (string $id, string $group)
boolean store (string $id, string $group, string $data)
Variables
Methods
static method test (line 205)

Test to see if the cache storage is available.

  • return: True on success, false otherwise.
  • since: 11.1
  • access: public
static boolean test ()

Redefinition of:
JCacheStorage::test()
Test to see if the storage handler is available.
clean (line 146)

Clean cache for a group given a mode.

This requires the php.ini setting xcache.admin.enable_auth = Off.

  • return: True on success, false otherwise
  • since: 11.1
  • access: public
boolean clean (string $group, [string $mode = null])
  • string $group: The cache data group
  • string $mode: The mode for cleaning cache [group|notgroup] group mode : cleans all cache in the group notgroup mode : cleans all cache not in the group

Redefinition of:
JCacheStorage::clean()
Clean cache for a group given a mode.
gc (line 173)

Garbage collect expired cache data

This is a dummy, since xcache has built in garbage collector, turn it on in php.ini by changing default xcache.gc_interval setting from

  1. to 3600 (=1 hour)

  • return: True on success, false otherwise.
  • since: 11.1
  • access: public
boolean gc ()

Redefinition of:
JCacheStorage::gc()
Garbage collect expired cache data
get (line 33)

Get cached data by id and group

  • return: Boolean false on failure or a cached data string
  • since: 11.1
  • access: public
mixed get (string $id, string $group, [boolean $checkTime = true])
  • string $id: The cache data id
  • string $group: The cache data group
  • boolean $checkTime: True to verify cache time expiration threshold

Redefinition of:
JCacheStorage::get()
Get cached data by id and group
getAll (line 55)

Get all cached data

This requires the php.ini setting xcache.admin.enable_auth = Off.

  • return: data
  • since: 11.1
  • access: public
array getAll ()

Redefinition of:
JCacheStorage::getAll()
Get all cached data
remove (line 120)

Remove a cached data entry by id and group

  • return: True on success, false otherwise
  • since: 11.1
  • access: public
boolean remove (string $id, string $group)
  • string $id: The cache data id
  • string $group: The cache data group

Redefinition of:
JCacheStorage::remove()
Remove a cached data entry by id and group
store (line 103)

Store the data by id and group

  • return: True on success, false otherwise
  • since: 11.1
  • access: public
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

Redefinition of:
JCacheStorage::store()
Store the data to cache by id and group

Inherited Methods

Inherited From JCacheStorage

JCacheStorage::__construct()
JCacheStorage::addIncludePath()
JCacheStorage::clean()
JCacheStorage::gc()
JCacheStorage::get()
JCacheStorage::getAll()
JCacheStorage::getInstance()
JCacheStorage::lock()
JCacheStorage::remove()
JCacheStorage::store()
JCacheStorage::test()
JCacheStorage::unlock()
JCacheStorage::_getCacheId()

Documentation generated on Mon, 25 Jun 2012 14:01:39 -0500 by phpDocumentor 1.4.4