Search

Projects

Classes

Methods

⇦ Back to Joomla project (class list)

Class RedisStorage - list of methods

Redis cache storage handler for PECL

Extends

CacheStorage
Package: Joomla\CMS\Cache\Storage
Copyright: (C) 2014 Open Source Matters, Inc.
License: GNU General Public License version 2 or later; see LICENSE.txt
Located at: Joomla/Cache/Storage/RedisStorage.php
Project: Joomla

Method Summary

public
__construct
(mixed $options = array())

Constructor
Parameters
  • array $options Optional parameters.
Since
  • 3.4
Show source code of this method: __construct Source Code

protected \Redis|bool
()

Create the Redis connection
Returns
  • \Redis|bool Redis connection object on success, boolean on failure
Since
  • 3.4
-
  • As of 4.0 this method will throw a JCacheExceptionConnecting object on connection failure
Show source code of this method: getConnection Source Code

public bool
(mixed $id, mixed $group)

Check if the cache contains data stored by ID and group
Parameters
  • string $id The cache data ID
  • string $group The cache data group
Returns
  • bool
Since
  • 3.7.0
Show source code of this method: contains Source Code

public mixed
(mixed $id, mixed $group, mixed $checkTime = true)

Get cached data by ID and group
Parameters
  • string $id The cache data ID
  • string $group The cache data group
  • bool $checkTime True to verify cache time expiration threshold
Returns
  • mixed Boolean false on failure or a cached data object
Since
  • 3.4
Show source code of this method: get Source Code

public mixed
()

Get all cached data
Returns
  • mixed Boolean false on failure or a cached data object
Since
  • 3.4
Show source code of this method: getAll Source Code

public bool
(mixed $id, mixed $group, mixed $data)

Store the data to cache by ID and group
Parameters
  • string $id The cache data ID
  • string $group The cache data group
  • string $data The data to store in cache
Returns
  • bool
Since
  • 3.4
Show source code of this method: store Source Code

public bool
(mixed $id, mixed $group)

Remove a cached data entry by ID and group
Parameters
  • string $id The cache data ID
  • string $group The cache data group
Returns
  • bool
Since
  • 3.4
Show source code of this method: remove Source Code

public bool
(mixed $group, mixed $mode = null)

Clean cache for a group given a mode.
Parameters
  • string $group The cache data group
  • string $mode The mode for cleaning cache [group|notgroup]
Returns
  • bool
Since
  • 3.4
Show source code of this method: clean Source Code

public static bool
()

Test to see if the storage handler is available.
Returns
  • bool
Since
  • 3.4
Show source code of this method: isSupported Source Code

public static bool
()

Test to see if the Redis connection is available.
Returns
  • bool
Since
  • 3.4
Show source code of this method: isConnected Source Code

Properties Summary

protected static \Redis
$_redis
Redis connection object
Since
  • 3.4
protected bool
$_persistent
Persistent session flag
Since
  • 3.4

Tags Summary

Since
3.4