Référence de la classe XoopsCacheEngine

Graphe d'héritage de XoopsCacheEngine:

Fonctions membres publiques
	init ($settings=array())
	gc ()
	write ($key, $value, $duration=null)
	read ($key)
	delete ($key)
	clear ($check)
	settings ()

Champs de données
	$settings

Documentation des fonctions membres

clear()

clear

(

$check

)

Delete all keys from the cache

Paramètres

boolean

$check

if true will check expiration, otherwise delete all

Renvoie

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

Réimplémentée dans XoopsCacheFile, XoopsCacheModel, XoopsCacheMemcache, XoopsCacheXcache, et XoopsCacheApc.

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 dans XoopsCacheFile, XoopsCacheModel, XoopsCacheMemcache, XoopsCacheXcache, et XoopsCacheApc.

gc()

gc

(

)

Garbage collection

Permanently remove all expired and deleted data

@access public

Réimplémentée dans XoopsCacheFile, et XoopsCacheModel.

init()

init

(

$settings = array()

)

Iitialize the cache engine

Called automatically by the cache frontend

Paramètres

array

$settings

Associative array of parameters for the engine

Renvoie

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

Réimplémentée dans XoopsCacheFile, XoopsCacheModel, XoopsCacheMemcache, XoopsCacheXcache, et XoopsCacheApc.

Voici le graphe d'appel pour 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 dans XoopsCacheFile, XoopsCacheModel, XoopsCacheMemcache, XoopsCacheXcache, et XoopsCacheApc.

settings()

settings

(

)

Cache Engine settings

Renvoie

array settings @access public

Voici le graphe des appelants de cette fonction :

write()

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

Write value for a key into cache

Paramètres

string	$key	Identifier for the data
mixed	$value	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 dans XoopsCacheModel, XoopsCacheMemcache, XoopsCacheXcache, XoopsCacheApc, et XoopsCacheFile.

Documentation des champs

$settings

$settings

---

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

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