API17:JCacheStorage

From Joomla! Documentation
(Difference between revisions)
Jump to: navigation, search
(Layout updates)
m (→‎User contributed notes: bad link repair)
(One intermediate revision by one user not shown)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
 +
=={{JVer|11.1}} 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>
−
{{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===
 
===Methods===
 
{| class="wikitable sortable"
 
{| class="wikitable sortable"
 
|-
 
|-
 +
!Visibility
 
!Method name
 
!Method name
 
!Description
 
!Description
 
|-
 
|-
 +
|public
 
|[[JCacheStorage::__construct/11.1|__construct]]
 
|[[JCacheStorage::__construct/11.1|__construct]]
 
|Constructor.  
 
|Constructor.  
 
|-
 
|-
 +
|public
 
|[[JCacheStorage::clean/11.1|clean]]
 
|[[JCacheStorage::clean/11.1|clean]]
 
|Clean cache for a group given a mode.  
 
|Clean cache for a group given a mode.  
 
|-
 
|-
 +
|public
 
|[[JCacheStorage::gc/11.1|gc]]
 
|[[JCacheStorage::gc/11.1|gc]]
 
|Garbage collect expired cache data.  
 
|Garbage collect expired cache data.  
 
|-
 
|-
 +
|public
 
|[[JCacheStorage::get/11.1|get]]
 
|[[JCacheStorage::get/11.1|get]]
 
|Get cached data by id and group.  
 
|Get cached data by id and group.  
 
|-
 
|-
 +
|public
 
|[[JCacheStorage::getAll/11.1|getAll]]
 
|[[JCacheStorage::getAll/11.1|getAll]]
 
|Get all cached data.  
 
|Get all cached data.  
 
|-
 
|-
 +
|public
 
|[[JCacheStorage::lock/11.1|lock]]
 
|[[JCacheStorage::lock/11.1|lock]]
 
|Lock cached item.  
 
|Lock cached item.  
 
|-
 
|-
 +
|public
 
|[[JCacheStorage::remove/11.1|remove]]
 
|[[JCacheStorage::remove/11.1|remove]]
 
|Remove a cached data entry by id and group.  
 
|Remove a cached data entry by id and group.  
 
|-
 
|-
 +
|public
 
|[[JCacheStorage::store/11.1|store]]
 
|[[JCacheStorage::store/11.1|store]]
 
|Store the data to cache by id and group.  
 
|Store the data to cache by id and group.  
 
|-
 
|-
 +
|public
 
|[[JCacheStorage::unlock/11.1|unlock]]
 
|[[JCacheStorage::unlock/11.1|unlock]]
 
|Unlock cached item.  
 
|Unlock cached item.  
 
|-
 
|-
 +
|public static
 
|[[JCacheStorage::addIncludePath/11.1|addIncludePath]]
 
|[[JCacheStorage::addIncludePath/11.1|addIncludePath]]
 
|Add a directory where  should search for handlers.  
 
|Add a directory where  should search for handlers.  
 
|-
 
|-
 +
|public static
 
|[[JCacheStorage::getInstance/11.1|getInstance]]
 
|[[JCacheStorage::getInstance/11.1|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
 
|[[JCacheStorage::test/11.1|test]]
 
|[[JCacheStorage::test/11.1|test]]
 
|Test to see if the storage handler is available.  
 
|Test to see if the storage handler is available.  
 
|-
 
|-
 +
|protected
 
|[[JCacheStorage::_getCacheId/11.1|_getCacheId]]
 
|[[JCacheStorage::_getCacheId/11.1|_getCacheId]]
 
|Get a cache_id string from an id/group pair.  
 
|Get a cache_id string from an id/group pair.  
 
|-
 
|-
 
|}
 
|}
 +
* '''Defined in''' libraries/joomla/cache/storage.php
 +
* '''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]]
 
===Importing===
 
===Importing===
 
<source lang="php">jimport( 'joomla.cache.storage' );</source>
 
<source lang="php">jimport( 'joomla.cache.storage' );</source>
 
===See also===
 
===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 [[Subpackage Cache/11.1|Cache]]
 +
* [[JCacheStorage|Other versions of JCacheStorage]]
 
{{SeeAlso: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>
−
===Examples===
+
===User contributed notes===
 
<CodeExamplesForm />
 
<CodeExamplesForm />
 
<dpl>
 
<dpl>
Line 81: Line 93:
 
category=ClassExample
 
category=ClassExample
 
include=*
 
include=*
 +
namespace=CodeExample
 
format= ,,,
 
format= ,,,
 
</dpl>
 
</dpl>
−
<noinclude>[[Category:Platform]][[Category:Platform 11.1]][[Category:JCacheStorage]]</noinclude>
+
<noinclude>[[Category:Platform JClasses]][[Category:Platform 11.1]][[Category:JCacheStorage]]</noinclude>

Revision as of 13:30, 29 August 2012

Replacement filing cabinet.png
This Namespace has been archived - Please Do Not Edit or Create Pages in this namespace. Pages contain information for a Joomla! version which is no longer supported. It exists only as a historical reference, will not be improved and its content may be incomplete.

Joomla 11.1 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 [Edit Descripton]

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.

Importing

jimport( 'joomla.cache.storage' );

See also

SeeAlso:JCacheStorage [Edit See Also]

User contributed notes

<CodeExamplesForm />


Retrieved from "http://docs.joomla.org/index.php?title=API17:JCacheStorage&oldid=72239"
Personal tools
Namespaces

Variants
Actions
Navigation
Joomla! Sites
Toolbox