Difference between revisions of "JCacheStorage"
From Joomla! Documentation
m (JoomlaWikiBot moved page JCacheStorage/11.1 to API17:JCacheStorage without leaving a redirect: Robot: Moved page) |
m (moving preparation) |
||
(One intermediate revision by the same user not shown) | |||
Line 14: | Line 14: | ||
|- | |- | ||
|public | |public | ||
− | |[[JCacheStorage::__construct | + | |[[API17:JCacheStorage::__construct|__construct]] |
|Constructor. | |Constructor. | ||
|- | |- | ||
|public | |public | ||
− | |[[JCacheStorage::clean | + | |[[API17:JCacheStorage::clean|clean]] |
|Clean cache for a group given a mode. | |Clean cache for a group given a mode. | ||
|- | |- | ||
|public | |public | ||
− | |[[JCacheStorage::gc | + | |[[API17:JCacheStorage::gc|gc]] |
|Garbage collect expired cache data. | |Garbage collect expired cache data. | ||
|- | |- | ||
|public | |public | ||
− | |[[JCacheStorage::get | + | |[[API17:JCacheStorage::get|get]] |
|Get cached data by id and group. | |Get cached data by id and group. | ||
|- | |- | ||
|public | |public | ||
− | |[[JCacheStorage::getAll | + | |[[API17:JCacheStorage::getAll|getAll]] |
|Get all cached data. | |Get all cached data. | ||
|- | |- | ||
|public | |public | ||
− | |[[JCacheStorage::lock | + | |[[API17:JCacheStorage::lock|lock]] |
|Lock cached item. | |Lock cached item. | ||
|- | |- | ||
|public | |public | ||
− | |[[JCacheStorage::remove | + | |[[API17:JCacheStorage::remove|remove]] |
|Remove a cached data entry by id and group. | |Remove a cached data entry by id and group. | ||
|- | |- | ||
|public | |public | ||
− | |[[JCacheStorage::store | + | |[[API17:JCacheStorage::store|store]] |
|Store the data to cache by id and group. | |Store the data to cache by id and group. | ||
|- | |- | ||
|public | |public | ||
− | |[[JCacheStorage::unlock | + | |[[API17:JCacheStorage::unlock|unlock]] |
|Unlock cached item. | |Unlock cached item. | ||
|- | |- | ||
|public static | |public static | ||
− | |[[JCacheStorage::addIncludePath | + | |[[API17:JCacheStorage::addIncludePath|addIncludePath]] |
|Add a directory where should search for handlers. | |Add a directory where should search for handlers. | ||
|- | |- | ||
|public static | |public static | ||
− | |[[JCacheStorage::getInstance | + | |[[API17:JCacheStorage::getInstance|getInstance]] |
|Returns a cache storage handler object, only creating it if it doesn't already exist. | |Returns a cache storage handler object, only creating it if it doesn't already exist. | ||
|- | |- | ||
|public static | |public static | ||
− | |[[JCacheStorage::test | + | |[[API17:JCacheStorage::test|test]] |
|Test to see if the storage handler is available. | |Test to see if the storage handler is available. | ||
|- | |- | ||
|protected | |protected | ||
− | |[[JCacheStorage::_getCacheId | + | |[[API17:JCacheStorage::_getCacheId|_getCacheId]] |
|Get a cache_id string from an id/group pair. | |Get a cache_id string from an id/group pair. | ||
|- | |- | ||
Line 68: | Line 68: | ||
* '''Defined in''' libraries/joomla/cache/storage.php | * '''Defined in''' libraries/joomla/cache/storage.php | ||
* '''Extended by''' | * '''Extended by''' | ||
− | ** [[JCacheStorageApc | + | ** [[API17:JCacheStorageApc|JCacheStorageApc]] |
− | ** [[JCacheStorageCachelite | + | ** [[API17:JCacheStorageCachelite|JCacheStorageCachelite]] |
− | ** [[JCacheStorageEaccelerator | + | ** [[API17:JCacheStorageEaccelerator|JCacheStorageEaccelerator]] |
− | ** [[JCacheStorageFile | + | ** [[API17:JCacheStorageFile|JCacheStorageFile]] |
− | ** [[JCacheStorageMemcache | + | ** [[API17:JCacheStorageMemcache|JCacheStorageMemcache]] |
− | ** [[JCacheStorageWincache | + | ** [[API17:JCacheStorageWincache|JCacheStorageWincache]] |
− | ** [[JCacheStorageXcache | + | ** [[API17:JCacheStorageXcache|JCacheStorageXcache]] |
===Importing=== | ===Importing=== | ||
<source lang="php">jimport( 'joomla.cache.storage' );</source> | <source lang="php">jimport( 'joomla.cache.storage' );</source> | ||
===See also=== | ===See also=== | ||
* {{JVer|11.1}} '''JCacheStorage source code''' on [[jplatform:cache/storage.php|BitBucket]] | * {{JVer|11.1}} '''JCacheStorage source code''' on [[jplatform:cache/storage.php|BitBucket]] | ||
− | * {{JVer|11.1}} Subpackage [[Subpackage Cache | + | * {{JVer|11.1}} Subpackage [[API17:Subpackage Cache|Cache]] |
− | * [[JCacheStorage|Other versions of JCacheStorage]] | + | * [[API17:JCacheStorage|Other versions of JCacheStorage]] |
{{SeeAlso:JCacheStorage}} | {{SeeAlso:JCacheStorage}} | ||
<span class="editsection" style="font-size:76%;"> | <span class="editsection" style="font-size:76%;"> | ||
Line 96: | Line 96: | ||
format= ,,, | format= ,,, | ||
</dpl> | </dpl> | ||
− | <noinclude> | + | <noinclude>[[Category:Platform 11.1]][[Category:Archived pages API17]]</noinclude> |
Revision as of 19:50, 11 May 2013
The "API17" namespace is an archived namespace. This page contains information for a Joomla! version which is no longer supported. It exists only as a historical reference, it will not be improved and its content may be incomplete and/or contain broken links.
JCacheStorage[edit]
Description[edit]
Template:Description:JCacheStorage [Edit Descripton]
Methods[edit]
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[edit]
jimport( 'joomla.cache.storage' );
See also[edit]
- JCacheStorage source code on BitBucket
- Subpackage Cache
- Other versions of JCacheStorage
Template:SeeAlso:JCacheStorage [Edit See Also]
User contributed notes[edit]
<CodeExamplesForm />