HTMLPurifier_DefinitionCache Class Reference

Inheritance diagram for HTMLPurifier_DefinitionCache:

Public Member Functions
	__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)
Data Fields
	$type

---

Detailed Description

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

Todo:

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

Implement memcached

Definition at line 11 of file DefinitionCache.php.

---

Constructor & Destructor Documentation

__construct

(

$

type

)

Parameters:

$name

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

Definition at line 20 of file DefinitionCache.php.

---

Member Function Documentation

add	(	$	def,
		$	config
	)		[abstract]

Adds a definition object to the cache

Reimplemented in HTMLPurifier_DefinitionCache_Decorator, HTMLPurifier_DefinitionCache_Decorator_Memory, HTMLPurifier_DefinitionCache_Decorator_Cleanup, HTMLPurifier_DefinitionCache_Null, and HTMLPurifier_DefinitionCache_Serializer.

checkDefType

(

$

def

)

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

Note:

Throws an error on failure

Parameters:

$def	Definition object to check

Returns:

Boolean true if good, false if not

Definition at line 60 of file DefinitionCache.php.

Here is the caller graph for this function:

cleanup

(

$

config

)

[abstract]

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

Note:

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.

Reimplemented in HTMLPurifier_DefinitionCache_Decorator, HTMLPurifier_DefinitionCache_Serializer, and HTMLPurifier_DefinitionCache_Null.

flush

(

$

config

)

[abstract]

Clears all objects from cache

Reimplemented in HTMLPurifier_DefinitionCache_Decorator, HTMLPurifier_DefinitionCache_Serializer, and HTMLPurifier_DefinitionCache_Null.

generateKey

(

$

config

)

Generates a unique identifier for a particular configuration

Parameters:

Instance

of HTMLPurifier_Config

Definition at line 28 of file DefinitionCache.php.

Here is the caller graph for this function:

get

(

$

config

)

[abstract]

Retrieves a definition object from the cache

Reimplemented in HTMLPurifier_DefinitionCache_Decorator, HTMLPurifier_DefinitionCache_Decorator_Memory, HTMLPurifier_DefinitionCache_Decorator_Cleanup, HTMLPurifier_DefinitionCache_Serializer, and HTMLPurifier_DefinitionCache_Null.

isOld	(	$	key,
		$	config
	)

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

Parameters:

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

Definition at line 40 of file DefinitionCache.php.

Here is the caller graph for this function:

remove

(

$

config

)

[abstract]

Removes a definition object to the cache

Reimplemented in HTMLPurifier_DefinitionCache_Decorator, HTMLPurifier_DefinitionCache_Serializer, and HTMLPurifier_DefinitionCache_Null.

replace	(	$	def,
		$	config
	)		[abstract]

Replace an object in the cache

Reimplemented in HTMLPurifier_DefinitionCache_Decorator, HTMLPurifier_DefinitionCache_Decorator_Memory, HTMLPurifier_DefinitionCache_Decorator_Cleanup, HTMLPurifier_DefinitionCache_Serializer, and HTMLPurifier_DefinitionCache_Null.

set	(	$	def,
		$	config
	)		[abstract]

Unconditionally saves a definition object to the cache

Reimplemented in HTMLPurifier_DefinitionCache_Decorator, HTMLPurifier_DefinitionCache_Decorator_Memory, HTMLPurifier_DefinitionCache_Decorator_Cleanup, HTMLPurifier_DefinitionCache_Serializer, and HTMLPurifier_DefinitionCache_Null.

---

Field Documentation

$type

Definition at line 14 of file DefinitionCache.php.

---

The documentation for this class was generated from the following file:

• C:/xampp/htdocs/moodle/lib/htmlpurifier/HTMLPurifier/DefinitionCache.php