Docs For 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
JCacheControllerOutput	Joomla Cache output type object
JCacheControllerPage	Joomla! Cache page type object
JCacheControllerView	Joomla! Cache view type object

Variable Summary

JCache $cache

array $options

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], [boolean $wrkarounds = true])

mixed __call (string $name, array $arguments)

Variables

JCache $cache (line 27)

JCache object

since: 11.1
access: public

array $options (line 35)

Array of options

since: 11.1
access: public

Methods

static addIncludePath (line 150)

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 getInstance (line 86)

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

return: A JCache object
throws: RuntimeException
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 44)

Constructor

since: 11.1
access: public

JCacheController __construct (array $options)

array $options: Array of options

get (line 176)

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:

JCacheControllerCallback::get() : Executes a cacheable callback if not found in cache else returns cached output and result
JCacheControllerPage::get() : Get the cached page data
JCacheControllerView::get() : Get the cached view data

setCaching (line 121)

Set caching enabled state

since: 11.1
access: public

void setCaching (boolean $enabled)

boolean $enabled: True to enable caching

setLifeTime (line 135)

Set cache lifetime

since: 11.1
access: public

void setLifeTime (integer $lt)

integer $lt: Cache lifetime

store (line 217)

Store data to cache by id and group

return: True if cache stored
since: 11.1
access: public

boolean store (mixed $data, string $id, [string $group = null], [boolean $wrkarounds = true])

mixed $data: The data to store
string $id: The cache data id
string $group: The cache data group
boolean $wrkarounds: True to use wrkarounds

Redefined in descendants as:

JCacheControllerPage::store() : Stop the cache buffer and store the cached data

__call (line 69)

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