CacheController
Public cache handler
| since |
1.7.0 |
|---|---|
| note |
As of 4.0 this class will be abstract |
Methods
__call
Magic method to proxy CacheController method calls to Cache
__call(string $name, array $arguments) : mixed
| since |
1.7.0 |
|---|
Arguments
- $name
stringName of the function- $arguments
arrayArray of arguments for the function
Response
mixed
__construct
Constructor
__construct(array $options)
| since |
1.7.0 |
|---|
Arguments
- $options
arrayArray of options
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 |
1.7.0 |
|---|
Arguments
- $path
array|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 |
1.7.0 |
|---|---|
| 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 |
1.7.0 |
|---|---|
| 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 |
1.7.0 |
|---|---|
| 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
Properties
options
Array of options
| since |
1.7.0 |
|---|
Type(s)
array