Class JCacheStorageRedis

Redis cache storage handler for PECL

JCacheStorageRedis

Package: Joomla\Platform\Cache
Copyright: Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved.
License: General Public License version 2 or later; see LICENSE
Since: 3.4
Located at joomla/cache/storage/redis.php

Methods summary

`public`	# `__construct( array $options = array() )` Constructor Constructor Parameters `$options` `array` - $options Optional parameters. Since 3.4 Overrides `JCacheStorage::__construct`
`protected Redis\|boolean`	# `getConnection( )` Create the Redis connection Create the Redis connection Returns `Redis\|boolean` - Redis connection object on success, boolean on failure Since 3.4 Note As of 4.0 this method will throw a JCacheExceptionConnecting object on connection failure
`public boolean`	# `contains( string $id, string $group )` Check if the cache contains data stored by ID and group Check if the cache contains data stored by ID and group Parameters `$id` `string` - $id The cache data ID `$group` `string` - $group The cache data group Returns `boolean` Since 3.7.0 Overrides `JCacheStorage::contains`
`public mixed`	# `get( string $id, string $group, boolean $checkTime = true )` Get cached data by ID and group Get cached data by ID and group Parameters `$id` `string` - $id The cache data ID `$group` `string` - $group The cache data group `$checkTime` `boolean` - $checkTime True to verify cache time expiration threshold Returns `mixed` - Boolean false on failure or a cached data object Since 3.4 Overrides `JCacheStorage::get`
`public mixed`	# `getAll( )` Get all cached data Get all cached data Returns `mixed` - Boolean false on failure or a cached data object Since 3.4 Overrides `JCacheStorage::getAll`
`public boolean`	# `store( string $id, string $group, string $data )` Store the data to cache by ID and group Store the data to cache by ID and group Parameters `$id` `string` - $id The cache data ID `$group` `string` - $group The cache data group `$data` `string` - $data The data to store in cache Returns `boolean` Since 3.4 Overrides `JCacheStorage::store`
`public boolean`	# `remove( string $id, string $group )` Remove a cached data entry by ID and group Remove a cached data entry by ID and group Parameters `$id` `string` - $id The cache data ID `$group` `string` - $group The cache data group Returns `boolean` Since 3.4 Overrides `JCacheStorage::remove`
`public boolean`	# `clean( string $group, string $mode = null )` Clean cache for a group given a mode. 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 Parameters `$group` `string` - $group The cache data group `$mode` `string` - $mode The mode for cleaning cache [group\|notgroup] Returns `boolean` Since 3.4 Overrides `JCacheStorage::clean`
`public static boolean`	# `isSupported( )` Test to see if the storage handler is available. Test to see if the storage handler is available. Returns `boolean` Since 3.4 Overrides `JCacheStorage::isSupported`
`public static boolean`	# `isConnected( )` Test to see if the Redis connection is available. Test to see if the Redis connection is available. Returns `boolean` Since 3.4

Methods inherited from JCacheStorage

_getCacheId(), addIncludePath(), flush(), gc(), getInstance(), lock(), test(), unlock()

Magic methods summary

Properties summary

`protected static Redis`	`$_redis`	# Redis connection object Redis connection object Since 3.4
`protected boolean`	`$_persistent`	# Persistent session flag Persistent session flag Since 3.4

Properties inherited from JCacheStorage

$_application, $_hash, $_language, $_lifetime, $_locking, $_now, $rawname

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class JCacheStorageRedis

Methods summary

Parameters

Since

Overrides

Returns

Since

Note

Parameters

Returns

Since

Overrides

Parameters

Returns

Since

Overrides

Returns

Since

Overrides

Parameters

Returns

Since

Overrides

Parameters

Returns

Since

Overrides

Parameters

Returns

Since

Overrides

Returns

Since

Overrides

Returns

Since

Methods inherited from JCacheStorage

Magic methods summary

Properties summary

Since

Since

Properties inherited from JCacheStorage