HTMLPurifier_DefinitionCache_Decorator_Cleanup
extends HTMLPurifier_DefinitionCache_Decorator
in package
Definition cache decorator class that cleans up the cache whenever there is a cache miss.
Table of Contents
Properties
- $cache : mixed
- Cache object we are decorating
- $name : string
- The name of the decorator
- $type : mixed
Methods
- __construct() : mixed
- add() : mixed
- Adds a definition object to the cache
- checkDefType() : bool
- Checks if a definition's type jives with the cache's type
- cleanup() : mixed
- Clears all expired (older version or revision) objects from cache
- copy() : HTMLPurifier_DefinitionCache_Decorator_Cleanup
- Cross-compatible clone substitute
- decorate() : HTMLPurifier_DefinitionCache_Decorator
- Lazy decorator function
- flush() : mixed
- Clears all objects from cache
- generateKey() : string
- Generates a unique identifier for a particular configuration
- get() : mixed
- Retrieves a definition object from the cache
- isOld() : bool
- Tests whether or not a key is old with respect to the configuration's version and revision number.
- remove() : mixed
- Removes a definition object to the cache
- replace() : mixed
- Replace an object in the cache
- set() : mixed
- Unconditionally saves a definition object to the cache
Properties
$cache
Cache object we are decorating
public
mixed
$cache
Tags
$name
The name of the decorator
public
string
$name
= 'Cleanup'
Tags
$type
public
mixed
$type
Tags
Methods
__construct()
public
__construct() : mixed
add()
Adds a definition object to the cache
public
add(HTMLPurifier_Definition $def, HTMLPurifier_Config $config) : mixed
Parameters
- $def : HTMLPurifier_Definition
- $config : HTMLPurifier_Config
checkDefType()
Checks if a definition's type jives with the cache's type
public
checkDefType(HTMLPurifier_Definition $def) : bool
Parameters
- $def : HTMLPurifier_Definition
-
Definition object to check
Tags
Return values
bool —true if good, false if not
cleanup()
Clears all expired (older version or revision) objects from cache
public
cleanup(HTMLPurifier_Config $config) : mixed
Parameters
- $config : HTMLPurifier_Config
copy()
Cross-compatible clone substitute
public
copy() : HTMLPurifier_DefinitionCache_Decorator_Cleanup
Return values
HTMLPurifier_DefinitionCache_Decorator_Cleanupdecorate()
Lazy decorator function
public
decorate(HTMLPurifier_DefinitionCache &$cache) : HTMLPurifier_DefinitionCache_Decorator
Parameters
- $cache : HTMLPurifier_DefinitionCache
-
Reference to cache object to decorate
Return values
HTMLPurifier_DefinitionCache_Decoratorflush()
Clears all objects from cache
public
flush(HTMLPurifier_Config $config) : mixed
Parameters
- $config : HTMLPurifier_Config
generateKey()
Generates a unique identifier for a particular configuration
public
generateKey(HTMLPurifier_Config $config) : string
Parameters
- $config : HTMLPurifier_Config
-
Instance of HTMLPurifier_Config
Return values
stringget()
Retrieves a definition object from the cache
public
get(HTMLPurifier_Config $config) : mixed
Parameters
- $config : HTMLPurifier_Config
isOld()
Tests whether or not a key is old with respect to the configuration's version and revision number.
public
isOld(string $key, HTMLPurifier_Config $config) : bool
Parameters
- $key : string
-
Key to test
- $config : HTMLPurifier_Config
-
Instance of HTMLPurifier_Config to test against
Return values
boolremove()
Removes a definition object to the cache
public
remove(HTMLPurifier_Config $config) : mixed
Parameters
- $config : HTMLPurifier_Config
replace()
Replace an object in the cache
public
replace(HTMLPurifier_Definition $def, HTMLPurifier_Config $config) : mixed
Parameters
- $def : HTMLPurifier_Definition
- $config : HTMLPurifier_Config
set()
Unconditionally saves a definition object to the cache
public
set(HTMLPurifier_Definition $def, HTMLPurifier_Config $config) : mixed
Parameters
- $def : HTMLPurifier_Definition
- $config : HTMLPurifier_Config