Class JCacheController

Public cache handler

Direct known subclasses

JCacheControllerCallback, JCacheControllerOutput, JCacheControllerPage, JCacheControllerView

Package: Joomla\Platform\Cache
Copyright: Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved.
License: General Public License version 2 or later; see LICENSE
Since: 11.1
Note: As of 4.0 this class will be abstract
Located at joomla/cache/controller.php

Methods summary

`public`	# `__construct( array $options )` Constructor Constructor Parameters `$options` `array` - $options Array of options Since 11.1
`public mixed`	# `__call( string $name, array $arguments )` Magic method to proxy JCacheController method calls to JCache Magic method to proxy JCacheController method calls to JCache Parameters `$name` `string` - $name Name of the function `$arguments` `array` - $arguments Array of arguments for the function Returns `mixed` Since 11.1
`public static JCacheController`	# `getInstance( string $type = 'output', array $options = array() )` Returns a reference to a cache adapter object, always creating it Returns a reference to a cache adapter object, always creating it Parameters `$type` `string` - $type The cache object type to instantiate; default is output. `$options` `array` - $options Array of options Returns `JCacheController` Throws `RuntimeException` Since 11.1
`public static array`	# `addIncludePath( array\|string $path = '' )` Add a directory where JCache should search for controllers. You may either pass a string or an array of directories. Add a directory where JCache should search for controllers. You may either pass a string or an array of directories. Parameters `$path` `array\|string` - $path A path to search. Returns `array` - An array with directory elements Since 11.1
`public mixed`	# `get( string $id, string $group = null )` Get stored cached data by ID and group Get stored cached data by ID and group Deprecated 4.0 Implement own method in subclass Parameters `$id` `string` - $id The cache data ID `$group` `string` - $group The cache data group Returns `mixed` - Boolean false on no result, cached object otherwise Since 11.1
`public boolean`	# `store( mixed $data, string $id, string $group = null, boolean $wrkarounds = true )` Store data to cache by ID and group Store data to cache by ID and group Deprecated 4.0 Implement own method in subclass Parameters `$data` `mixed` - $data The data to store `$id` `string` - $id The cache data ID `$group` `string` - $group The cache data group `$wrkarounds` `boolean` - $wrkarounds True to use wrkarounds Returns `boolean` - True if cache stored Since 11.1

Magic methods summary

Properties summary

`public JCache`	`$cache`	# JCache object JCache object Since 11.1
`public array`	`$options`	# Array of options Array of options Since 11.1

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class JCacheController

Direct known subclasses

Methods summary

Parameters

Since

Parameters

Returns

Since

Parameters

Returns

Throws

Since

Parameters

Returns

Since

Deprecated

Parameters

Returns

Since

Deprecated

Parameters

Returns

Since

Magic methods summary

Properties summary

Since

Since