Abstract Class JCache

Description
Description | Descendents | Vars (details) | Methods (details)

Abstract class for caching handlers

  • since: 1.1
  • abstract:

Located in /cache/cache.php (line 24) 

Cache_Lite
   |
   --JCache
Direct descendents
Description | Descendents | Vars (details) | Methods (details)
Class Description
class JCacheFunction Class to support function caching
class JCacheHash Class to cache a hash (used for ACL caching)
class JCacheLanguage Class to support language file caching
class JCacheOutput Class to support output caching
class JCachePage Class to support page caching
Variable Summary
Description | Descendants | Vars (details) | Methods (details)
mixed $_defaultGroup
mixed $_validateCache
Method Summary
Description | Descendants | Vars (details) | Methods (details)
JCache JCache ([array $options = array(NULL)])
void cleanCache ([mixed $group = false], [mixed $mode = 'ingroup'])
string generateId (string $data, [string $controlType = 'md5'])
void &getCache ([mixed $group = ''])
database &getInstance ([handler $handler = 'Function'], array $options)
void setCacheValidation (boolean $validateCache)
void setCaching (boolean $enable)
void _construct (array $options)
Variables
Description | Descendents | Vars (details) | Methods (details)
mixed $_defaultGroup = 'JCache' (line 26)
mixed $_validateCache = false (line 27)
Methods
Description | Descendents | Vars (details) Methods (details)
Constructor JCache (line 45)

Constructor

$options is an assoc. To have a look at availables options, see the constructor of the Cache_Lite class in 'Cache_Lite.php'

Comparing to Cache_Lite constructor, there is another option : $options = array( (...) see Cache_Lite constructor 'defaultGroup' => default cache group for function caching (string) );

  • access: public
JCache JCache ([array $options = array(NULL)])
  • array $options: options
cleanCache (line 127)

Cleans the cache

void cleanCache ([mixed $group = false], [mixed $mode = 'ingroup'])
generateId (line 120)

Make a control key with the string containing datas

  • return: control key
  • access: public
string generateId (string $data, [string $controlType = 'md5'])
  • string $data: data
  • string $controlType: type of control 'md5', 'crc32' or 'strlen'
Redefined in descendants as:
getCache (line 148)

Deprecated, use JFactory createCache instead

  • since: 1.1
void &getCache ([mixed $group = ''])
getInstance (line 71)

Returns a reference to the global Cache object, only creating it if it doesn't already exist.

  • return: A database object
  • since: 1.1
database &getInstance ([handler $handler = 'Function'], array $options)
  • handler $handler: The cache handler to instantiate
  • array $options: options
setCacheValidation (line 108)

Enable/disbale cache validation

  • access: public
void setCacheValidation (boolean $validateCache)
  • boolean $validateCache: If true enable cache validation.
setCaching (line 95)

Enable/disbale caching, if caching is enabled

  • access: public
void setCaching (boolean $enable)
  • boolean $enable: If true enable caching.
Redefined in descendants as:
_construct (line 55)

Constructor

  • access: protected
void _construct (array $options)
  • array $options: options
Redefined in descendants as:

Documentation generated on Sat, 4 Feb 2006 14:22:48 +0100 by phpDocumentor 1.3.0RC4