Référence de la classe XoopsCacheFile

Graphe d'héritage de XoopsCacheFile:

Graphe de collaboration de XoopsCacheFile:

Fonctions membres publiques
	init ($settings=array())
	gc ()
	write ($key, $data=null, $duration=null)
	read ($key)
	delete ($key)
	clear ($check=true)
Fonctions membres publiques hérités de XoopsCacheEngine
	settings ()

Champs de données
	$settings = array()
Champs de données hérités de XoopsCacheEngine
	$settings

Fonctions membres privées
	setKey ($key)
	active ()

Attributs privés
	$file
	$active = false
	$init = true

Documentation des fonctions membres

active()

active ( )

private

Determine is cache directory is writable

Renvoie

boolean @access private

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

clear()

clear

(

$check = true

)

Delete all values from the cache

Paramètres

boolean

$check

Optional - only delete expired cache items

Renvoie

boolean True if the cache was successfully cleared, false otherwise @access public

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

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

delete()

delete

(

$key

)

Delete a key from the cache

Paramètres

string

$key

Identifier for the data

Renvoie

boolean True if the value was successfully deleted, false if it didn't exist or couldn't be removed @access public

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

Voici le graphe d'appel pour cette fonction :

gc()

gc

(

)

Garbage collection. Permanently remove all expired and deleted data

Renvoie

boolean True if garbage collection was successful, false on failure @access public

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

Voici le graphe d'appel pour cette fonction :

init()

init

(

$settings = array()

)

Initialize the Cache Engine

Called automatically by the cache frontend To reinitialize the settings call Cache::engine('EngineName', [optional] settings = array());

Paramètres

array

$settings

array of setting for the engine

Renvoie

boolean True if the engine has been successfully initialized, false if not @access public

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

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

read()

read

(

$key

)

Read a key from the cache

Paramètres

string

$key

Identifier for the data

Renvoie

mixed The cached data, or false if the data doesn't exist, has expired, or if there was an error fetching it @access public

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

Voici le graphe d'appel pour cette fonction :

setKey()

setKey (   $key )

private

Get absolute file for a given key

Paramètres

string

$key

The key

Renvoie

mixed Absolute cache file for the given key or false if erroneous @access private

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

write()

write	(		$key,
			$data = null,
			$duration = null
	)

Write data for key into cache

Paramètres

string	$key	Identifier for the data
mixed	$data	Data to be cached
mixed	$duration	How long to cache the data, in seconds

Renvoie

boolean True if the data was successfully cached, false on failure @access public

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

Voici le graphe d'appel pour cette fonction :

Documentation des champs

$active

$active = false

private

$file

$file

private

$init

$init = true

private

$settings

$settings = array()

---

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

• XoopsCore25-2.5.11-Beta1/htdocs/class/cache/file.php