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

Constructor & Destructor Documentation

__construct()

__construct

(

$type

)

Parameters

string

$type

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

Member Function Documentation

add()

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()

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

Returns

bool true if good, false if not

Here is the caller graph for this function:

cleanup()

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()

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()

generateKey

(

$config

)

Generates a unique identifier for a particular configuration

Parameters

HTMLPurifier_Config

$config

Instance of HTMLPurifier_Config

Returns

string

Here is the caller graph for this function:

get()

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()

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

Returns

bool

Here is the caller graph for this function:

remove()

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()

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()

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.

Field Documentation

$type

$type

@type string

---

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

• C:/xoops2511b2/htdocs/xoops_lib/modules/protector/library/HTMLPurifier/DefinitionCache.php