HTMLPurifier_DefinitionCache Klassenreferenz

Klassendiagramm für HTMLPurifier_DefinitionCache:

[Legende]

Ö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:

$name

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

Definiert in Zeile 20 der Datei DefinitionCache.php.

---

Dokumentation der Elementfunktionen

add	(	$	def,
		$	config
	)			[abstract]

Adds a definition object to the cache

Erneute Implementation in HTMLPurifier_DefinitionCache_Decorator_Cleanup, HTMLPurifier_DefinitionCache_Decorator_Memory, HTMLPurifier_DefinitionCache_Decorator, HTMLPurifier_DefinitionCache_Null und HTMLPurifier_DefinitionCache_Serializer.

checkDefType

(

$

def

)

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

Zu beachten:

Throws an error on failure

Parameter:

$def

Definition object to check

Rückgabe:

Boolean true if good, false if not

Definiert in Zeile 60 der Datei DefinitionCache.php.

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.

Erneute Implementation in HTMLPurifier_DefinitionCache_Decorator, HTMLPurifier_DefinitionCache_Null und HTMLPurifier_DefinitionCache_Serializer.

flush

(

$

config

)

[abstract]

Clears all objects from cache

Erneute Implementation in HTMLPurifier_DefinitionCache_Decorator, HTMLPurifier_DefinitionCache_Null und HTMLPurifier_DefinitionCache_Serializer.

generateKey

(

$

config

)

Generates a unique identifier for a particular configuration

Parameter:

Instance

of HTMLPurifier_Config

Definiert in Zeile 28 der Datei DefinitionCache.php.

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

get

(

$

config

)

[abstract]

Retrieves a definition object from the cache

Erneute Implementation in HTMLPurifier_DefinitionCache_Decorator_Cleanup, HTMLPurifier_DefinitionCache_Decorator_Memory, HTMLPurifier_DefinitionCache_Decorator, HTMLPurifier_DefinitionCache_Null und HTMLPurifier_DefinitionCache_Serializer.

isOld	(	$	key,
		$	config
	)

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

Parameter:

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

Definiert in Zeile 40 der Datei DefinitionCache.php.

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

remove

(

$

config

)

[abstract]

Removes a definition object to the cache

Erneute Implementation in HTMLPurifier_DefinitionCache_Decorator, HTMLPurifier_DefinitionCache_Null und HTMLPurifier_DefinitionCache_Serializer.

replace	(	$	def,
		$	config
	)			[abstract]

Replace an object in the cache

Erneute Implementation in HTMLPurifier_DefinitionCache_Decorator_Cleanup, HTMLPurifier_DefinitionCache_Decorator_Memory, HTMLPurifier_DefinitionCache_Decorator, HTMLPurifier_DefinitionCache_Null und HTMLPurifier_DefinitionCache_Serializer.

set	(	$	def,
		$	config
	)			[abstract]

Unconditionally saves a definition object to the cache

Erneute Implementation in HTMLPurifier_DefinitionCache_Decorator_Cleanup, HTMLPurifier_DefinitionCache_Decorator_Memory, HTMLPurifier_DefinitionCache_Decorator, HTMLPurifier_DefinitionCache_Null und HTMLPurifier_DefinitionCache_Serializer.

---

Dokumentation der Datenelemente

$type

Definiert in Zeile 14 der Datei DefinitionCache.php.

---

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

• HTMLPurifier/DefinitionCache.php