ViewController
Extends CacheControllerJoomla! Cache view type object
| since |
1.7.0 |
|---|---|
| package |
Joomla CMS |
Methods
__call
Magic method to proxy CacheController method calls to Cache
__call( name, mixed||string|int arguments) :
| since |
1.7.0 |
|---|
Arguments
- name
stringName of the function- arguments
array<string|int, mixed>Array of arguments for the function
Response
mixed
__construct
Constructor
__construct(mixed||string|int options) :
| since |
1.7.0 |
|---|
Arguments
- options
array<string|int, mixed>Array of options
Response
mixed
_makeId
Generate a view cache ID.
_makeId( view, method) :
| since |
1.7.0 |
|---|
Arguments
- view
objectThe view object to cache output for- method
stringThe method name to cache for the view object
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 = '') : mixed||string|int
| since |
1.7.0 |
|---|---|
| deprecated |
4.2 will be removed in 6.0 Use the cache controller factory instead Example: Factory::getContainer()->get(CacheControllerFactoryInterface::class)->createCacheController($type, $options); |
Arguments
- path
array<string|int, mixed>|stringA path to search.
Response
array<string|int, mixed>An array with directory elements
get
Get the cached view data
get( view, method = 'display', id = false, wrkarounds = true) :
| since |
1.7.0 |
|---|
Arguments
- view
objectThe view object to cache output for- method
stringThe method name of the view method to cache output for- id
mixedThe cache data ID- wrkarounds
boolTrue to enable workarounds.
Response
boolTrue if the cache is hit (false else)
getInstance
Returns a reference to a cache adapter object, always creating it
getInstance( type = 'output', mixed||string|int options = []) : \Joomla\CMS\Cache\CacheController
| since |
1.7.0 |
|---|---|
| throws |
|
| deprecated |
4.2 will be removed in 6.0 Use the cache controller factory instead Example: Factory::getContainer()->get(CacheControllerFactoryInterface::class)->createCacheController($type, $options); |
Arguments
- type
stringThe cache object type to instantiate; default is output.- options
array<string|int, mixed>Array of options
Response
store
Store data to cache by ID and group
store( data, id, group = null, wrkarounds = true) :
| 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
options
Array of options
| since |
1.7.0 |
|---|
Type(s)
array<string|int, mixed>