JCacheStorage

From Joomla! Documentation
(Difference between revisions)
Jump to: navigation, search
(Extended by)
m (bad link repair)
 
(5 intermediate revisions by 2 users not shown)
Line 1: Line 1:
'''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]]
+
This class is available in the following Joomla versions:-
 
+
<splist showpath=notparent />
===Availability===
+
<noinclude>[[Category:Platform JClasses]][[Category:JCacheStorage]]</noinclude>
{{JVer|1.5|From Joomla 1.5}} {{JVer|1.6|Joomla 1.6}}
+
 
+
===Defined in===
+
/libraries/joomla/cache/cache.php
+
 
+
===Extends===
+
* [[JObject]]
+
 
+
===Extended by===
+
* [[JCacheStorageApc]]
+
* [[JCacheStorageEaccelerator]]
+
* [[JCacheStorageFile]]
+
* [[JCacheStorageMemcache]]
+
* [[JCacheStorageXCache]]
+
* [[JSessionStorageXcache]]
+
 
+
===Methods===
+
{| class="wikitable"
+
|-
+
!Method name
+
!Description
+
|-
+
|[[JCacheStorage/__construct|__construct]]
+
|Sets the storage options.
+
|-
+
|[[JCacheStorage/clean|clean]]
+
|Clean cache for a group. Given a mode. ''Needs to be implemented in a concrete storage handler.''
+
|-
+
|[[JCacheStorage/gc|gc]]
+
|Garbage collect expired cache data. ''Needs to be implemented in a concrete storage handler.''
+
|-
+
|[[JCacheStorage/get|get]]
+
|Get cached data by id and group. ''Needs to be implemented in a concrete storage handler.''
+
|-
+
|[[JCacheStorage/getInstance|getInstance]]
+
|Returns a reference to a concrete cache storage handler object, only creating it, if it doesn't already exist.
+
|-
+
|[[JCacheStorage/remove|remove]]
+
|Remove a cached data entry by id and group. ''Needs to be implemented in a concrete storage handler.''
+
|-
+
|[[JCacheStorage/store|store]]
+
|Store the data to cache by id and group. ''Needs to be implemented in a concrete storage handler.''
+
|-
+
|[[JCacheStorage/test|test]]
+
|Test to see if the storage handler is available. ''Needs to be implemented in a concrete storage handler.''
+
|}
+
 
+
===Importing===
+
<source lang="php">jimport( 'joomla.cache.cache' );</source>
+
 
+
===See also===
+
* [http://api.joomla.org/Joomla-Framework/Cache/JCacheStorage.html JCacheStorage on api.joomla.org]
+
* [[JCache]]
+
 
+
==== Concrete Cache Storage Handlers ====
+
* [[JCacheStorageApc]]
+
* [[JCacheStorageEaccelarator]]
+
* [[JCacheStorageFile]]
+
* [[JCacheStorageMemcache]]
+
* [[JCacheStorageXCache]]
+
* [[JSessionStorageXcache]]
+
 
+
==== Concrete Caching Handlers ====
+
* [[JCacheView]]
+
* [[JCachePage]]
+
* [[JCacheCallback]]
+
* [[JCacheOutput]]
+
<noinclude>[[Category:Development]][[Category:Framework]][[Category:JCacheStorage]]</noinclude>
+

Latest revision as of 13:30, 29 August 2012

This class is available in the following Joomla versions:-

Personal tools
Namespaces

Variants
Actions
Navigation
Joomla! Sites
Toolbox