JCacheController

Public cache handler

package

Joomla.Platform

subpackage

Cache

since

11.1

Methods

__call

Magic method to proxy JCacheControllerMethods

__call(string $name, array $arguments) : mixed
since

11.1

Arguments

$name

stringName of the function

$arguments

arrayArray of arguments for the function

Response

mixed

__construct

Constructor

__construct(array $options) 
since

11.1

Arguments

$options

arrayArray of options

addIncludePath

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

addIncludePath(string $path = '') : array
static
since

11.1

Arguments

$path

stringA path to search.

Response

arrayAn array with directory elements

get

Get stored cached data by id and group

get(string $id, string $group = null) : mixed
since

11.1

Arguments

$id

stringThe cache data id

$group

stringThe cache data group

Response

mixedFalse on no result, cached object otherwise

getInstance

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

getInstance(string $type = 'output', array $options = array()) : \JCache
static
since

11.1

Arguments

$type

stringThe cache object type to instantiate; default is output.

$options

arrayArray of options

Response

\JCacheA JCache object

setCaching

Set caching enabled state

setCaching(boolean $enabled) : void
since

11.1

Arguments

$enabled

booleanTrue to enable caching

setLifeTime

Set cache lifetime

setLifeTime(integer $lt) : void
since

11.1

Arguments

$lt

integerCache lifetime

store

Store data to cache by id and group

store(mixed $data, string $id, string $group = null) : boolean
since

11.1

Arguments

$data

mixedThe data to store

$id

stringThe cache data id

$group

stringThe cache data group

Response

booleanTrue if cache was stored

Properties

cache

since

11.1

Type(s)

\JCache

options

Array of options

since

11.1

Type(s)

array