Docs For Class JCacheStorage

JCacheStorage

Description

Abstract cache storage handler

since: 11.1

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

Direct descendents

Class	Description
JCacheStorageApc	APC cache storage handler
JCacheStorageCachelite	Cache lite storage handler
JCacheStorageFile	File cache storage handler
JCacheStorageMemcache	Memcache cache storage handler
JCacheStorageMemcached	Memcached cache storage handler
JCacheStorageWincache	WINCACHE cache storage handler
JCacheStorageXcache	XCache cache storage handler

Variable Summary

string $rawname

string $_application

string $_hash

string $_language

integer $_lifetime

boolean $_locking

datetime $_now

Method Summary

static array addIncludePath ([string $path = ''])

static JCacheStorage getInstance ([string $handler = null], [array $options = array()])

static boolean isSupported ()

static boolean test ()

JCacheStorage __construct ([array $options = array()])

boolean clean (string $group, [string $mode = null])

boolean gc ()

mixed get (string $id, string $group, [boolean $checkTime = true])

mixed getAll ()

boolean lock (string $id, string $group, integer $locktime)

boolean remove (string $id, string $group)

boolean store (string $id, string $group, string $data)

boolean unlock (string $id, [string $group = null])

string _getCacheId (string $id, string $group)

Variables

string $rawname (line 25)

var: Rawname
since: 11.1
access: protected

string $_application (line 55)

var: Application name.
since: 11.1
access: public

string $_hash (line 61)

var: Hash
since: 11.1
access: public

string $_language (line 49)

var: Language
since: 11.1
access: public

integer $_lifetime (line 37)

var: Cache lifetime
since: 11.1
access: public

boolean $_locking (line 43)

var: Locking
since: 11.1
access: public

datetime $_now (line 31)

var: Now
since: 11.1
access: public

Methods

static addIncludePath (line 329)

Add a directory where JCacheStorage should search for handlers. You may either pass a string or an array of directories.

return: An array with directory elements
since: 11.1
access: public

static array addIncludePath ([string $path = ''])

string $path: A path to search.

static getInstance (line 107)

Returns a cache storage handler object, only creating it if it doesn't already exist.

return: A JCacheStorage instance
since: 11.1
throws: UnexpectedValueException
throws: RuntimeException
access: public

static JCacheStorage getInstance ([string $handler = null], [array $options = array()])

string $handler: The cache storage handler to instantiate
array $options: Array of handler options

static isSupported (line 251)

Test to see if the storage handler is available.

return: True on success, false otherwise
since: 12.1.
access: public

static boolean isSupported ()

Redefined in descendants as:

JCacheStorageApc::isSupported() : Test to see if the cache storage is available.
JCacheStorageCachelite::isSupported() : Test to see if the cache storage is available.
JCacheStorageFile::isSupported() : Test to see if the cache storage is available.
JCacheStorageMemcache::isSupported() : Test to see if the cache storage is available.
JCacheStorageMemcached::isSupported() : Test to see if the cache storage is available.
JCacheStorageWincache::isSupported() : Test to see if the cache storage is available.
JCacheStorageXcache::isSupported() : Test to see if the cache storage is available.

static test (line 264)

Test to see if the storage handler is available.

return: True on success, false otherwise.
deprecated: 12.3 (Platform) & 4.0 (CMS)
since: 11.1
access: public

static boolean test ()

Constructor __construct (line 70)

Constructor

since: 11.1
access: public

JCacheStorage __construct ([array $options = array()])

array $options: Optional parameters

Redefined in descendants as:

JCacheStorageCachelite::__construct() : Constructor
JCacheStorageFile::__construct() : Constructor
JCacheStorageMemcache::__construct() : Constructor
JCacheStorageMemcached::__construct() : Constructor
JCacheStorageWincache::__construct() : Constructor

clean (line 227)

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

Redefined in descendants as:

JCacheStorageApc::clean() : Clean cache for a group given a mode.
JCacheStorageCachelite::clean() : Clean cache for a group given a mode.
JCacheStorageFile::clean() : Clean cache for a group given a mode.
JCacheStorageMemcache::clean() : Clean cache for a group given a mode.
JCacheStorageMemcached::clean() : Clean cache for a group given a mode.
JCacheStorageWincache::clean() : Clean cache for a group given a mode.
JCacheStorageXcache::clean() : Clean cache for a group given a mode.

gc (line 239)

Garbage collect expired cache data

return: True on success, false otherwise.
since: 11.1
access: public

boolean gc ()

Redefined in descendants as:

JCacheStorageApc::gc() : Force garbage collect expired cache data as items are removed only on fetch!
JCacheStorageCachelite::gc() : Garbage collect expired cache data
JCacheStorageFile::gc() : Garbage collect expired cache data
JCacheStorageWincache::gc() : Force garbage collect expired cache data as items are removed only on get/add/delete/info etc
JCacheStorageXcache::gc() : Garbage collect expired cache data

get (line 162)

Get cached data by id and group

return: Boolean false on failure or a cached data object
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

Redefined in descendants as:

JCacheStorageApc::get() : Get cached data from APC by id and group
JCacheStorageCachelite::get() : Get cached data from a file by id and group
JCacheStorageFile::get() : Get cached data from a file by id and group
JCacheStorageMemcache::get() : Get cached data from memcache by id and group
JCacheStorageMemcached::get() : Get cached data from memcached by id and group
JCacheStorageWincache::get() : Get cached data from WINCACHE by id and group
JCacheStorageXcache::get() : Get cached data by id and group

getAll (line 175)

Get all cached data

return: Boolean false on failure or a cached data object
todo: Review this method. The docblock doesn't fit what it actually does.
since: 11.1
access: public

mixed getAll ()

Redefined in descendants as:

JCacheStorageApc::getAll() : Get all cached data
JCacheStorageCachelite::getAll() : Get all cached data
JCacheStorageFile::getAll() : Get all cached data
JCacheStorageMemcache::getAll() : Get all cached data
JCacheStorageMemcached::getAll() : Get all cached data
JCacheStorageWincache::getAll() : Get all cached data
JCacheStorageXcache::getAll() : Get all cached data

lock (line 282)

Lock cached item

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

Redefined in descendants as:

JCacheStorageApc::lock() : Lock cached item - override parent as this is more efficient
JCacheStorageFile::lock() : Lock cached item
JCacheStorageMemcache::lock() : Lock cached item - override parent as this is more efficient
JCacheStorageMemcached::lock() : Lock cached item - override parent as this is more efficient

remove (line 210)

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

Redefined in descendants as:

JCacheStorageApc::remove() : Remove a cached data entry by id and group
JCacheStorageCachelite::remove() : Remove a cached data file by id and group
JCacheStorageFile::remove() : Remove a cached data file by id and group
JCacheStorageMemcache::remove() : Remove a cached data entry by id and group
JCacheStorageMemcached::remove() : Remove a cached data entry by id and group
JCacheStorageWincache::remove() : Remove a cached data entry by id and group
JCacheStorageXcache::remove() : Remove a cached data entry by id and group

store (line 195)

Store the data to cache 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

Redefined in descendants as:

JCacheStorageApc::store() : Store the data to APC by id and group
JCacheStorageCachelite::store() : Store the data to a file by id and group
JCacheStorageFile::store() : Store the data to a file by id and group
JCacheStorageMemcache::store() : Store the data to memcache by id and group
JCacheStorageMemcached::store() : Store the data to memcached by id and group
JCacheStorageWincache::store() : Store the data to WINCACHE by id and group
JCacheStorageXcache::store() : Store the data by id and group

unlock (line 297)

Unlock cached item

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

Redefined in descendants as:

JCacheStorageApc::unlock() : Unlock cached item - override parent for cacheid compatibility with lock
JCacheStorageFile::unlock() : Unlock cached item
JCacheStorageMemcache::unlock() : Unlock cached item - override parent for cacheid compatibility with lock
JCacheStorageMemcached::unlock() : Unlock cached item - override parent for cacheid compatibility with lock

_getCacheId (line 312)

Get a cache_id string from an id/group pair

return: The cache_id string
since: 11.1
access: protected

string _getCacheId (string $id, string $group)

string $id: The cache data id
string $group: The cache data group

Documentation generated on Tue, 19 Nov 2013 15:14:22 +0100 by phpDocumentor 1.4.3