OutputController

Extends CacheController

Joomla Cache output 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

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

Get stored cached data by ID and group

get(string id, string group = null) : mixed
since

1.7.0

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

1.7.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

_id

Cache data ID

since

1.7.0

Type(s)

string

_group

Cache data group

since

1.7.0

Type(s)

string

cache

Cache object

inherited
since

1.7.0

Type(s)

Cache

options

Array of options

inherited
since

1.7.0

Type(s)

array