Référence de la classe JCacheStorage

Graphe d'héritage de JCacheStorage:

Graphe de collaboration de JCacheStorage:

Liste de tous les membres

Fonctions membres publiques

• __construct ($options=array())
• get ($id, $group, $checkTime)
• store ($id, $group, $data)
• remove ($id, $group)
• clean ($group, $mode)
• gc ()

Fonctions membres publiques statiques

• & getInstance ($handler= 'file', $options=array())
• test ()

---

Documentation des constructeurs et destructeur

JCacheStorage::__construct

(

$

options = array()

)

Constructor

protected

Paramètres:

array

$options

optional parameters

Réimplémentée dans JCacheStorageApc, JCacheStorageEaccelerator, JCacheStorageFile, JCacheStorageMemcache, et JCacheStorageXCache.

---

Documentation des fonctions membres

JCacheStorage::clean	(	$	group,
		$	mode
	)

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éimplémentée dans JCacheStorageApc, JCacheStorageEaccelerator, JCacheStorageFile, JCacheStorageMemcache, et JCacheStorageXCache.

JCacheStorage::gc

(

)

Garbage collect expired cache data

public

Renvoie:

boolean True on success, false otherwise.

Réimplémentée dans JCacheStorageEaccelerator, JCacheStorageFile, et JCacheStorageMemcache.

JCacheStorage::get	(	$	id,
		$	group,
		$	checkTime
	)

Get cached data by id and group

public

Paramètres:

string	$id	The cache data id
string	$group	The cache data group
boolean	$checkTime	True to verify cache time expiration threshold

Renvoie:

mixed Boolean false on failure or a cached data string

Depuis:

1.5

Réimplémentée dans JCacheStorageApc, JCacheStorageEaccelerator, JCacheStorageFile, JCacheStorageMemcache, et JCacheStorageXCache.

& JCacheStorage::getInstance	(	$	handler = 'file',
		$	options = array()
	)		[static]

Returns a reference to a cache storage hanlder object, only creating it if it doesn't already exist.

Paramètres:

string

$handler

The cache storage handler to instantiate

Renvoie:

object A JCacheStorageHandler object

Depuis:

1.5

Références $class, $now, $path, $return, et JError::raiseWarning().

Référencé par JCache::_getStorage().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

JCacheStorage::remove	(	$	id,
		$	group
	)

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éimplémentée dans JCacheStorageApc, JCacheStorageEaccelerator, JCacheStorageFile, JCacheStorageMemcache, et JCacheStorageXCache.

JCacheStorage::store	(	$	id,
		$	group,
		$	data
	)

Store the data to cache by id and group

public

Paramètres:

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

Renvoie:

boolean True on success, false otherwise

Depuis:

1.5

Réimplémentée dans JCacheStorageApc, JCacheStorageEaccelerator, JCacheStorageFile, JCacheStorageMemcache, et JCacheStorageXCache.

JCacheStorage::test

(

)

[static]

Test to see if the storage handler is available.

public

Renvoie:

boolean True on success, false otherwise.

Réimplémentée dans JCacheStorageApc, JCacheStorageEaccelerator, JCacheStorageFile, JCacheStorageMemcache, et JCacheStorageXCache.

---

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

• cache/storage.php