Support Joomla!

Packages

Package: Joomla-Framework

License

Content on this site is copyright © 2005 - 2008 Open Source Matters Inc and can be used in accordance with the Joomla! Electronic Documentation License. Some parts of this website may be subject to other licenses.

Class JCacheStorageXCache

Description
Description | Variables | Methods (details)

XCache cache storage handler

  • since: 1.5

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

Class JObject   (Subpackage Base)

Abstract class JCacheStorage
   
   Class JCacheStorageXCache   (Subpackage Cache)
Method Summary
Description | Variables | Methods (details)
Static method static boolean test ()
Constructor JCacheStorageXCache __construct ([array $options = array()])
Method boolean clean (string $group, string $mode)
Method mixed get (string $id, string $group, boolean $checkTime)
Method boolean remove (string $id, string $group)
Method boolean store (string $id, string $group, string $data)
Variables
Description | Variables (details) | Methods (details)

Inherited Variables

Inherited from JObject

Variable JObject::$_errors
Methods
Description | Variables Methods (details)
Constructor __construct (line 33)

Constructor

  • access: protected
JCacheStorageXCache __construct ([array $options = array()])
  • array $options: optional parameters
Redefinition of:
JCacheStorage::__construct()
Constructor
clean (line 111)

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

  • return: True on success, false otherwise
  • since: 1.5
  • access: public
boolean clean (string $group, string $mode)
  • string $group: The cache data group
  • string $mode: The mode for cleaning cache [group|notgroup]
Redefinition of:
JCacheStorage::clean()
Clean cache for a group given a mode.
get (line 51)

Get cached data by id and group

  • return: Boolean false on failure or a cached data string
  • since: 1.5
  • access: public
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:
JCacheStorage::get()
Get cached data by id and group
remove (line 88)

Remove a cached data entry by id and group

  • return: True on success, false otherwise
  • since: 1.5
  • 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 73)

Store the data by id and group

  • return: True on success, false otherwise
  • since: 1.5
  • 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
test (line 123)

Test to see if the cache storage is available.

  • return: True on success, false otherwise.
  • access: public
boolean test ()
Redefinition of:
JCacheStorage::test()
Test to see if the storage handler is available.

Inherited Methods

Inherited From JCacheStorage

JCacheStorage::__construct()
JCacheStorage::clean()
JCacheStorage::gc()
JCacheStorage::get()
JCacheStorage::getInstance()
JCacheStorage::remove()
JCacheStorage::store()
JCacheStorage::test()

Inherited From JObject

JObject::JObject()
JObject::__construct()
JObject::get()
JObject::getError()
JObject::getErrors()
JObject::getProperties()
JObject::getPublicProperties()
JObject::set()
JObject::setError()
JObject::setProperties()
JObject::toString()
Documentation generated on Mon, 22 Sep 2008 12:18:01 +0100 by phpDocumentor 1.3.1