JCacheStorageMemcache
Extends \JCacheStorageMemcache cache storage handler
package |
Joomla.Platform |
---|---|
subpackage |
Cache |
see | |
since |
11.1 |
Methods
__construct
Constructor
__construct(array $options = array())
since |
11.1 |
---|
Arguments
- $options
array
Optional parameters
_getCacheId
Get a cache_id string from an id/group pair
_getCacheId(string $id, string $group) : string
since |
11.1 |
---|
Arguments
- $id
string
The cache data id- $group
string
The cache data group
Response
string
The cache_id string
addIncludePath
Add a directory where JCacheStorage should search for handlers. You may either pass a string or an array of directories.
addIncludePath(string $path = '') : array
since |
11.1 |
---|
Arguments
- $path
string
A path to search.
Response
array
An array with directory elements
clean
Clean cache for a group given a mode.
clean(string $group, string $mode = null) : boolean
since |
11.1 |
---|
Arguments
- $group
string
The cache data group- $mode
string
The mode for cleaning cache [group|notgroup] group mode : cleans all cache in the group notgroup mode : cleans all cache not in the group
Response
boolean
True on success, false otherwise
gc
Garbage collect expired cache data
gc() : boolean
since |
11.1 |
---|
Response
boolean
True on success, false otherwise.
get
Get cached data by id and group
get(string $id, string $group, boolean $checkTime = true) : mixed
since |
11.1 |
---|
Arguments
- $id
string
The cache data id- $group
string
The cache data group- $checkTime
boolean
True to verify cache time expiration threshold
Response
mixed
Boolean false on failure or a cached data object
getAll
Get all cached data
getAll() : mixed
since |
11.1 |
---|
Response
mixed
Boolean false on failure or a cached data object
getConnection
Return memcache connection object
getConnection() : object
since |
11.1 |
---|
Response
object
memcache connection object
getInstance
Returns a cache storage handler object, only creating it if it doesn't already exist.
getInstance(string $handler = null, array $options = array()) : \JCacheStorageHandler
since |
11.1 |
---|
Arguments
- $handler
string
The cache storage handler to instantiate- $options
array
Array of handler options
Response
\JCacheStorageHandler
A JCacheStorageHandler object
lock
Lock cached item
lock(string $id, string $group, integer $locktime) : boolean
since |
11.1 |
---|
Arguments
- $id
string
The cache data id- $group
string
The cache data group- $locktime
integer
Cached item max lock time
Response
boolean
True on success, false otherwise.
lockindex
Lock cache index
lockindex() : boolean
since |
11.1 |
---|
Response
boolean
True on success, false otherwise.
remove
Remove a cached data entry by id and group
remove(string $id, string $group) : boolean
since |
11.1 |
---|
Arguments
- $id
string
The cache data id- $group
string
The cache data group
Response
boolean
True on success, false otherwise
store
Store the data to cache by id and group
store(string $id, string $group, string $data) : boolean
since |
11.1 |
---|
Arguments
- $id
string
The cache data id- $group
string
The cache data group- $data
string
The data to store in cache
Response
boolean
True on success, false otherwise
test
Test to see if the storage handler is available.
test() : boolean
since |
11.1. |
---|
Response
boolean
True on success, false otherwise
unlock
Unlock cached item
unlock(string $id, string $group = null) : boolean
since |
11.1 |
---|
Arguments
- $id
string
The cache data id- $group
string
The cache data group
Response
boolean
True on success, false otherwise.
unlockindex
Unlock cache index
unlockindex() : boolean
since |
11.1 |
---|
Response
boolean
True on success, false otherwise.
Properties
_db
since |
11.1 |
---|
Type(s)
\Memcache
_persistent
since |
11.1 |
---|
Type(s)
boolean
_compress
since |
11.1 |
---|
Type(s)
rawname
Rawname
since |
11.1 |
---|
Type(s)
string
_now
Now
since |
11.1 |
---|
Type(s)
\datetime
_lifetime
Cache lifetime
since |
11.1 |
---|
Type(s)
integer
_locking
Locking
since |
11.1 |
---|
Type(s)
boolean
_language
Language
since |
11.1 |
---|
Type(s)
string
_application
Application name.
since |
11.1 |
---|
Type(s)
string
_hash
Hash
since |
11.1 |
---|
Type(s)
string