Docs For Class HTMLPurifier_DefinitionCache

Description

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

Located in /lib/core/Parsers/htmlpurifier/HTMLPurifier.standalone.php (line 11029)

HTMLPurifier_DefinitionCache
   |
   --HTMLPurifier_DefinitionCache_Decorator

Direct descendents

Class	Description
HTMLPurifier_DefinitionCache_Decorator_Cleanup	Definition cache decorator class that cleans up the cache whenever there is a cache miss.
HTMLPurifier_DefinitionCache_Decorator_Memory	Definition cache decorator class that saves all cache retrievals to PHP's memory; good for unit tests or circumstances where there are lots of configuration objects floating around.

Variable Summary

mixed $cache

Method Summary

HTMLPurifier_DefinitionCache_Decorator __construct ()

void add ( $def, $config)

void cleanup ( $config)

void copy ()

void decorate ($cache &$cache)

void flush ( $config)

void get ( $config)

void remove ( $config)

void replace ( $def, $config)

void set ( $def, $config)

Variables

mixed $cache (line 11035)

Cache object we are decorating

access: public

Inherited Variables

Inherited from HTMLPurifier_DefinitionCache

HTMLPurifier_DefinitionCache::$type

Methods

Constructor __construct (line 11037)

access: public

HTMLPurifier_DefinitionCache_Decorator __construct ()

Redefinition of:

HTMLPurifier_DefinitionCache::__construct()

add (line 11058)

access: public

void add ( $def, $config)

$def
$config

Redefinition of:

HTMLPurifier_DefinitionCache::add(): Adds a definition object to the cache

Redefined in descendants as:

cleanup (line 11082)

access: public

void cleanup ( $config)

$config

Redefinition of:

HTMLPurifier_DefinitionCache::cleanup(): Clears all expired (older version or revision) objects from cache

copy (line 11054)

Cross-compatible clone substitute

access: public

void copy ()

Redefined in descendants as:

decorate (line 11043)

Lazy decorator function

access: public

void decorate ($cache &$cache)

$cache &$cache: Reference to cache object to decorate

flush (line 11078)

access: public

void flush ( $config)

$config

Redefinition of:

HTMLPurifier_DefinitionCache::flush(): Clears all objects from cache

get (line 11070)

access: public

void get ( $config)

$config

Redefinition of:

HTMLPurifier_DefinitionCache::get(): Retrieves a definition object from the cache

Redefined in descendants as:

remove (line 11074)

access: public

void remove ( $config)

$config

Redefinition of:

HTMLPurifier_DefinitionCache::remove(): Removes a definition object to the cache

replace (line 11066)

access: public

void replace ( $def, $config)

$def
$config

Redefinition of:

HTMLPurifier_DefinitionCache::replace(): Replace an object in the cache

Redefined in descendants as:

set (line 11062)

access: public

void set ( $def, $config)

$def
$config

Redefinition of:

HTMLPurifier_DefinitionCache::set(): Unconditionally saves a definition object to the cache

Redefined in descendants as:

Inherited Methods

Inherited From HTMLPurifier_DefinitionCache

HTMLPurifier_DefinitionCache::__construct()
HTMLPurifier_DefinitionCache::add()
HTMLPurifier_DefinitionCache::checkDefType()
HTMLPurifier_DefinitionCache::cleanup()
HTMLPurifier_DefinitionCache::flush()
HTMLPurifier_DefinitionCache::generateKey()
HTMLPurifier_DefinitionCache::get()
HTMLPurifier_DefinitionCache::isOld()
HTMLPurifier_DefinitionCache::remove()
HTMLPurifier_DefinitionCache::replace()
HTMLPurifier_DefinitionCache::set()

Class HTMLPurifier_DefinitionCache_Decorator

Inherited Variables

Inherited Methods