Class JCacheStorageMemcache

Description

Memcache cache storage handler

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

JCacheStorage
   |
   --JCacheStorageMemcache
Variable Summary
static Memcache $_db
boolean $_persistent
Method Summary
static boolean test ()
JCacheStorageMemcache __construct ([array $options = array()])
boolean clean (string $group, [string $mode = null])
mixed get (string $id, string $group, [boolean $checkTime = true])
array getAll ()
object memcache getConnection ()
boolean lock (string $id, string $group, integer $locktime)
boolean lockindex ()
boolean remove (string $id, string $group)
boolean store (string $id, string $group, string $data)
boolean unlock (string $id, [string $group = null])
boolean unlockindex ()
Variables
static Memcache $_db = null (line 26)
  • since: 11.1
  • access: protected
$_compress = 0 (line 38)
  • since: 11.1
  • access: protected
boolean $_persistent = false (line 32)
  • since: 11.1
  • access: protected

Inherited Variables

Inherited from JCacheStorage

JCacheStorage::$rawname
JCacheStorage::$_application
JCacheStorage::$_hash
JCacheStorage::$_language
JCacheStorage::$_lifetime
JCacheStorage::$_locking
JCacheStorage::$_now
Methods
static method test (line 294)

Test to see if the cache storage is available.

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

Redefinition of:
JCacheStorage::test()
Test to see if the storage handler is available.
Constructor __construct (line 47)

Constructor

  • since: 11.1
  • access: public
JCacheStorageMemcache __construct ([array $options = array()])
  • array $options: Optional parameters.

Redefinition of:
JCacheStorage::__construct()
Constructor
clean (line 261)

Clean cache for a group given a mode.

  • 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.
get (line 111)

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

Get all cached data

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

Redefinition of:
JCacheStorage::getAll()
Get all cached data
getConnection (line 63)

Return memcache connection object

  • return: connection object
  • since: 11.1
  • access: protected
object memcache getConnection ()
lock (line 329)

Lock cached item - override parent as this is more efficient

  • return: True on success, false otherwise.
  • since: 11.1
  • access: public
boolean lock (string $id, string $group, integer $locktime)
  • string $id: The cache data id
  • string $group: The cache data group
  • integer $locktime: Cached item max lock time

Redefinition of:
JCacheStorage::lock()
Lock cached item
lockindex (line 432)

Lock cache index

  • return: True on success, false otherwise.
  • since: 11.1
  • access: protected
boolean lockindex ()
remove (line 220)

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

Store the data to memcache 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
unlock (line 396)

Unlock cached item - override parent for cacheid compatibility with lock

  • return: True on success, false otherwise.
  • since: 11.1
  • access: public
boolean unlock (string $id, [string $group = null])
  • string $id: The cache data id
  • string $group: The cache data group

Redefinition of:
JCacheStorage::unlock()
Unlock cached item
unlockindex (line 467)

Unlock cache index

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

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 13:56:56 -0500 by phpDocumentor 1.4.4