Support Joomla!

Joomla! 1.5 Documentation

Packages

Package: Joomla-Framework

License

Content on this site is copyright © 2005 - 2008 by the individual contributors and can be used in accordance with the Creative Commons License, Attribution- NonCommercial- ShareAlike 2.5. Some parts of this website may be subject to other licenses.

Class JCacheStorageMemcache

Description
Description | Variables (details) | Methods (details)

Memcache cache storage handler

Located in /joomla/cache/storage/memcache.php (line 27) 

Class JObject   (Subpackage Base)

Abstract class JCacheStorage
   
   Class JCacheStorageMemcache   (Subpackage Cache)
Variable Summary
Description | Variables (details) | Methods (details)
Variable int $_compress
Variable resource $_db
Variable boolean $_persistent
Method Summary
Description | Variables (details) | Methods (details)
Static method static boolean test ()
Constructor JCacheStorageMemcache __construct ([array $options = array()])
Method boolean clean (string $group, string $mode)
Method boolean gc ()
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)
int $_compress = null (line 39)

Use compression?

resource $_db (line 33)

Resource for the current memcached connection.

boolean $_persistent = false (line 45)

Use persistent connections

Inherited Variables

Inherited from JObject

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

Constructor

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

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.
gc (line 163)

Garbage collect expired cache data

  • return: True on success, false otherwise.
  • access: public
boolean gc ()
Redefinition of:
JCacheStorage::gc()
Garbage collect expired cache data
get (line 100)

Get cached data from memcache 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 133)

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

Store the data to memcache 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 175)

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 Tue, 29 Jan 2008 18:48:18 +0000 by phpDocumentor 1.3.1