Docs For Class JCacheStorageApc

Description

APC cache storage handler

see: http://php.net/manual/en/book.apc.php
since: 11.1

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

JCacheStorage
   |
   --JCacheStorageApc

Method Summary

static boolean isSupported ()

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

boolean gc ()

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

array getAll ()

object Properties 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])

Variables

Inherited Variables

Inherited from JCacheStorage

JCacheStorage::$rawname
JCacheStorage::$_application
JCacheStorage::$_hash
JCacheStorage::$_language
JCacheStorage::$_lifetime
JCacheStorage::$_locking
JCacheStorage::$_now

Methods

static isSupported (line 176)

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.

clean (line 130)

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: 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]

Redefinition of:

JCacheStorage::clean(): Clean cache for a group given a mode.

gc (line 154)

Force garbage collect expired cache data as items are removed only on fetch!

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

boolean gc ()

Redefinition of:

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

get (line 33)

Get cached data from APC 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 46)

Get all cached data

return: data
since: 11.1
access: public

array getAll ()

Redefinition of:

JCacheStorage::getAll(): Get all cached data

lock (line 192)

Lock cached item - override parent as this is more efficient

return: are lock and locklooped
since: 11.1
access: public

object Properties 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

remove (line 111)

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

Store the data to APC 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 241)

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

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