RedisStorage
Extends CacheStorageRedis cache storage handler for PECL
| since |
3.4 |
|---|---|
| package |
Application |
Methods
__construct
Constructor
__construct(array options = array()) : mixed
| since |
1.7.0 |
|---|
Arguments
- options
arrayOptional parameters
Response
mixed
_getCacheId
Get a cache ID string from an ID/group pair
_getCacheId(string id, string group) : string
| since |
1.7.0 |
|---|
Arguments
- id
stringThe cache data ID- group
stringThe cache data group
Response
string
addIncludePath
Add a directory where CacheStorage should search for handlers. You may either pass a string or an array of directories.
addIncludePath(array|string path = '') : array
| since |
1.7.0 |
|---|
Arguments
- path
array|stringA path to search.
Response
arrayAn array with directory elements
clean
Clean cache for a group given a mode.
clean(string group, string mode = null) : bool
group mode : cleans all cache in the group notgroup mode : cleans all cache not in the group
| since |
1.7.0 |
|---|
Arguments
- group
stringThe cache data group- mode
stringThe mode for cleaning cache [group|notgroup]
Response
bool
contains
Check if the cache contains data stored by ID and group
contains(string id, string group) : bool
| since |
3.7.0 |
|---|
Arguments
- id
stringThe cache data ID- group
stringThe cache data group
Response
bool
flush
Flush all existing items in storage.
flush() : bool
| since |
3.6.3 |
|---|
Response
bool
gc
Garbage collect expired cache data
gc() : bool
| since |
1.7.0 |
|---|
Response
bool
get
Get cached data by ID and group
get(string id, string group, bool checkTime = true) : mixed
| since |
1.7.0 |
|---|
Arguments
- id
stringThe cache data ID- group
stringThe cache data group- checkTime
boolTrue to verify cache time expiration threshold
Response
mixedBoolean false on failure or a cached data object
getAll
Get all cached data
getAll() : mixed
| since |
1.7.0 |
|---|
Response
mixedBoolean false on failure or a cached data object
getConnection
Create the Redis connection
getConnection() : \Redis|bool
| since |
3.4 |
|---|---|
| note |
As of 4.0 this method will throw a JCacheExceptionConnecting object on connection failure |
Response
\Redis|boolRedis connection object on success, boolean on failure
getInstance
Returns a cache storage handler object.
getInstance(string handler = null, array options = array()) : \Joomla\CMS\Cache\CacheStorage
| since |
1.7.0 |
|---|---|
| throws |
|
Arguments
- handler
stringThe cache storage handler to instantiate- options
arrayArray of handler options
Response
\Joomla\CMS\Cache\CacheStorage
isConnected
Test to see if the Redis connection is available.
isConnected() : bool
| since |
3.4 |
|---|
Response
bool
isSupported
Test to see if the storage handler is available.
isSupported() : bool
| since |
3.0.0 |
|---|
Response
bool
lock
Lock cached item
lock(string id, string group, int locktime) : mixed
| since |
1.7.0 |
|---|
Arguments
- id
stringThe cache data ID- group
stringThe cache data group- locktime
intCached item max lock time
Response
mixedBoolean false if locking failed or an object containing properties lock and locklooped
remove
Remove a cached data entry by ID and group
remove(string id, string group) : bool
| since |
1.7.0 |
|---|
Arguments
- id
stringThe cache data ID- group
stringThe cache data group
Response
bool
store
Store the data to cache by ID and group
store(string id, string group, string data) : bool
| since |
1.7.0 |
|---|
Arguments
- id
stringThe cache data ID- group
stringThe cache data group- data
stringThe data to store in cache
Response
bool
unlock
Unlock cached item
unlock(string id, string group = null) : bool
| since |
1.7.0 |
|---|
Arguments
- id
stringThe cache data ID- group
stringThe cache data group
Response
bool
Properties
_redis
Redis connection object
| since |
3.4 |
|---|
Type(s)
\Redis