Référence de la classe JCacheStorageFile

Graphe d'héritage de JCacheStorageFile:

Graphe de collaboration de JCacheStorageFile:

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 ()
• _setExpire ($id, $group)
• _getFilePath ($id, $group)

Fonctions membres publiques statiques

• test ()

---

Documentation des constructeurs et destructeur

JCacheStorageFile::__construct

(

$

options = array()

)

Constructor

protected

Paramètres:

array

$options

optional parameters

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

Références $config, et JFactory::getConfig().

Voici le graphe d'appel pour cette fonction :

---

Documentation des fonctions membres

JCacheStorageFile::_getFilePath	(	$	id,
		$	group
	)

Get a cache file path from an id/group pair

private

Paramètres:

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

Renvoie:

string The cache file path

Depuis:

1.5

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

JCacheStorageFile::_setExpire	(	$	id,
		$	group
	)

Check to make sure cache is still valid, if not, delete it.

private

Paramètres:

string	$id	Cache key to expire.
string	$group	The cache data group.

Références $id, $path, et elseif.

JCacheStorageFile::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 à partir de JCacheStorage.

Références $folder, $i, $n, $return, JFolder::delete(), JFolder::folders(), et jimport().

Voici le graphe d'appel pour cette fonction :

JCacheStorageFile::gc

(

)

Garbage collect expired cache data

public

Renvoie:

boolean True on success, false otherwise.

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

Références $file, JFile::delete(), JFolder::files(), et jimport().

Voici le graphe d'appel pour cette fonction :

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

Get cached data from a file 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 à partir de JCacheStorage.

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

JCacheStorageFile::remove	(	$	id,
		$	group
	)

Remove a cached data file 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 à partir de JCacheStorage.

Références $path.

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

Store the data to a file 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 à partir de JCacheStorage.

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

JCacheStorageFile::test

(

)

[static]

Test to see if the cache storage is available.

public

Renvoie:

boolean True on success, false otherwise.

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

Références $config, et JFactory::getConfig().

Voici le graphe d'appel pour cette fonction :

---

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

• libraries/joomla/cache/storage/file.php