JCacheStorage: Difference between revisions
From Joomla! Documentation
m moving preparation |
m preparing for archive only |
||
| (One intermediate revision by the same user not shown) | |||
| Line 2: | Line 2: | ||
=={{JVer|11.1}} JCacheStorage== | =={{JVer|11.1}} JCacheStorage== | ||
===Description=== | ===Description=== | ||
JCacheStorage is an abstract class. The class needs to be extended by concrete storage handlers. The Joomla Framework currently provides the handlers JCacheStorageApc, JCacheStorageEaccelarator, JCacheStorageFile, JCacheStorageMemcache, JCacheStorageXCache, JCacheStorageXcache | |||
===Methods=== | ===Methods=== | ||
{| class="wikitable sortable" | {| class="wikitable sortable" | ||
| Line 81: | Line 79: | ||
* {{JVer|11.1}} Subpackage [[API17:Subpackage Cache|Cache]] | * {{JVer|11.1}} Subpackage [[API17:Subpackage Cache|Cache]] | ||
* [[API17:JCacheStorage|Other versions of JCacheStorage]] | * [[API17:JCacheStorage|Other versions of JCacheStorage]] | ||
===User contributed notes=== | ===User contributed notes=== | ||
=== Code Examples === | |||
<dpl> | <dpl> | ||
noresultsheader=\n | noresultsheader=\n | ||
category=JCacheStorage | category=JCacheStorage | ||
namespace=CodeExample | |||
category=ClassExample | category=ClassExample | ||
include=* | include=* | ||
Latest revision as of 02:25, 25 March 2017
JCacheStorage
Description
JCacheStorage is an abstract class. The class needs to be extended by concrete storage handlers. The Joomla Framework currently provides the handlers JCacheStorageApc, JCacheStorageEaccelarator, JCacheStorageFile, JCacheStorageMemcache, JCacheStorageXCache, JCacheStorageXcache
Methods
| Visibility | Method name | Description |
|---|---|---|
| public | __construct | Constructor. |
| public | clean | Clean cache for a group given a mode. |
| public | gc | Garbage collect expired cache data. |
| public | get | Get cached data by id and group. |
| public | getAll | Get all cached data. |
| public | lock | Lock cached item. |
| public | remove | Remove a cached data entry by id and group. |
| public | store | Store the data to cache by id and group. |
| public | unlock | Unlock cached item. |
| public static | addIncludePath | Add a directory where should search for handlers. |
| public static | getInstance | Returns a cache storage handler object, only creating it if it doesn't already exist. |
| public static | test | Test to see if the storage handler is available. |
| protected | _getCacheId | Get a cache_id string from an id/group pair. |
- Defined in libraries/joomla/cache/storage.php
- Extended by
Importing
jimport( 'joomla.cache.storage' );
See also
- JCacheStorage source code on BitBucket
- Subpackage Cache
- Other versions of JCacheStorage
User contributed notes
Code Examples