| [ Index ] |
PHP Cross Reference of Joomla 4.2.2 documentation |
[Source view] [Print] [Project Stats]
Joomla! Content Management System
| Copyright: | (C) 2007 Open Source Matters, Inc. |
| License: | GNU General Public License version 2 or later; see LICENSE.txt |
| File Size: | 386 lines (8 kb) |
| Included or required: | 0 times |
| Referenced: | 2 times |
| Includes or requires: | 0 files |
CacheStorage:: (15 methods):
__construct()
getInstance()
contains()
get()
getAll()
store()
remove()
clean()
flush()
gc()
isSupported()
lock()
unlock()
_getCacheId()
addIncludePath()
Class: CacheStorage - X-Ref
Abstract cache storage handler| __construct($options = array() X-Ref |
| Constructor param: array $options Optional parameters |
| getInstance($handler = null, $options = array() X-Ref |
| Returns a cache storage handler object. param: string $handler The cache storage handler to instantiate param: array $options Array of handler options return: CacheStorage |
| 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 |
| flush() X-Ref |
| Flush all existing items in storage. return: boolean |
| gc() X-Ref |
| Garbage collect expired cache data return: boolean |
| isSupported() X-Ref |
| Test to see if the storage handler is available. return: boolean |
| lock($id, $group, $locktime) X-Ref |
| Lock cached item param: string $id The cache data ID param: string $group The cache data group param: integer $locktime Cached item max lock time return: mixed Boolean false if locking failed or an object containing properties lock and locklooped |
| unlock($id, $group = null) X-Ref |
| Unlock cached item param: string $id The cache data ID param: string $group The cache data group return: boolean |
| _getCacheId($id, $group) X-Ref |
| Get a cache ID string from an ID/group pair param: string $id The cache data ID param: string $group The cache data group return: string |
| addIncludePath($path = '') X-Ref |
| Add a directory where CacheStorage should search for handlers. You may either pass a string or an array of directories. param: array|string $path A path to search. return: array An array with directory elements |
| Generated: Wed Sep 7 05:41:13 2022 | Chilli.vc Blog - For Webmaster,Blog-Writer,System Admin and Domainer |