Référence de la classe CacheController

Graphe d'héritage de CacheController:

Fonctions membres publiques
	__construct ($options)
	__call ($name, $arguments)
	get ($id, $group=null)
	store ($data, $id, $group=null, $wrkarounds=true)

Fonctions membres publiques statiques
static	getInstance ($type='output', $options=array())
static	addIncludePath ($path='')

Champs de données
	$cache
	$options

Description détaillée

Public cache handler

Depuis

1.7.0

Note

As of 4.0 this class will be abstract

Documentation des constructeurs et destructeur

__construct()

__construct

(

$options

)

Constructor

Paramètres

array

$options

Array of options

Depuis

1.7.0

Références $option, $options, et $value.

Documentation des fonctions membres

__call()

__call	(		$name,
			$arguments
	)

Magic method to proxy CacheController method calls to Cache

Paramètres

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

Renvoie

mixed

Depuis

1.7.0

Références $name.

addIncludePath()

static addIncludePath (   $path = '' )

static

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

Paramètres

array | string

$path

A path to search.

Renvoie

array An array with directory elements

Depuis

1.7.0

Références $path, et JLoader\import().

get()

get	(		$id,
			$group = null
	)

Get stored cached data by ID and group

Paramètres

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

Renvoie

mixed Boolean false on no result, cached object otherwise

Depuis

1.7.0

Obsolète:

4.0 Implement own method in subclass

Références $data, et $id.

getInstance()

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

static

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

Paramètres

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

Renvoie

CacheController

Depuis

1.7.0

Exceptions

Références $class, $options, $path, $type, JLoader\import(), et JLoader\register().

Référencé par Cache\getInstance().

store()

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

Store data to cache by ID and group

Paramètres

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

Renvoie

boolean True if cache stored

Depuis

1.7.0

Obsolète:

4.0 Implement own method in subclass

Références $data, et $id.

Documentation des champs

$cache

$cache

$options

$options

---

La documentation de cette classe a été générée à partir du fichier suivant :

• CacheController.php