HTMLPurifier_DefinitionCache Class Reference

Inheritance diagram for HTMLPurifier_DefinitionCache:

Public Member Functions
	__construct ($type)
	add ($def, $config)
	Adds a definition object to the cache.
	checkDefType ($def)
	Checks if a definition's type jives with the cache's type.
	cleanup ($config)
	Clears all expired (older version or revision) objects from cache.
	flush ($config)
	Clears all objects from cache.
	generateKey ($config)
	Generates a unique identifier for a particular configuration.
	get ($config)
	Retrieves a definition object from the cache.
	isOld ($key, $config)
	Tests whether or not a key is old with respect to the configuration's version and revision number.
	remove ($config)
	Removes a definition object to the cache.
	replace ($def, $config)
	Replace an object in the cache.
	set ($def, $config)
	Unconditionally saves a definition object to the cache.

Public Attributes
	$type
	@type string

Constructor & Destructor Documentation

__construct()

HTMLPurifier_DefinitionCache::__construct

(

$type

)

Parameters

string

$type

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

Member Function Documentation

add()

HTMLPurifier_DefinitionCache::add ( $def, $config )

abstract

Adds a definition object to the cache.

Parameters

HTMLPurifier_Definition	$def
HTMLPurifier_Config	$config

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

checkDefType()

HTMLPurifier_DefinitionCache::checkDefType

(

$def

)

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

Note

Throws an error on failure

Parameters

HTMLPurifier_Definition

$def

Definition object to check

Return values

bool	true if good, false if not

cleanup()

HTMLPurifier_DefinitionCache::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.

Parameters

HTMLPurifier_Config

$config

Reimplemented in HTMLPurifier_DefinitionCache_Decorator, HTMLPurifier_DefinitionCache_Null, and HTMLPurifier_DefinitionCache_Serializer.

flush()

HTMLPurifier_DefinitionCache::flush ( $config )

abstract

Clears all objects from cache.

Parameters

HTMLPurifier_Config

$config

Reimplemented in HTMLPurifier_DefinitionCache_Decorator, HTMLPurifier_DefinitionCache_Null, and HTMLPurifier_DefinitionCache_Serializer.

generateKey()

HTMLPurifier_DefinitionCache::generateKey

(

$config

)

Generates a unique identifier for a particular configuration.

Parameters

HTMLPurifier_Config

$config

Instance of HTMLPurifier_Config

Return values

string

get()

HTMLPurifier_DefinitionCache::get ( $config )

abstract

Retrieves a definition object from the cache.

Parameters

HTMLPurifier_Config

$config

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

isOld()

HTMLPurifier_DefinitionCache::isOld	(		$key,
			$config )

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

Parameters

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

Return values

bool

remove()

HTMLPurifier_DefinitionCache::remove ( $config )

abstract

Removes a definition object to the cache.

Parameters

HTMLPurifier_Config

$config

Reimplemented in HTMLPurifier_DefinitionCache_Decorator, HTMLPurifier_DefinitionCache_Null, and HTMLPurifier_DefinitionCache_Serializer.

replace()

HTMLPurifier_DefinitionCache::replace ( $def, $config )

abstract

Replace an object in the cache.

Parameters

HTMLPurifier_Definition	$def
HTMLPurifier_Config	$config

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

set()

HTMLPurifier_DefinitionCache::set ( $def, $config )

abstract

Unconditionally saves a definition object to the cache.

Parameters

HTMLPurifier_Definition	$def
HTMLPurifier_Config	$config

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

---

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

• lib/htmlpurifier/HTMLPurifier/DefinitionCache.php