Docs For Class JCacheStorageCachelite

Description

Cache lite storage handler

see: http://pear.php.net/package/Cache_Lite/
since: 11.1

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

JCacheStorage
   |
   --JCacheStorageCachelite

Variable Summary

static object $CacheLiteInstance

string $_root

Method Summary

static boolean isSupported ()

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

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

boolean gc ()

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

array getAll ()

object initCache (array $cloptions)

boolean remove (string $id, string $group)

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

Variables

static object $CacheLiteInstance = null (line 28)

Static cache of the Cache_Lite instance

since: 11.1
access: protected

string $_root (line 36)

Root path

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 isSupported (line 327)

Test to see if the cache storage is available.

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

static boolean isSupported ()

Redefinition of:

JCacheStorage::isSupported(): Test to see if the storage handler is available.

Constructor __construct (line 45)

Constructor

since: 11.1
access: public

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

array $options: Optional parameters.

Redefinition of:

JCacheStorage::__construct(): Constructor

clean (line 232)

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.

gc (line 290)

Garbage collect expired cache data

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

boolean gc ()

Redefinition of:

JCacheStorage::gc(): Garbage collect expired cache data

get (line 97)

Get cached data from a file 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 113)

Get all cached data

since: 11.1
access: public

array getAll ()

Redefinition of:

JCacheStorage::getAll(): Get all cached data

initCache (line 77)

Instantiates the appropriate CacheLite object.

Only initializes the engine if it does not already exist. Note this is a protected method

since: 11.1
access: protected

object initCache (array $cloptions)

array $cloptions: optional parameters

remove (line 204)

Remove a cached data file 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 162)

Store the data to a file 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::isSupported()
JCacheStorage::lock()
JCacheStorage::remove()
JCacheStorage::store()
JCacheStorage::test()
JCacheStorage::unlock()
JCacheStorage::_getCacheId()