CallbackController
Extends \Joomla\CMS\Cache\CacheControllerJoomla! Cache callback type object
| since |
11.1 |
|---|
Methods
__call
Magic method to proxy CacheController method calls to Cache
__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
_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
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
| since |
11.1 |
|---|
Arguments
$path
array|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 https://secure.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 |
|---|---|
| deprecated |
4.0 |
Response
mixedResult of the callback
get
Get stored cached data by ID and group
get(string $id, string $group = null) : mixed
| since |
11.1 |
|---|---|
| deprecated |
4.0 Implement own method in subclass |
Arguments
$id
stringThe cache data ID
$group
stringThe cache data group
Response
mixedBoolean false 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()) : \Joomla\CMS\Cache\CacheController
| since |
11.1 |
|---|---|
| throws |
|
Arguments
$type
stringThe cache object type to instantiate; default is output.
$options
arrayArray of options
Response
store
Store data to cache by ID and group
store(mixed $data, string $id, string $group = null, boolean $wrkarounds = true) : boolean
| since |
11.1 |
|---|---|
| deprecated |
4.0 Implement own method in subclass |
Arguments
$data
mixedThe data to store
$id
stringThe cache data ID
$group
stringThe cache data group
$wrkarounds
booleanTrue to use wrkarounds
Response
booleanTrue if cache stored