Class JCacheController

Description

Public cache handler

  • since: 11.1

Located in /libraries/joomla/cache/controller.php (line 19)


	
			
Direct descendents
Class Description
JCacheControllerCallback Joomla! Cache callback type object
JCacheControllerView Joomla! Cache view type object
JCacheControllerPage Joomla! Cache page type object
JCacheControllerOutput Joomla Cache output type object
Variable Summary
Method Summary
static array addIncludePath ([string $path = ''])
static JCache getInstance ([string $type = 'output'], [array $options = array()])
JCacheController __construct (array $options)
mixed get (string $id, [string $group = null])
void setCaching (boolean $enabled)
void setLifeTime (integer $lt)
boolean store (mixed $data, string $id, [string $group = null])
mixed __call (string $name, array $arguments)
Variables
JCache $cache (line 25)
  • since: 11.1
  • access: public
array $options (line 31)
  • var: Array of options
  • since: 11.1
  • access: public
Methods
static method addIncludePath (line 145)

Add a directory where JCache should search for controllers. You may either pass a string or an array of directories.

  • return: An array with directory elements
  • since: 11.1
  • access: public
static array addIncludePath ([string $path = ''])
  • string $path: A path to search.
static method getInstance (line 81)

Returns a reference to a cache adapter object, always creating it

  • return: A JCache object
  • since: 11.1
  • access: public
static JCache getInstance ([string $type = 'output'], [array $options = array()])
  • string $type: The cache object type to instantiate; default is output.
  • array $options: Array of options
Constructor __construct (line 40)

Constructor

  • since: 11.1
  • access: public
JCacheController __construct (array $options)
  • array $options: Array of options
get (line 171)

Get stored cached data by id and group

  • return: False on no result, cached object otherwise
  • since: 11.1
  • access: public
mixed get (string $id, [string $group = null])
  • string $id: The cache data id
  • string $group: The cache data group

Redefined in descendants as:
setCaching (line 116)

Set caching enabled state

  • since: 11.1
  • access: public
void setCaching (boolean $enabled)
  • boolean $enabled: True to enable caching
setLifeTime (line 130)

Set cache lifetime

  • since: 11.1
  • access: public
void setLifeTime (integer $lt)
  • integer $lt: Cache lifetime
store (line 211)

Store data to cache by id and group

  • return: True if cache was stored
  • since: 11.1
  • access: public
boolean store (mixed $data, string $id, [string $group = null])
  • mixed $data: The data to store
  • string $id: The cache data id
  • string $group: The cache data group

Redefined in descendants as:
__call (line 65)

Magic method to proxy JCacheControllerMethods

  • since: 11.1
  • access: public
mixed __call (string $name, array $arguments)
  • string $name: Name of the function
  • array $arguments: Array of arguments for the function

Documentation generated on Mon, 25 Jun 2012 13:53:44 -0500 by phpDocumentor 1.4.4