HTMLPurifier_DefinitionCache Klassenreferenz

Klassendiagramm für HTMLPurifier_DefinitionCache:

Öffentliche Methoden
	__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)

Datenfelder
	$type

Ausführliche Beschreibung

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

Noch zu erledigen:

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

Implement memcached

Definiert in Zeile 11 der Datei DefinitionCache.php.

Beschreibung der Konstruktoren und Destruktoren

__construct

(

$type)

Parameter

string

$type

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

Definiert in Zeile 22 der Datei DefinitionCache.php.

Benutzt $type.

Dokumentation der Elementfunktionen

add (   $def,   $config  )

abstract

Adds a definition object to the cache

Parameter

HTMLPurifier_Definition	$def
HTMLPurifier_Config	$config

checkDefType

(

$def)

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

Zu beachten

Throws an error on failure

Parameter

HTMLPurifier_Definition

$def

Definition object to check

Rückgabe

bool true if good, false if not

Definiert in Zeile 71 der Datei DefinitionCache.php.

Wird benutzt von HTMLPurifier_DefinitionCache_Serializer\add(), HTMLPurifier_DefinitionCache_Serializer\replace() und HTMLPurifier_DefinitionCache_Serializer\set().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

cleanup (   $config)

abstract

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

Zu beachten

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

Parameter

HTMLPurifier_Config

$config

flush (   $config)

abstract

Clears all objects from cache

Parameter

HTMLPurifier_Config

$config

generateKey

(

$config)

Generates a unique identifier for a particular configuration

Parameter

HTMLPurifier_Config

$config

Instance of HTMLPurifier_Config

Rückgabe

string

Definiert in Zeile 32 der Datei DefinitionCache.php.

Wird benutzt von HTMLPurifier_DefinitionCache_Decorator_Memory\add(), HTMLPurifier_DefinitionCache_Serializer\generateFilePath(), HTMLPurifier_DefinitionCache_Decorator_Memory\get(), HTMLPurifier_DefinitionCache_Decorator_Memory\replace() und HTMLPurifier_DefinitionCache_Decorator_Memory\set().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

get (   $config)

abstract

Retrieves a definition object from the cache

Parameter

HTMLPurifier_Config

$config

isOld	(		$key,
			$config
	)

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

Parameter

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

Rückgabe

bool

Definiert in Zeile 46 der Datei DefinitionCache.php.

Wird benutzt von HTMLPurifier_DefinitionCache_Serializer\cleanup().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

remove (   $config)

abstract

Removes a definition object to the cache

Parameter

HTMLPurifier_Config

$config

replace (   $def,   $config  )

abstract

Replace an object in the cache

Parameter

HTMLPurifier_Definition	$def
HTMLPurifier_Config	$config

set (   $def,   $config  )

abstract

Unconditionally saves a definition object to the cache

Parameter

HTMLPurifier_Definition	$def
HTMLPurifier_Config	$config

Dokumentation der Datenelemente

$type

string

Definiert in Zeile 16 der Datei DefinitionCache.php.

Wird benutzt von __construct() und HTMLPurifier_DefinitionCache_Serializer\generateDirectoryPath().

---

Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei:

• HTMLPurifier/DefinitionCache.php