Référence de la classe JCache

Graphe d'héritage de JCache:

Graphe de collaboration de JCache:

Liste de tous les membres

Fonctions membres publiques

• __construct ($options)
• getStores ()
• setCaching ($enabled)
• setLifeTime ($lt)
• setCacheValidation ()
• get ($id, $group=null)
• store ($data, $id, $group=null)
• remove ($id, $group=null)
• clean ($group=null, $mode='group')
• gc ()
• & _getStorage ()

Fonctions membres publiques statiques

• & getInstance ($type= 'output', $options=array())

Attributs publics

• $_handler
• $_options

---

Documentation des constructeurs et destructeur

JCache::__construct

(

$

options

)

Constructor

protected

Paramètres:

array

$options

options

---

Documentation des fonctions membres

& JCache::_getStorage

(

)

Get the cache storage handler

protected

Renvoie:

object A JCacheStorage object

Depuis:

1.5

Références JCacheStorage::getInstance().

Voici le graphe d'appel pour cette fonction :

JCache::clean	(	$	group = null,
		$	mode = 'group'
	)

Clean cache for a group given a mode.

group mode : cleans all cache in the group notgroup mode : cleans all cache not in the group

public

Paramètres:

string	$group	The cache data group
string	$mode	The mode for cleaning cache [group|notgroup]

Renvoie:

boolean True on success, false otherwise

Depuis:

1.5

Références JError::isError().

Voici le graphe d'appel pour cette fonction :

JCache::gc

(

)

Garbage collect expired cache data

public

Renvoie:

boolean True on success, false otherwise.

Depuis:

1.5

Références JError::isError().

Voici le graphe d'appel pour cette fonction :

JCache::get	(	$	id,
		$	group = null
	)

Get cached data by id and group

public

Paramètres:

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

Renvoie:

mixed Boolean false on failure or a cached data string

Depuis:

1.5

Réimplémentée à partir de JObject.

Réimplémentée dans JCachePage.

Références JError::isError().

Voici le graphe d'appel pour cette fonction :

& JCache::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

Renvoie:

object A JCache object

Depuis:

1.5

Références $class, $path, $type, et JError::raiseError().

Référencé par JFactory::getCache(), et plgSystemCache::plgSystemCache().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

JCache::getStores

(

)

Get the storage handlers

public

Renvoie:

array An array of available storage handlers

Références $class, $name, JFolder::files(), et jimport().

Référencé par ConfigControllerApplication::showConfig().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

JCache::remove	(	$	id,
		$	group = null
	)

Remove a cached data entry by id and group

public

Paramètres:

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

Renvoie:

boolean True on success, false otherwise

Depuis:

1.5

Références JError::isError().

Voici le graphe d'appel pour cette fonction :

JCache::setCacheValidation

(

)

Set cache validation

public

Renvoie:

void

Depuis:

1.5

JCache::setCaching

(

$

enabled

)

Set caching enabled state

public

Paramètres:

boolean

$enabled

True to enable caching

Renvoie:

void

Depuis:

1.5

JCache::setLifeTime

(

$

lt

)

Set cache lifetime

public

Paramètres:

int

$lt

Cache lifetime

Renvoie:

void

Depuis:

1.5

JCache::store	(	$	data,
		$	id,
		$	group = null
	)

Store the cached data by id and group

public

Paramètres:

string	$id	The cache data id
string	$group	The cache data group
mixed	$data	The data to store

Renvoie:

boolean True if cache stored

Depuis:

1.5

Références $data, et JError::isError().

Voici le graphe d'appel pour cette fonction :

---

Documentation des données membres

JCache::$_handler

JCache::$_options

---

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

• libraries/joomla/cache/cache.php