API17

JCacheStorageXcache: Difference between revisions

From Joomla! Documentation

Doxiki2 (talk | contribs)
Layout updates
Doxiki2 (talk | contribs)
Updated to r1448:247ba8d88526
Line 1: Line 1:
__NOTOC__
__NOTOC__
=={{JVer|11.1}} JCacheStorageXcache==
===Description===
{{Description:JCacheStorageXcache}}
<span class="editsection" style="font-size:76%;">
<span class="editsection" style="font-size:76%;">
<nowiki>[</nowiki>[[Description:JCacheStorageXcache|Edit Descripton]]<nowiki>]</nowiki>
<nowiki>[</nowiki>[[Description:JCacheStorageXcache|Edit Descripton]]<nowiki>]</nowiki>
</span>
</span>
{{Description:JCacheStorageXcache}}
===Defined in===
libraries/joomla/cache/storage/xcache.php
* see source code in [[jplatform:cache/storage/xcache.php|BitBucket]]
===Subpackage===
[[Subpackage Cache/11.1|Cache]]
===Extends===
[[JCacheStorage/11.1|JCacheStorage]]
===Extended by===
===Methods===
===Methods===
{| class="wikitable sortable"
{| class="wikitable sortable"
|-
|-
!Visibility
!Method name
!Method name
!Description
!Description
|-
|-
|public
|[[JCacheStorageXcache::clean/11.1|clean]]
|[[JCacheStorageXcache::clean/11.1|clean]]
|Clean cache for a group given a mode.  
|Clean cache for a group given a mode.  
|-
|-
|public
|[[JCacheStorageXcache::gc/11.1|gc]]
|[[JCacheStorageXcache::gc/11.1|gc]]
|Garbage collect expired cache data.  
|Garbage collect expired cache data.  
|-
|-
|public
|[[JCacheStorageXcache::get/11.1|get]]
|[[JCacheStorageXcache::get/11.1|get]]
|Get cached data by id and group.  
|Get cached data by id and group.  
|-
|-
|public
|[[JCacheStorageXcache::getAll/11.1|getAll]]
|[[JCacheStorageXcache::getAll/11.1|getAll]]
|Get all cached data.  
|Get all cached data.  
|-
|-
|public
|[[JCacheStorageXcache::remove/11.1|remove]]
|[[JCacheStorageXcache::remove/11.1|remove]]
|Remove a cached data entry by id and group.  
|Remove a cached data entry by id and group.  
|-
|-
|public
|[[JCacheStorageXcache::store/11.1|store]]
|[[JCacheStorageXcache::store/11.1|store]]
|Store the data by id and group.  
|Store the data by id and group.  
|-
|-
|public static
|[[JCacheStorageXcache::test/11.1|test]]
|[[JCacheStorageXcache::test/11.1|test]]
|Test to see if the cache storage is available.  
|Test to see if the cache storage is available.  
|-
|-
|}
|}
* '''Defined in''' libraries/joomla/cache/storage/xcache.php
* '''Extends''' [[JCacheStorage/11.1|JCacheStorage]]
===Importing===
===Importing===
<source lang="php">jimport( 'joomla.cache.storage.xcache' );</source>
<source lang="php">jimport( 'joomla.cache.storage.xcache' );</source>
===See also===
===See also===
* JCacheStorageXcache source code in [[jplatform:cache/storage/xcache.php|BitBucket]]
* {{JVer|11.1}} '''JCacheStorageXcache source code''' on [[jplatform:cache/storage/xcache.php|BitBucket]]
* [[JCacheStorageXcache|Other versions of this class]]
* {{JVer|11.1}} Subpackage [[Subpackage Cache/11.1|Cache]]
* [[JCacheStorageXcache|Other versions of JCacheStorageXcache]]
{{SeeAlso:JCacheStorageXcache}}
{{SeeAlso:JCacheStorageXcache}}
<span class="editsection" style="font-size:76%;">
<span class="editsection" style="font-size:76%;">
<nowiki>[</nowiki>[[SeeAlso:JCacheStorageXcache|Edit See Also]]<nowiki>]</nowiki>
<nowiki>[</nowiki>[[SeeAlso:JCacheStorageXcache|Edit See Also]]<nowiki>]</nowiki>
</span>
</span>
===Examples===
===User contributed notes===
<CodeExamplesForm />
<CodeExamplesForm />
<dpl>
<dpl>
Line 57: Line 62:
category=ClassExample
category=ClassExample
include=*
include=*
namespace=CodeExample
format= ,,,
format= ,,,
</dpl>
</dpl>
<noinclude>[[Category:Platform]][[Category:Platform 11.1]][[Category:JCacheStorageXcache]]</noinclude>
<noinclude>[[Category:Platform]][[Category:Platform 11.1]][[Category:JCacheStorageXcache]]</noinclude>

Revision as of 22:57, 27 April 2011

Joomla 11.1 JCacheStorageXcache

Description

Template:Description:JCacheStorageXcache [Edit Descripton]

Methods

Visibility Method name Description
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 remove Remove a cached data entry by id and group.
public store Store the data by id and group.
public static test Test to see if the cache storage is available.
  • Defined in libraries/joomla/cache/storage/xcache.php
  • Extends JCacheStorage

Importing

jimport( 'joomla.cache.storage.xcache' );

See also

Template:SeeAlso:JCacheStorageXcache [Edit See Also]

User contributed notes

<CodeExamplesForm />