Class JCacheStorage

Abstract cache storage handler

Direct known subclasses

JCacheStorageApc, JCacheStorageApcu, JCacheStorageCachelite, JCacheStorageFile, JCacheStorageMemcache, JCacheStorageMemcached, JCacheStorageRedis, JCacheStorageWincache, JCacheStorageXcache

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: 11.1
Note: As of 4.0 this class will be abstract
Located at joomla/cache/storage.php

Methods summary

`public`	# `__construct( array $options = array() )` Constructor Constructor Parameters `$options` `array` - $options Optional parameters Since 11.1
`public static JCacheStorage`	# `getInstance( string $handler = null, array $options = array() )` Returns a cache storage handler object. Returns a cache storage handler object. Parameters `$handler` `string` - $handler The cache storage handler to instantiate `$options` `array` - $options Array of handler options Returns `JCacheStorage` Throws `UnexpectedValueException` `JCacheExceptionUnsupported` Since 11.1
`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
`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 11.1
`public mixed`	# `getAll( )` Get all cached data Get all cached data Returns `mixed` - Boolean false on failure or a cached data object Since 11.1
`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 11.1
`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 11.1
`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 11.1
`public boolean`	# `flush( )` Flush all existing items in storage. Flush all existing items in storage. Returns `boolean` Since 3.6.3
`public boolean`	# `gc( )` Garbage collect expired cache data Garbage collect expired cache data Returns `boolean` Since 11.1
`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 12.1
`public static boolean`	# `test( )` Test to see if the storage handler is available. Test to see if the storage handler is available. Deprecated 12.3 (Platform) & 4.0 (CMS) Returns `boolean` Since 11.1
`public mixed`	# `lock( string $id, string $group, integer $locktime )` Lock cached item Lock cached item Parameters `$id` `string` - $id The cache data ID `$group` `string` - $group The cache data group `$locktime` `integer` - $locktime Cached item max lock time Returns `mixed` - Boolean false if locking failed or an object containing properties lock and locklooped Since 11.1
`public boolean`	# `unlock( string $id, string $group = null )` Unlock cached item Unlock cached item Parameters `$id` `string` - $id The cache data ID `$group` `string` - $group The cache data group Returns `boolean` Since 11.1
`protected string`	# `_getCacheId( string $id, string $group )` Get a cache ID string from an ID/group pair Get a cache ID string from an ID/group pair Parameters `$id` `string` - $id The cache data ID `$group` `string` - $group The cache data group Returns `string` Since 11.1
`public static array`	# `addIncludePath( array\|string $path = '' )` Add a directory where JCacheStorage should search for handlers. You may either pass a string or an array of directories. Add a directory where JCacheStorage should search for handlers. You may either pass a string or an array of directories. Parameters `$path` `array\|string` - $path A path to search. Returns `array` - An array with directory elements Since 11.1

Magic methods summary

Properties summary

`protected string`	`$rawname`	# The raw object name The raw object name Since 11.1
`public integer`	`$_now`	# Time that the cache storage handler was instantiated Time that the cache storage handler was instantiated Since 11.1
`public integer`	`$_lifetime`	# Cache lifetime Cache lifetime Since 11.1
`public boolean`	`$_locking`	# Flag if locking is enabled Flag if locking is enabled Since 11.1
`public string`	`$_language`	# Language code Language code Since 11.1
`public string`	`$_application`	# Application name Application name Since 11.1
`public string`	`$_hash`	# Object hash Object hash Since 11.1

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class JCacheStorage

Direct known subclasses

Methods summary

Parameters

Since

Parameters

Returns

Throws

Since

Parameters

Returns

Since

Parameters

Returns

Since

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Returns

Since

Returns

Since

Returns

Since

Deprecated

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Magic methods summary

Properties summary

Since

Since

Since

Since

Since

Since

Since