Difference between revisions of "JCache"
From Joomla! Documentation
(Bulk upload by Doxiki2) |
m (moving preparation) |
||
(5 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
+ | =={{JVer|11.1}} JCache== | ||
+ | ===Description=== | ||
+ | {{Description:JCache}} | ||
<span class="editsection" style="font-size:76%;"> | <span class="editsection" style="font-size:76%;"> | ||
<nowiki>[</nowiki>[[Description:JCache|Edit Descripton]]<nowiki>]</nowiki> | <nowiki>[</nowiki>[[Description:JCache|Edit Descripton]]<nowiki>]</nowiki> | ||
</span> | </span> | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
===Methods=== | ===Methods=== | ||
{| class="wikitable sortable" | {| class="wikitable sortable" | ||
|- | |- | ||
+ | !Visibility | ||
!Method name | !Method name | ||
!Description | !Description | ||
|- | |- | ||
− | |[[JCache::__construct | + | |public |
+ | |[[API17:JCache::__construct|__construct]] | ||
|Constructor. | |Constructor. | ||
|- | |- | ||
− | |[[JCache::_getStorage | + | |public |
+ | |[[API17:JCache::_getStorage|_getStorage]] | ||
|Get the cache storage handler. | |Get the cache storage handler. | ||
|- | |- | ||
− | |[[JCache::clean | + | |public |
+ | |[[API17:JCache::clean|clean]] | ||
|Clean cache for a group given a mode. | |Clean cache for a group given a mode. | ||
|- | |- | ||
− | |[[JCache::gc | + | |public |
+ | |[[API17:JCache::gc|gc]] | ||
|Garbage collect expired cache data. | |Garbage collect expired cache data. | ||
|- | |- | ||
− | |[[JCache::get | + | |public |
+ | |[[API17:JCache::get|get]] | ||
|Get cached data by id and group. | |Get cached data by id and group. | ||
|- | |- | ||
− | |[[JCache::getAll | + | |public |
+ | |[[API17:JCache::getAll|getAll]] | ||
|Get a list of all cached data. | |Get a list of all cached data. | ||
|- | |- | ||
− | |[[JCache::getCaching | + | |public |
+ | |[[API17:JCache::getCaching|getCaching]] | ||
|Get caching state. | |Get caching state. | ||
|- | |- | ||
− | |[[JCache::lock | + | |public |
+ | |[[API17:JCache::lock|lock]] | ||
|Set lock flag on cached item. | |Set lock flag on cached item. | ||
|- | |- | ||
− | |[[JCache::remove | + | |public |
+ | |[[API17:JCache::remove|remove]] | ||
|Remove a cached data entry by id and group. | |Remove a cached data entry by id and group. | ||
|- | |- | ||
− | |[[JCache::setCaching | + | |public |
+ | |[[API17:JCache::setCaching|setCaching]] | ||
|Set caching enabled state. | |Set caching enabled state. | ||
|- | |- | ||
− | |[[JCache::setLifeTime | + | |public |
+ | |[[API17:JCache::setLifeTime|setLifeTime]] | ||
|Set cache lifetime. | |Set cache lifetime. | ||
|- | |- | ||
− | |[[JCache::store | + | |public |
+ | |[[API17:JCache::store|store]] | ||
|Store the cached data by id and group. | |Store the cached data by id and group. | ||
|- | |- | ||
− | |[[JCache::unlock | + | |public |
+ | |[[API17:JCache::unlock|unlock]] | ||
|Unset lock flag on cached item. | |Unset lock flag on cached item. | ||
|- | |- | ||
− | |[[JCache::addIncludePath | + | |public static |
+ | |[[API17:JCache::addIncludePath|addIncludePath]] | ||
|Add a directory where should search for handlers. | |Add a directory where should search for handlers. | ||
|- | |- | ||
− | |[[JCache::getInstance | + | |public static |
+ | |[[API17:JCache::getInstance|getInstance]] | ||
|Returns a reference to a cache adapter object, always creating it. | |Returns a reference to a cache adapter object, always creating it. | ||
|- | |- | ||
− | |[[JCache::getStores | + | |public static |
+ | |[[API17:JCache::getStores|getStores]] | ||
|Get the storage handlers. | |Get the storage handlers. | ||
|- | |- | ||
− | |[[JCache::getWorkarounds | + | |public static |
+ | |[[API17:JCache::getWorkarounds|getWorkarounds]] | ||
|Perform workarounds on retrieved cached data. | |Perform workarounds on retrieved cached data. | ||
|- | |- | ||
− | |[[JCache::makeId | + | |public static |
+ | |[[API17:JCache::makeId|makeId]] | ||
|Create safe id for cached data from url parameters set by plugins and framework. | |Create safe id for cached data from url parameters set by plugins and framework. | ||
|- | |- | ||
− | |[[JCache::setWorkarounds | + | |public static |
+ | |[[API17:JCache::setWorkarounds|setWorkarounds]] | ||
|Create workarounded data to be cached. | |Create workarounded data to be cached. | ||
|- | |- | ||
|} | |} | ||
+ | * '''Defined in''' libraries/joomla/cache/cache.php | ||
+ | * '''Extends''' [[API17:JObject|JObject]] | ||
===Importing=== | ===Importing=== | ||
<source lang="php">jimport( 'joomla.cache.cache' );</source> | <source lang="php">jimport( 'joomla.cache.cache' );</source> | ||
===See also=== | ===See also=== | ||
− | * [[JCache|Other versions of | + | * {{JVer|11.1}} '''JCache source code''' on [[jplatform:cache/cache.php|BitBucket]] |
+ | * {{JVer|11.1}} Subpackage [[API17:Subpackage Cache|Cache]] | ||
+ | * [[API17:JCache|Other versions of JCache]] | ||
{{SeeAlso:JCache}} | {{SeeAlso:JCache}} | ||
<span class="editsection" style="font-size:76%;"> | <span class="editsection" style="font-size:76%;"> | ||
<nowiki>[</nowiki>[[SeeAlso:JCache|Edit See Also]]<nowiki>]</nowiki> | <nowiki>[</nowiki>[[SeeAlso:JCache|Edit See Also]]<nowiki>]</nowiki> | ||
</span> | </span> | ||
− | === | + | ===User contributed notes=== |
<CodeExamplesForm /> | <CodeExamplesForm /> | ||
<dpl> | <dpl> | ||
Line 91: | Line 110: | ||
category=ClassExample | category=ClassExample | ||
include=* | include=* | ||
+ | namespace=CodeExample | ||
format= ,,, | format= ,,, | ||
</dpl> | </dpl> | ||
− | <noinclude> | + | <noinclude>[[Category:Platform 11.1]][[Category:Archived pages API17]]</noinclude> |
Revision as of 19:48, 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.
JCache[edit]
Description[edit]
Template:Description:JCache [Edit Descripton]
Methods[edit]
Visibility | Method name | Description |
---|---|---|
public | __construct | Constructor. |
public | _getStorage | Get the cache storage handler. |
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 a list of all cached data. |
public | getCaching | Get caching state. |
public | lock | Set lock flag on cached item. |
public | remove | Remove a cached data entry by id and group. |
public | setCaching | Set caching enabled state. |
public | setLifeTime | Set cache lifetime. |
public | store | Store the cached data by id and group. |
public | unlock | Unset lock flag on cached item. |
public static | addIncludePath | Add a directory where should search for handlers. |
public static | getInstance | Returns a reference to a cache adapter object, always creating it. |
public static | getStores | Get the storage handlers. |
public static | getWorkarounds | Perform workarounds on retrieved cached data. |
public static | makeId | Create safe id for cached data from url parameters set by plugins and framework. |
public static | setWorkarounds | Create workarounded data to be cached. |
- Defined in libraries/joomla/cache/cache.php
- Extends JObject
Importing[edit]
jimport( 'joomla.cache.cache' );
See also[edit]
- JCache source code on BitBucket
- Subpackage Cache
- Other versions of JCache
Template:SeeAlso:JCache [Edit See Also]
User contributed notes[edit]
<CodeExamplesForm />