1. class
  2. Joomla
  3. CMS
  4. Cache
  5. Controller
  6. OutputController

OutputController

class OutputController extends CacheController

Joomla Cache output type object

Properties

Cache $cache Cache object from CacheController
array $options Array of options from CacheController

Methods

__construct( array $options)

Constructor

from CacheController
mixed
__call( string $name, array $arguments)

Magic method to proxy CacheController method calls to Cache

from CacheController
static  CacheController
getInstance( string $type = 'output', array $options = array())

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

from CacheController
static  array
addIncludePath( array|string $path = '')

Add a directory where Cache should search for controllers. You may either pass a string or an array of directories.

from CacheController
mixed
get( string $id, string $group = null)

Get stored cached data by ID and group

boolean
store( mixed $data, string $id, string $group = null, boolean $wrkarounds = true)

Store data to cache by ID and group

boolean
start( string $id, string $group = null)

Start the cache

boolean
end()

Stop the cache buffer and store the cached data

Details

__construct( array $options)

Constructor

Parameters

array $options Array of options

mixed __call( string $name, array $arguments)

Magic method to proxy CacheController method calls to Cache

Parameters

string $name Name of the function
array $arguments Array of arguments for the function

Return Value

mixed

static CacheController getInstance( string $type = 'output', array $options = array())

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

Parameters

string $type The cache object type to instantiate; default is output.
array $options Array of options

Return Value

CacheController

Exceptions

RuntimeException

static array addIncludePath( array|string $path = '')

Add a directory where Cache should search for controllers. You may either pass a string or an array of directories.

Parameters

array|string $path A path to search.

Return Value

array An array with directory elements

mixed get( string $id, string $group = null)

Get stored cached data by ID and group

Parameters

string $id The cache data ID
string $group The cache data group

Return Value

mixed Boolean false on no result, cached object otherwise

boolean store( mixed $data, string $id, string $group = null, boolean $wrkarounds = true)

Store data to cache by ID and group

Parameters

mixed $data The data to store
string $id The cache data ID
string $group The cache data group
boolean $wrkarounds True to use wrkarounds

Return Value

boolean True if cache stored

boolean start( string $id, string $group = null)

Start the cache

Parameters

string $id The cache data ID
string $group The cache data group

Return Value

boolean

boolean end()

Stop the cache buffer and store the cached data

Return Value

boolean True if the cache data was stored