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)
	setCaching ($enabled)
	getCaching ()
	setLifeTime ($lt)
	get ($id, $group=null)
	getAll ()
	store ($data, $id, $group=null)
	remove ($id, $group=null)
	clean ($group=null, $mode= 'group')
	gc ()
	lock ($id, $group=null, $locktime=null)
	unlock ($id, $group=null)
&	_getStorage ()
Fonctions membres publiques inherited from JObject
	__toString ()
	def ($property, $default=null)
	getProperties ($public=true)
	getError ($i=null, $toString=true)
	getErrors ()
	set ($property, $value=null)
	setProperties ($properties)
	setError ($error)
	toString ()

Fonctions membres publiques statiques
static	getInstance ($type= 'output', $options=array())
static	getStores ()
static	getWorkarounds ($data, $options=array())
static	setWorkarounds ($data, $options=array())
static	makeId ()
static	addIncludePath ($path= '')

Attributs publics
	$_options

Attributs publics statiques
static	$_handler = array()

Additional Inherited Members
Attributs protégés inherited from JObject
	$_errors = array()

---

Documentation des constructeurs et destructeur

JCache::__construct

(

$options

)

Constructor

Paramètres:

array

$options

options

Depuis:

11.1

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

Références $options, JFactory\getConfig(), et JPATH_CACHE.

Voici le graphe d'appel pour cette fonction :

---

Documentation des fonctions membres

& JCache::_getStorage

(

)

Get the cache storage handler

Renvoie:

JCacheStorage A JCacheStorage object

Depuis:

11.1

Références JCacheStorage\getInstance().

Voici le graphe d'appel pour cette fonction :

static JCache::addIncludePath (   $path = '' )

static

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

Paramètres:

string

$path

A path to search.

Renvoie:

array An array with directory elements

Depuis:

11.1

Références $path, JPath\clean(), et jimport().

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

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:

11.1

Références $mode.

JCache::gc

(

)

Garbage collect expired cache data

Renvoie:

boolean True on success, false otherwise.

Depuis:

11.1

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

Get 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 failure or a cached data string

Depuis:

11.1

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

Références $id.

JCache::getAll

(

)

Get a list of all cached data

Renvoie:

mixed Boolean false on failure or an object with a list of cache groups and data

Depuis:

11.1

JCache::getCaching

(

)

Get caching state

Renvoie:

boolean Caching state

Depuis:

11.1

static 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
array	$options	The array of options

Renvoie:

JCache A JCache object

Depuis:

11.1

Références $options, $type, et JCacheController\getInstance().

Référencé par plgSystemCache\__construct(), JModel\cleanCache(), CacheModelCache\getCache(), et JFactory\getCache().

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

static JCache::getStores ( )

static

Get the storage handlers

Renvoie:

array An array of available storage handlers

Depuis:

11.1

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

Référencé par JFormFieldCacheHandler\getOptions().

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

static JCache::getWorkarounds (   $data,   $options = array()  )

static

Perform workarounds on retrieved cached data

Paramètres:

string	$data	Cached data
array	$options	Array of options

Renvoie:

string Body of cached data

Depuis:

11.1

Références $app, $data, $name, $options, elseif, JFactory\getApplication(), JFactory\getDocument(), JSession\getFormToken(), et null.

Référencé par JCacheControllerView\get(), JCacheControllerPage\get(), JCacheControllerCallback\get(), et JDocumentHTML\getBuffer().

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

JCache::lock	(		$id,
			$group = null,
			$locktime = null
	)

Set lock flag on cached item

Paramètres:

string	$id	The cache data id
string	$group	The cache data group
string	$locktime	The default locktime for locking the cache.

Renvoie:

object Properties are lock and locklooped

Depuis:

11.1

Références $id.

static JCache::makeId ( )

static

Create safe id for cached data from url parameters set by plugins and framework

Renvoie:

string md5 encoded cacheid

Depuis:

11.1

Références $app, $key, JFactory\getApplication(), JRequest\getURI(), JRequest\getVar(), et null.

Référencé par JCacheControllerView\_makeId(), et JCacheControllerPage\_makeId().

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

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

Remove a cached data entry by id and group

Paramètres:

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

Renvoie:

boolean True on success, false otherwise

Depuis:

11.1

Références $id.

JCache::setCaching

(

$enabled

)

Set caching enabled state

Paramètres:

boolean

$enabled

True to enable caching

Renvoie:

void

Depuis:

11.1

Références $enabled.

JCache::setLifeTime

(

$lt

)

Set cache lifetime

Paramètres:

integer

$lt

Cache lifetime

Renvoie:

void

Depuis:

11.1

static JCache::setWorkarounds (   $data,   $options = array()  )

static

Create workarounded data to be cached

Paramètres:

string	$data	Cached data
array	$options	Array of options

Renvoie:

string Data to be cached

Depuis:

11.1

Références $app, $data, $options, $type, JFactory\getApplication(), JFactory\getDocument(), JString\strlen(), et JString\substr().

Référencé par JCacheControllerView\get(), JCacheControllerCallback\get(), JDocumentHTML\getBuffer(), et JCacheControllerPage\store().

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

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

Store the cached data by id and group

Paramètres:

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

Renvoie:

boolean True if cache stored

Depuis:

11.1

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

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

Unset lock flag on cached item

Paramètres:

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

Renvoie:

boolean True on success, false otherwise.

Depuis:

11.1

Références $id.

---

Documentation des données membres

JCache::$_handler = array()

static

JCache::$_options

---

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

• libraries/joomla/cache/cache.php