Joomla! API

Download
Launch

JCacheControllerCallback

Extends \JCacheController

Joomla! Cache callback type object

package

Joomla.Platform
subpackage

Cache
since

11.1

Methods

__call

Magic method to proxy JCacheControllerMethods

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

11.1

Arguments

$name

stringName of the function

$arguments

arrayArray of arguments for the function

Response

mixed

__construct

Constructor

__construct(array $options)
inherited
since

11.1

Arguments

$options

arrayArray of options

_makeId

Generate a callback cache id

_makeId(callback $callback, array $args) : string
since

11.1

Arguments

$callback

callbackCallback to cache

$args

arrayArguments to the callback method to cache

Response

stringMD5 Hash : function cache id

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
inherited static
since

11.1

Arguments

$path

stringA path to search.

Response

arrayAn array with directory elements

call

Executes a cacheable callback if not found in cache else returns cached output and result

call() : mixed

Since arguments to this function are read with func_get_args you can pass any number of arguments to this method as long as the first argument passed is the callback definition.

The callback definition can be in several forms:

  • Standard PHP Callback array see http://php.net/callback [recommended]
  • Function name as a string eg. 'foo' for function foo()
  • Static method name as a string eg. 'MyClass::myMethod' for method myMethod() of class MyClass
since

11.1

Response

mixedResult of the callback

get

Get stored cached data by id and group

get(string $id, string $group = null) : mixed
inherited
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
inherited 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
inherited
since

11.1

Arguments

$enabled

booleanTrue to enable caching

setLifeTime

Set cache lifetime

setLifeTime(integer $lt) : void
inherited
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
inherited
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

inherited
since

11.1

Type(s)

\JCache

options

Array of options

inherited
since

11.1

Type(s)

array
  • \ \
  • \ JCacheControllerCallback