Référence de la classe HTMLPurifier_DefinitionCache

Graphe d'héritage de HTMLPurifier_DefinitionCache:

Fonctions membres publiques
	__construct ($type)
	generateKey ($config)
	isOld ($key, $config)
	checkDefType ($def)
	add ($def, $config)
	set ($def, $config)
	replace ($def, $config)
	get ($config)
	remove ($config)
	flush ($config)
	cleanup ($config)

Champs de données
	$type

Description détaillée

Abstract class representing Definition cache managers that implements useful common methods and is a factory.

A faire:

Create a separate maintenance file advanced users can use to cache their custom HTMLDefinition, which can be loaded via a configuration directive

Implement memcached

Documentation des constructeurs et destructeur

__construct()

__construct

(

$type

)

Paramètres

string

$type

Type of definition objects this instance of the cache will handle.

Documentation des fonctions membres

add()

add (   $def,   $config  )

abstract

Adds a definition object to the cache

Paramètres

HTMLPurifier_Definition	$def
HTMLPurifier_Config	$config

Réimplémentée dans HTMLPurifier_DefinitionCache_Decorator, HTMLPurifier_DefinitionCache_Decorator_Memory, HTMLPurifier_DefinitionCache_Decorator_Cleanup, HTMLPurifier_DefinitionCache_Null, et HTMLPurifier_DefinitionCache_Serializer.

checkDefType()

checkDefType

(

$def

)

Checks if a definition's type jives with the cache's type

Note

Throws an error on failure

Paramètres

HTMLPurifier_Definition

$def

Definition object to check

Renvoie

bool true if good, false if not

Voici le graphe des appelants de cette fonction :

cleanup()

cleanup (   $config )

abstract

Clears all expired (older version or revision) objects from cache

Note

Be careful implementing this method as flush. Flush must not interfere with other Definition types, and cleanup() should not be repeatedly called by userland code.

Paramètres

HTMLPurifier_Config

$config

Réimplémentée dans HTMLPurifier_DefinitionCache_Serializer, HTMLPurifier_DefinitionCache_Decorator, et HTMLPurifier_DefinitionCache_Null.

flush()

flush (   $config )

abstract

Clears all objects from cache

Paramètres

HTMLPurifier_Config

$config

Réimplémentée dans HTMLPurifier_DefinitionCache_Decorator, HTMLPurifier_DefinitionCache_Serializer, et HTMLPurifier_DefinitionCache_Null.

generateKey()

generateKey

(

$config

)

Generates a unique identifier for a particular configuration

Paramètres

HTMLPurifier_Config

$config

Instance of HTMLPurifier_Config

Renvoie

string

Voici le graphe des appelants de cette fonction :

get()

get (   $config )

abstract

Retrieves a definition object from the cache

Paramètres

HTMLPurifier_Config

$config

Réimplémentée dans HTMLPurifier_DefinitionCache_Decorator, HTMLPurifier_DefinitionCache_Decorator_Memory, HTMLPurifier_DefinitionCache_Decorator_Cleanup, HTMLPurifier_DefinitionCache_Serializer, et HTMLPurifier_DefinitionCache_Null.

isOld()

isOld	(		$key,
			$config
	)

Tests whether or not a key is old with respect to the configuration's version and revision number.

Paramètres

string	$key	Key to test
HTMLPurifier_Config	$config	Instance of HTMLPurifier_Config to test against

Renvoie

bool

Voici le graphe des appelants de cette fonction :

remove()

remove (   $config )

abstract

Removes a definition object to the cache

Paramètres

HTMLPurifier_Config

$config

Réimplémentée dans HTMLPurifier_DefinitionCache_Decorator, HTMLPurifier_DefinitionCache_Serializer, et HTMLPurifier_DefinitionCache_Null.

replace()

replace (   $def,   $config  )

abstract

Replace an object in the cache

Paramètres

HTMLPurifier_Definition	$def
HTMLPurifier_Config	$config

Réimplémentée dans HTMLPurifier_DefinitionCache_Decorator, HTMLPurifier_DefinitionCache_Decorator_Memory, HTMLPurifier_DefinitionCache_Decorator_Cleanup, HTMLPurifier_DefinitionCache_Serializer, et HTMLPurifier_DefinitionCache_Null.

set()

set (   $def,   $config  )

abstract

Unconditionally saves a definition object to the cache

Paramètres

HTMLPurifier_Definition	$def
HTMLPurifier_Config	$config

Réimplémentée dans HTMLPurifier_DefinitionCache_Decorator, HTMLPurifier_DefinitionCache_Decorator_Memory, HTMLPurifier_DefinitionCache_Decorator_Cleanup, HTMLPurifier_DefinitionCache_Serializer, et HTMLPurifier_DefinitionCache_Null.

Documentation des champs

$type

$type

@type string

---

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

• XoopsCore25-2.5.11-Beta1/htdocs/xoops_lib/modules/protector/library/HTMLPurifier/DefinitionCache.php