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

Inheritance diagram for HTMLPurifier_DefinitionCache:

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

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

HTMLPurifier_DefinitionCache::__construct ( $ type )

Parameters:

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

Definition at line 20 of file DefinitionCache.php.

References $type.

HTMLPurifier_DefinitionCache::__construct ( $ type )

Parameters:

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

Definition at line 2486 of file HTMLPurifier.standalone.php.

References $type.

Member Function Documentation

HTMLPurifier_DefinitionCache::add	(	$	def,
		$	config
	)		`[abstract]`

Adds a definition object to the cache.

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

HTMLPurifier_DefinitionCache::add	(	$	def,
		$	config
	)		`[abstract]`

Adds a definition object to the cache.

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

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

References $def.

Referenced by HTMLPurifier_DefinitionCache_Serializer::add(), HTMLPurifier_DefinitionCache_Serializer::replace(), and HTMLPurifier_DefinitionCache_Serializer::set().

HTMLPurifier_DefinitionCache::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 2526 of file HTMLPurifier.standalone.php.

References $def.

HTMLPurifier_DefinitionCache::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_Null, HTMLPurifier_DefinitionCache_Serializer, HTMLPurifier_DefinitionCache_Decorator, HTMLPurifier_DefinitionCache_Null, and HTMLPurifier_DefinitionCache_Serializer.

HTMLPurifier_DefinitionCache::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_Null, HTMLPurifier_DefinitionCache_Serializer, HTMLPurifier_DefinitionCache_Decorator, HTMLPurifier_DefinitionCache_Null, and HTMLPurifier_DefinitionCache_Serializer.

HTMLPurifier_DefinitionCache::flush ( $ config ) [abstract]

Clears all objects from cache.

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

HTMLPurifier_DefinitionCache::flush ( $ config ) [abstract]

Clears all objects from cache.

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

HTMLPurifier_DefinitionCache::generateKey ( $ config )

Generates a unique identifier for a particular configuration.

Parameters:

Instance of HTMLPurifier_Config

Definition at line 2494 of file HTMLPurifier.standalone.php.