Référence de la classe JCacheStorage

Graphe d'héritage de JCacheStorage:

Liste de tous les membres

Fonctions membres publiques
	__construct ($options=array())
	get ($id, $group, $checkTime=true)
	getAll ()
	store ($id, $group, $data)
	remove ($id, $group)
	clean ($group, $mode=null)
	gc ()
	lock ($id, $group, $locktime)
	unlock ($id, $group=null)

Fonctions membres publiques statiques
static	getInstance ($handler=null, $options=array())
static	test ()
static	addIncludePath ($path= '')

Attributs publics
	$_now
	$_lifetime
	$_locking
	$_language
	$_application
	$_hash

Fonctions membres protégées
	_getCacheId ($id, $group)

Attributs protégés
	$rawname

---

Documentation des constructeurs et destructeur

JCacheStorage::__construct

(

$options = array()

)

Constructor

Paramètres:

array

$options

Optional parameters

Depuis:

11.1

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

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

Voici le graphe d'appel pour cette fonction :

---

Documentation des fonctions membres

JCacheStorage::_getCacheId (   $id,   $group  )

protected

Get a cache_id string from an id/group pair

Paramètres:

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

Renvoie:

string The cache_id string

Depuis:

11.1

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

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

static

Add a directory where JCacheStorage 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().

Référencé par getInstance().

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

JCacheStorage::clean	(		$group,
			$mode = null
	)

Clean cache for a group given a mode.

Paramètres:

string	$group	The cache data group
string	$mode	The mode for cleaning cache [group|notgroup] group mode : cleans all cache in the group notgroup mode : cleans all cache not in the group

Renvoie:

boolean True on success, false otherwise

Depuis:

11.1

Réimplémentée dans JCacheStorageMemcached, JCacheStorageMemcache, JCacheStorageCachelite, JCacheStorageFile, JCacheStorageEaccelerator, JCacheStorageXcache, JCacheStorageWincache, et JCacheStorageApc.

JCacheStorage::gc

(

)

Garbage collect expired cache data

Renvoie:

boolean True on success, false otherwise.

Depuis:

11.1

Réimplémentée dans JCacheStorageCachelite, JCacheStorageFile, JCacheStorageEaccelerator, JCacheStorageXcache, JCacheStorageWincache, et JCacheStorageApc.

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

Get cached data by id and group

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 object

Depuis:

11.1

Réimplémentée dans JCacheStorageMemcached, JCacheStorageMemcache, JCacheStorageCachelite, JCacheStorageFile, JCacheStorageEaccelerator, JCacheStorageWincache, JCacheStorageApc, et JCacheStorageXcache.

JCacheStorage::getAll

(

)

Get all cached data

Renvoie:

mixed Boolean false on failure or a cached data object

Depuis:

11.1

Réimplémentée dans JCacheStorageMemcached, JCacheStorageMemcache, JCacheStorageCachelite, JCacheStorageFile, JCacheStorageEaccelerator, JCacheStorageWincache, JCacheStorageXcache, et JCacheStorageApc.

static JCacheStorage::getInstance (   $handler = null,   $options = array()  )

static

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

Paramètres:

string	$handler	The cache storage handler to instantiate
array	$options	Array of handler options

Renvoie:

JCacheStorageHandler A JCacheStorageHandler object

Depuis:

11.1

Références $class, $options, $path, JText\_(), addIncludePath(), JPath\find(), JFactory\getConfig(), jimport(), null, JError\raiseWarning(), et JText\sprintf().

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

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

JCacheStorage::lock	(		$id,
			$group,
			$locktime
	)

Lock cached item

Paramètres:

string	$id	The cache data id
string	$group	The cache data group
integer	$locktime	Cached item max lock time

Renvoie:

boolean True on success, false otherwise.

Depuis:

11.1

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

JCacheStorage::remove	(		$id,
			$group
	)

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

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

Store the data to cache by id and group

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:

11.1

Réimplémentée dans JCacheStorageMemcached, JCacheStorageMemcache, JCacheStorageCachelite, JCacheStorageFile, JCacheStorageEaccelerator, JCacheStorageWincache, JCacheStorageXcache, et JCacheStorageApc.

static JCacheStorage::test ( )

static

Test to see if the storage handler is available.

Renvoie:

boolean True on success, false otherwise

Depuis:

11.1.

Réimplémentée dans JCacheStorageCachelite, JCacheStorageMemcached, JCacheStorageMemcache, JCacheStorageFile, JCacheStorageXcache, JCacheStorageEaccelerator, JCacheStorageWincache, et JCacheStorageApc.

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

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

---

Documentation des données membres

JCacheStorage::$_application

JCacheStorage::$_hash

JCacheStorage::$_language

JCacheStorage::$_lifetime

JCacheStorage::$_locking

JCacheStorage::$_now

JCacheStorage::$rawname

protected

---

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

• cache/storage.php