Actions

API17

Difference between revisions of "JCache"

From Joomla! Documentation

(Bulk upload by Doxiki2)
 
(Layout updates)
Line 6: Line 6:
 
===Defined in===
 
===Defined in===
 
libraries/joomla/cache/cache.php
 
libraries/joomla/cache/cache.php
 +
* see source code in [[jplatform:cache/cache.php|BitBucket]]
 
===Subpackage===
 
===Subpackage===
 
[[Subpackage Cache/11.1|Cache]]
 
[[Subpackage Cache/11.1|Cache]]
Line 78: Line 79:
 
<source lang="php">jimport( 'joomla.cache.cache' );</source>
 
<source lang="php">jimport( 'joomla.cache.cache' );</source>
 
===See also===
 
===See also===
 +
* JCache source code in [[jplatform:cache/cache.php|BitBucket]]
 
* [[JCache|Other versions of this class]]
 
* [[JCache|Other versions of this class]]
 
{{SeeAlso:JCache}}
 
{{SeeAlso:JCache}}

Revision as of 16:50, 23 April 2011

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.

[Edit Descripton] JCache is an abstract class which defines Joomla's basic caching functionality. The class needs to be extended by a concrete cache handler. The Joomla Framework currently provides the handlers JCacheView, JCachePage, JCacheCallback and JCacheOutput

Defined in

libraries/joomla/cache/cache.php

Subpackage

Cache

Extends

JObject

Extended by

Methods

Method name Description
__construct Constructor.
_getStorage Get the cache storage handler.
clean Clean cache for a group given a mode.
gc Garbage collect expired cache data.
get Get cached data by id and group.
getAll Get a list of all cached data.
getCaching Get caching state.
lock Set lock flag on cached item.
remove Remove a cached data entry by id and group.
setCaching Set caching enabled state.
setLifeTime Set cache lifetime.
store Store the cached data by id and group.
unlock Unset lock flag on cached item.
addIncludePath Add a directory where should search for handlers.
getInstance Returns a reference to a cache adapter object, always creating it.
getStores Get the storage handlers.
getWorkarounds Perform workarounds on retrieved cached data.
makeId Create safe id for cached data from url parameters set by plugins and framework.
setWorkarounds Create workarounded data to be cached.

Importing

jimport( 'joomla.cache.cache' );

See also

SeeAlso:JCache [Edit See Also]

Examples

<CodeExamplesForm />