CallbackController

Extends CacheController

Joomla! Cache callback type object

since

1.7.0

package

Application

Methods

__call

Magic method to proxy CacheController method calls to Cache

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

1.7.0

Arguments

name

stringName of the function

arguments

arrayArray of arguments for the function

Response

mixed

__construct

Constructor

__construct(array options) : mixed
inherited
since

1.7.0

Arguments

options

arrayArray of options

Response

mixed

_makeId

Generate a callback cache ID

_makeId(mixed callback, array args) : string
since

1.7.0

Arguments

callback

mixedCallback to cache

args

arrayArguments to the callback method to cache

Response

stringMD5 Hash

addIncludePath

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

addIncludePath(array|string path = '') : array
inherited static deprecated
since

1.7.0

deprecated

5.0 Use the cache controller factory instead

Arguments

path

array|stringA path to search.

Response

arrayAn array with directory elements

get

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

get(callable callback, array args = array(), mixed id = false, bool wrkarounds = false, array woptions = array()) : mixed
since

1.7.0

Arguments

callback

callableCallback or string shorthand for a callback

args

arrayCallback arguments

id

mixedCache ID

wrkarounds

boolTrue to use workarounds

woptions

arrayWorkaround options

Response

mixedResult of the callback

getInstance

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

getInstance(string type = 'output', array options = array()) : \Joomla\CMS\Cache\CacheController
inherited static deprecated
since

1.7.0

throws

\RuntimeException

deprecated

5.0 Use the cache controller factory instead

Arguments

type

stringThe cache object type to instantiate; default is output.

options

arrayArray of options

Response

\Joomla\CMS\Cache\CacheController

store

Store data to cache by ID and group

store(mixed data, string id, string group = null, bool wrkarounds = true) : bool
since

4.0.0

Arguments

data

mixedThe data to store

id

stringThe cache data ID

group

stringThe cache data group

wrkarounds

boolTrue to use wrkarounds

Response

boolTrue if cache stored

Properties

cache

Cache object

inherited
since

1.7.0

Type(s)

Cache

options

Array of options

inherited
since

1.7.0

Type(s)

array