CacheController

Public cache handler

since

1.7.0

note

As of 4.0 this class will be abstract

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

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
static deprecated
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

getInstance

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

getInstance( type = 'output', mixed||string|int options = []) : \Joomla\CMS\Cache\CacheController
static deprecated
since

1.7.0

throws

RuntimeException

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

CacheController

Properties

cache

Cache object

since

1.7.0

Type(s)

Cache

options

Array of options

since

1.7.0

Type(s)

array<string|int, mixed>