Joomla! API

Download
Launch

RedisStorage

Extends \Joomla\CMS\Cache\CacheStorage

Redis cache storage handler for PECL

since

3.4

Methods

__construct

Constructor

__construct(array $options = array())
inherited
since

1.7.0

Arguments

$options

arrayOptional parameters

_getCacheId

Get a cache ID string from an ID/group pair

_getCacheId(string $id, string $group) : string
inherited
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
inherited static
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) : boolean
inherited

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

boolean

contains

Check if the cache contains data stored by ID and group

contains(string $id, string $group) : boolean
inherited
since

3.7.0

Arguments

$id

stringThe cache data ID

$group

stringThe cache data group

Response

boolean

flush

Flush all existing items in storage.

flush() : boolean
inherited
since

3.6.3

Response

boolean

gc

Garbage collect expired cache data

gc() : boolean
inherited
since

1.7.0

Response

boolean

get

Get cached data by ID and group

get(string $id, string $group, boolean $checkTime = true) : mixed
inherited
since

1.7.0

Arguments

$id

stringThe cache data ID

$group

stringThe cache data group

$checkTime

booleanTrue to verify cache time expiration threshold

Response

mixedBoolean false on failure or a cached data object

getAll

Get all cached data

getAll() : mixed
inherited
since

1.7.0

Response

mixedBoolean false on failure or a cached data object

getConnection

Create the Redis connection

getConnection() : \Redis|boolean
since

3.4
note

As of 4.0 this method will throw a JCacheExceptionConnecting object on connection failure

Response

\Redis|booleanRedis 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
inherited static
since

1.7.0
throws

\UnexpectedValueException

\Joomla\CMS\Cache\Exception\UnsupportedCacheException

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() : boolean
static
since

3.4

Response

boolean

isSupported

Test to see if the storage handler is available.

isSupported() : boolean
inherited static
since

3.0.0

Response

boolean

lock

Lock cached item

lock(string $id, string $group, integer $locktime) : mixed
inherited
since

1.7.0

Arguments

$id

stringThe cache data ID

$group

stringThe cache data group

$locktime

integerCached 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) : boolean
inherited
since

1.7.0

Arguments

$id

stringThe cache data ID

$group

stringThe cache data group

Response

boolean

store

Store the data to cache by ID and group

store(string $id, string $group, string $data) : boolean
inherited
since

1.7.0

Arguments

$id

stringThe cache data ID

$group

stringThe cache data group

$data

stringThe data to store in cache

Response

boolean

test

Test to see if the storage handler is available.

test() : boolean
inherited static deprecated
since

1.7.0
deprecated

4.0

Response

boolean

unlock

Unlock cached item

unlock(string $id, string $group = null) : boolean
inherited
since

1.7.0

Arguments

$id

stringThe cache data ID

$group

stringThe cache data group

Response

boolean

Properties

_redis

Redis connection object

static
since

3.4

Type(s)

\Redis

_persistent

Persistent session flag

since

3.4

Type(s)

boolean

rawname

The raw object name

inherited
since

1.7.0

Type(s)

string

_now

Time that the cache storage handler was instantiated

inherited
since

1.7.0

Type(s)

integer

_lifetime

Cache lifetime

inherited
since

1.7.0

Type(s)

integer

_locking

Flag if locking is enabled

inherited
since

1.7.0

Type(s)

boolean

_language

Language code

inherited
since

1.7.0

Type(s)

string

_application

Application name

inherited
since

1.7.0

Type(s)

string

_hash

Object hash

inherited
since

1.7.0

Type(s)

string
  • \ Joomla
  • \ CMS
  • \ Cache
  • \ Storage
  • \ RedisStorage