JCacheStorage/1.5
From Joomla! Documentation
< JCacheStorage(Difference between revisions)
(Bulk upload by Doxiki2) |
m (→See also: fixing link to API) |
||
| (One intermediate revision by one user not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
| + | =={{JVer|1.5}} JCacheStorage== | ||
| + | ===Description=== | ||
| + | {{Description:JCacheStorage}} | ||
<span class="editsection" style="font-size:76%;"> | <span class="editsection" style="font-size:76%;"> | ||
<nowiki>[</nowiki>[[Description:JCacheStorage|Edit Descripton]]<nowiki>]</nowiki> | <nowiki>[</nowiki>[[Description:JCacheStorage|Edit Descripton]]<nowiki>]</nowiki> | ||
</span> | </span> | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
===Methods=== | ===Methods=== | ||
{| class="wikitable sortable" | {| class="wikitable sortable" | ||
|- | |- | ||
| + | !Visibility | ||
!Method name | !Method name | ||
!Description | !Description | ||
|- | |- | ||
| + | |public | ||
|[[JCacheStorage::__construct/1.5|__construct]] | |[[JCacheStorage::__construct/1.5|__construct]] | ||
|Constructor. | |Constructor. | ||
|- | |- | ||
| + | |public | ||
|[[JCacheStorage::clean/1.5|clean]] | |[[JCacheStorage::clean/1.5|clean]] | ||
|Clean cache for a group given a mode. | |Clean cache for a group given a mode. | ||
|- | |- | ||
| + | |public | ||
|[[JCacheStorage::gc/1.5|gc]] | |[[JCacheStorage::gc/1.5|gc]] | ||
|Garbage collect expired cache data. | |Garbage collect expired cache data. | ||
|- | |- | ||
| + | |public | ||
|[[JCacheStorage::get/1.5|get]] | |[[JCacheStorage::get/1.5|get]] | ||
|Get cached data by id and group. | |Get cached data by id and group. | ||
|- | |- | ||
| + | |public | ||
|[[JCacheStorage::remove/1.5|remove]] | |[[JCacheStorage::remove/1.5|remove]] | ||
|Remove a cached data entry by id and group. | |Remove a cached data entry by id and group. | ||
|- | |- | ||
| + | |public | ||
|[[JCacheStorage::store/1.5|store]] | |[[JCacheStorage::store/1.5|store]] | ||
|Store the data to cache by id and group. | |Store the data to cache by id and group. | ||
|- | |- | ||
| + | |public | ||
|[[JCacheStorage::getInstance/1.5|getInstance]] | |[[JCacheStorage::getInstance/1.5|getInstance]] | ||
|Returns a reference to a cache storage hanlder object, only creating it if it doesn't already exist. | |Returns a reference to a cache storage hanlder object, only creating it if it doesn't already exist. | ||
|- | |- | ||
| + | |public | ||
|[[JCacheStorage::test/1.5|test]] | |[[JCacheStorage::test/1.5|test]] | ||
|Test to see if the storage handler is available. | |Test to see if the storage handler is available. | ||
|- | |- | ||
|} | |} | ||
| + | * '''Defined in''' libraries/joomla/cache/storage.php | ||
| + | * '''Extends''' [[JObject/1.5|JObject]] | ||
| + | * '''Extended by''' | ||
| + | ** [[JCacheStorageApc/1.5|JCacheStorageApc]] | ||
| + | ** [[JCacheStorageEaccelerator/1.5|JCacheStorageEaccelerator]] | ||
| + | ** [[JCacheStorageFile/1.5|JCacheStorageFile]] | ||
| + | ** [[JCacheStorageMemcache/1.5|JCacheStorageMemcache]] | ||
| + | ** [[JCacheStorageXCache/1.5|JCacheStorageXCache]] | ||
===Importing=== | ===Importing=== | ||
<source lang="php">jimport( 'joomla.cache.storage' );</source> | <source lang="php">jimport( 'joomla.cache.storage' );</source> | ||
===See also=== | ===See also=== | ||
| + | * {{JVer|1.5}} '''JCacheStorage''' on [http://api.joomla.org/1.5/Joomla-Framework/Cache/JCacheStorage.html api.joomla.org] | ||
| + | * {{JVer|1.5}} '''JCacheStorage source code''' on [[jframework15:cache/storage.php|JoomlaCode]] | ||
| + | * {{JVer|1.5}} Subpackage [[Subpackage Cache/1.5|Cache]] | ||
| + | * [[JCacheStorage|Other versions of JCacheStorage]] | ||
| + | {{SeeAlso:JCacheStorage}} | ||
<span class="editsection" style="font-size:76%;"> | <span class="editsection" style="font-size:76%;"> | ||
<nowiki>[</nowiki>[[SeeAlso:JCacheStorage|Edit See Also]]<nowiki>]</nowiki> | <nowiki>[</nowiki>[[SeeAlso:JCacheStorage|Edit See Also]]<nowiki>]</nowiki> | ||
</span> | </span> | ||
| − | + | ===User contributed notes=== | |
| − | + | ||
| − | + | ||
| − | === | + | |
<CodeExamplesForm /> | <CodeExamplesForm /> | ||
<dpl> | <dpl> | ||
| Line 64: | Line 73: | ||
category=ClassExample | category=ClassExample | ||
include=* | include=* | ||
| + | namespace=CodeExample | ||
format= ,,, | format= ,,, | ||
</dpl> | </dpl> | ||
<noinclude>[[Category:Framework]][[Category:Framework 1.5]][[Category:JCacheStorage]]</noinclude> | <noinclude>[[Category:Framework]][[Category:Framework 1.5]][[Category:JCacheStorage]]</noinclude> | ||
Latest revision as of 14:15, 13 February 2013
[edit] 
JCacheStorage
[edit] 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 [Edit Descripton]
[edit] 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 | remove | Remove a cached data entry by id and group. |
| public | store | Store the data to cache by id and group. |
| public | getInstance | Returns a reference to a cache storage hanlder object, only creating it if it doesn't already exist. |
| public | test | Test to see if the storage handler is available. |
- Defined in libraries/joomla/cache/storage.php
- Extends JObject
- Extended by
[edit] Importing
jimport( 'joomla.cache.storage' );
[edit] See also
- JCacheStorage on api.joomla.org
- JCacheStorage source code on JoomlaCode
- Subpackage Cache
- Other versions of JCacheStorage
SeeAlso:JCacheStorage [Edit See Also]
[edit] User contributed notes
<CodeExamplesForm />
