JCacheStorage: Difference between revisions

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' );

User contributed notes

Code Examples

@@ Line 1: / Line 1: @@
 __NOTOC__
-<span class="editsection" style="font-size:76%;">
+=={{JVer|11.1}} JCacheStorage==
-<nowiki>[</nowiki>[[Description:JCacheStorage|Edit Descripton]]<nowiki>]</nowiki>
+===Description===
-</span>
+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
-{{Description:JCacheStorage}}
-===Defined in===
-libraries/joomla/cache/storage.php
-* see source code in [[jplatform:cache/storage.php|BitBucket]]
-===Subpackage===
-[[Subpackage Cache/11.1|Cache]]
-===Extends===
-===Extended by===
-* [[JCacheStorageApc/11.1|JCacheStorageApc]]
-* [[JCacheStorageCachelite/11.1|JCacheStorageCachelite]]
-* [[JCacheStorageEaccelerator/11.1|JCacheStorageEaccelerator]]
-* [[JCacheStorageFile/11.1|JCacheStorageFile]]
-* [[JCacheStorageMemcache/11.1|JCacheStorageMemcache]]
-* [[JCacheStorageWincache/11.1|JCacheStorageWincache]]
-* [[JCacheStorageXcache/11.1|JCacheStorageXcache]]
 ===Methods===
 {| class="wikitable sortable"
 |-
+!Visibility
 !Method name
 !Description
 |-
-|[[JCacheStorage::__construct/11.1|__construct]]
+|public
+|[[API17:JCacheStorage::__construct|__construct]]
 |Constructor.
 |-
-|[[JCacheStorage::clean/11.1|clean]]
+|public
+|[[API17:JCacheStorage::clean|clean]]
 |Clean cache for a group given a mode.
 |-
-|[[JCacheStorage::gc/11.1|gc]]
+|public
+|[[API17:JCacheStorage::gc|gc]]
 |Garbage collect expired cache data.
 |-
-|[[JCacheStorage::get/11.1|get]]
+|public
+|[[API17:JCacheStorage::get|get]]
 |Get cached data by id and group.
 |-
-|[[JCacheStorage::getAll/11.1|getAll]]
+|public
+|[[API17:JCacheStorage::getAll|getAll]]
 |Get all cached data.
 |-
-|[[JCacheStorage::lock/11.1|lock]]
+|public
+|[[API17:JCacheStorage::lock|lock]]
 |Lock cached item.
 |-
-|[[JCacheStorage::remove/11.1|remove]]
+|public
+|[[API17:JCacheStorage::remove|remove]]
 |Remove a cached data entry by id and group.
 |-
-|[[JCacheStorage::store/11.1|store]]
+|public
+|[[API17:JCacheStorage::store|store]]
 |Store the data to cache by id and group.
 |-
-|[[JCacheStorage::unlock/11.1|unlock]]
+|public
+|[[API17:JCacheStorage::unlock|unlock]]
 |Unlock cached item.
 |-
-|[[JCacheStorage::addIncludePath/11.1|addIncludePath]]
+|public static
+|[[API17:JCacheStorage::addIncludePath|addIncludePath]]
 |Add a directory where  should search for handlers.
 |-
-|[[JCacheStorage::getInstance/11.1|getInstance]]
+|public static
+|[[API17:JCacheStorage::getInstance|getInstance]]
 |Returns a cache storage handler object, only creating it if it doesn't already exist.
 |-
-|[[JCacheStorage::test/11.1|test]]
+|public static
+|[[API17:JCacheStorage::test|test]]
 |Test to see if the storage handler is available.
 |-
-|[[JCacheStorage::_getCacheId/11.1|_getCacheId]]
+|protected
+|[[API17:JCacheStorage::_getCacheId|_getCacheId]]
 |Get a cache_id string from an id/group pair.
 |-
 |}
+* '''Defined in''' libraries/joomla/cache/storage.php
+* '''Extended by'''
+** [[API17:JCacheStorageApc|JCacheStorageApc]]
+** [[API17:JCacheStorageCachelite|JCacheStorageCachelite]]
+** [[API17:JCacheStorageEaccelerator|JCacheStorageEaccelerator]]
+** [[API17:JCacheStorageFile|JCacheStorageFile]]
+** [[API17:JCacheStorageMemcache|JCacheStorageMemcache]]
+** [[API17:JCacheStorageWincache|JCacheStorageWincache]]
+** [[API17:JCacheStorageXcache|JCacheStorageXcache]]
 ===Importing===
 <source lang="php">jimport( 'joomla.cache.storage' );</source>
 ===See also===
-* JCacheStorage source code in [[jplatform:cache/storage.php|BitBucket]]
+* {{JVer|11.1}} '''JCacheStorage source code''' on [[jplatform:cache/storage.php|BitBucket]]
-* [[JCacheStorage|Other versions of this class]]
+* {{JVer|11.1}} Subpackage [[API17:Subpackage Cache|Cache]]
-{{SeeAlso:JCacheStorage}}
+* [[API17:JCacheStorage|Other versions of JCacheStorage]]
-<span class="editsection" style="font-size:76%;">
-<nowiki>[</nowiki>[[SeeAlso:JCacheStorage|Edit See Also]]<nowiki>]</nowiki>
-</span>
+===User contributed notes===
-===Examples===
+=== Code Examples ===
-<CodeExamplesForm />
 <dpl>
 noresultsheader=\n
 category=JCacheStorage
-category=CodeExample
+namespace=CodeExample
 category=ClassExample
 include=*
+namespace=CodeExample
 format= ,,,
 </dpl>
-<noinclude>[[Category:Platform]][[Category:Platform 11.1]][[Category:JCacheStorage]]</noinclude>
+<noinclude>[[Category:Platform 11.1]][[Category:Archived pages API17]]</noinclude>

API17