HTMLPurifier_DefinitionCache_Decorator_Cleanup Class Reference

Inheritance diagram for HTMLPurifier_DefinitionCache_Decorator_Cleanup:

Public Member Functions
	add ($def, $config)
	checkDefType ($def)
	Checks if a definition's type jives with the cache's type.
	cleanup ($config)
	copy ()
	decorate (&$cache)
	Lazy decorator function.
	flush ($config)
	generateKey ($config)
	Generates a unique identifier for a particular configuration.
	get ($config)
	isOld ($key, $config)
	Tests whether or not a key is old with respect to the configuration's version and revision number.
	remove ($config)
	replace ($def, $config)
	set ($def, $config)

Public Attributes
	$cache
	$name = 'Cleanup'
	@type string
	$type
	@type string

Member Function Documentation

add()

HTMLPurifier_DefinitionCache_Decorator_Cleanup::add	(		$def,
			$config )

Parameters

HTMLPurifier_Definition	$def
HTMLPurifier_Config	$config

Return values

mixed

Reimplemented from HTMLPurifier_DefinitionCache_Decorator.

checkDefType()

HTMLPurifier_DefinitionCache::checkDefType ( $def )

inherited

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_Decorator::cleanup ( $config )

inherited

Parameters

HTMLPurifier_Config

$config

Return values

mixed

Reimplemented from HTMLPurifier_DefinitionCache.

copy()

HTMLPurifier_DefinitionCache_Decorator_Cleanup::copy

(

)

Return values

HTMLPurifier_DefinitionCache_Decorator_Cleanup

Reimplemented from HTMLPurifier_DefinitionCache_Decorator.

decorate()

HTMLPurifier_DefinitionCache_Decorator::decorate ( & $cache )

inherited

Lazy decorator function.

Parameters

HTMLPurifier_DefinitionCache

$cache

Reference to cache object to decorate

Return values

HTMLPurifier_DefinitionCache_Decorator

flush()

HTMLPurifier_DefinitionCache_Decorator::flush ( $config )

inherited

Parameters

HTMLPurifier_Config

$config

Return values

mixed

Reimplemented from HTMLPurifier_DefinitionCache.

generateKey()

HTMLPurifier_DefinitionCache::generateKey ( $config )

inherited

Generates a unique identifier for a particular configuration.

Parameters

HTMLPurifier_Config

$config

Instance of HTMLPurifier_Config

Return values

string

get()

HTMLPurifier_DefinitionCache_Decorator_Cleanup::get

(

$config

)

Parameters

HTMLPurifier_Config

$config

Return values

mixed

Reimplemented from HTMLPurifier_DefinitionCache_Decorator.

isOld()

HTMLPurifier_DefinitionCache::isOld ( $key, $config )

inherited

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_Decorator::remove ( $config )

inherited

Parameters

HTMLPurifier_Config

$config

Return values

mixed

Reimplemented from HTMLPurifier_DefinitionCache.

replace()

HTMLPurifier_DefinitionCache_Decorator_Cleanup::replace	(		$def,
			$config )

Parameters

HTMLPurifier_Definition	$def
HTMLPurifier_Config	$config

Return values

mixed

Reimplemented from HTMLPurifier_DefinitionCache_Decorator.

set()

HTMLPurifier_DefinitionCache_Decorator_Cleanup::set	(		$def,
			$config )

Parameters

HTMLPurifier_Definition	$def
HTMLPurifier_Config	$config

Return values

mixed

Reimplemented from HTMLPurifier_DefinitionCache_Decorator.

---

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

• lib/htmlpurifier/HTMLPurifier/DefinitionCache/Decorator/Cleanup.php