Class HTMLPurifier_DefinitionCache

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

Direct known subclasses

HTMLPurifier_DefinitionCache_Decorator, HTMLPurifier_DefinitionCache_Null, HTMLPurifier_DefinitionCache_Serializer

Indirect known subclasses

HTMLPurifier_DefinitionCache_Decorator_Cleanup, HTMLPurifier_DefinitionCache_Decorator_Memory

Abstract
Located at x2engine/framework/vendors/htmlpurifier/HTMLPurifier.standalone.php

Methods summary
`public`	# `__construct( string $type )` Parameters `$type` `string` $type Type of definition objects this instance of the cache will handle.
`public string`	# `generateKey( HTMLPurifier_Config $config )` Generates a unique identifier for a particular configuration Generates a unique identifier for a particular configuration Parameters `$config` `HTMLPurifier_Config` $config Instance of HTMLPurifier_Config Returns `string`
`public boolean`	# `isOld( string $key, HTMLPurifier_Config $config )` Tests whether or not a key is old with respect to the configuration's version and revision number. Tests whether or not a key is old with respect to the configuration's version and revision number. Parameters `$key` `string` $key Key to test `$config` `HTMLPurifier_Config` $config Instance of HTMLPurifier_Config to test against Returns `boolean`
`public boolean`	# `checkDefType( HTMLPurifier_Definition $def )` Checks if a definition's type jives with the cache's type Checks if a definition's type jives with the cache's type Parameters `$def` `HTMLPurifier_Definition` $def Definition object to check Returns `boolean` true if good, false if not Note Throws an error on failure
`abstract public`	# `add( HTMLPurifier_Definition $def, HTMLPurifier_Config $config )` Adds a definition object to the cache Adds a definition object to the cache Parameters `$def` `HTMLPurifier_Definition` $def `$config` `HTMLPurifier_Config` $config
`abstract public`	# `set( HTMLPurifier_Definition $def, HTMLPurifier_Config $config )` Unconditionally saves a definition object to the cache Unconditionally saves a definition object to the cache Parameters `$def` `HTMLPurifier_Definition` $def `$config` `HTMLPurifier_Config` $config
`abstract public`	# `replace( HTMLPurifier_Definition $def, HTMLPurifier_Config $config )` Replace an object in the cache Replace an object in the cache Parameters `$def` `HTMLPurifier_Definition` $def `$config` `HTMLPurifier_Config` $config
`abstract public`	# `get( HTMLPurifier_Config $config )` Retrieves a definition object from the cache Retrieves a definition object from the cache Parameters `$config` `HTMLPurifier_Config` $config
`abstract public`	# `remove( HTMLPurifier_Config $config )` Removes a definition object to the cache Removes a definition object to the cache Parameters `$config` `HTMLPurifier_Config` $config
`abstract public`	# `flush( HTMLPurifier_Config $config )` Clears all objects from cache Clears all objects from cache Parameters `$config` `HTMLPurifier_Config` $config
`abstract public`	# `cleanup( HTMLPurifier_Config $config )` Clears all expired (older version or revision) objects from cache Clears all expired (older version or revision) objects from cache Parameters `$config` `HTMLPurifier_Config` $config 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.

Properties summary
`public mixed`	`$type`		# Type string