[ Index ]

PHP Cross Reference of Joomla 4.2.2 documentation

title

Body

[close]

/libraries/src/Cache/Storage/ -> RedisStorage.php (summary)

Joomla! Content Management System

Copyright: (C) 2014 Open Source Matters, Inc.
License: GNU General Public License version 2 or later; see LICENSE.txt
File Size: 355 lines (7 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

RedisStorage:: (10 methods):
  __construct()
  getConnection()
  contains()
  get()
  getAll()
  store()
  remove()
  clean()
  isSupported()
  isConnected()


Class: RedisStorage  - X-Ref

Redis cache storage handler for PECL

__construct($options = array()   X-Ref
Constructor

param: array  $options  Optional parameters.

getConnection()   X-Ref
Create the Redis connection

return: \Redis|boolean  Redis connection object on success, boolean on failure

contains($id, $group)   X-Ref
Check if the cache contains data stored by ID and group

param: string  $id     The cache data ID
param: string  $group  The cache data group
return: boolean

get($id, $group, $checkTime = true)   X-Ref
Get cached data by ID and group

param: string   $id         The cache data ID
param: string   $group      The cache data group
param: boolean  $checkTime  True to verify cache time expiration threshold
return: mixed  Boolean false on failure or a cached data object

getAll()   X-Ref
Get all cached data

return: mixed  Boolean false on failure or a cached data object

store($id, $group, $data)   X-Ref
Store the data to cache by ID and group

param: string  $id     The cache data ID
param: string  $group  The cache data group
param: string  $data   The data to store in cache
return: boolean

remove($id, $group)   X-Ref
Remove a cached data entry by ID and group

param: string  $id     The cache data ID
param: string  $group  The cache data group
return: boolean

clean($group, $mode = null)   X-Ref
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

param: string  $group  The cache data group
param: string  $mode   The mode for cleaning cache [group|notgroup]
return: boolean

isSupported()   X-Ref
Test to see if the storage handler is available.

return: boolean

isConnected()   X-Ref
Test to see if the Redis connection is available.

return: boolean



Generated: Wed Sep 7 05:41:13 2022 Chilli.vc Blog - For Webmaster,Blog-Writer,System Admin and Domainer