Docs For Class HTMLPurifier_DefinitionCache

Description

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

Located in /library/HTMLPurifier/DefinitionCache/Serializer.php (line 3)

HTMLPurifier_DefinitionCache
   |
   --HTMLPurifier_DefinitionCache_Serializer

Method Summary

void add ( $def, $config)

void cleanup ( $config)

void flush ( $config)

void generateBaseDirectoryPath ( $config)

void generateDirectoryPath ( $config)

void generateFilePath ( $config)

void get ( $config)

void remove ( $config)

void replace ( $def, $config)

void set ( $def, $config)

Variables

Inherited Variables

Inherited from HTMLPurifier_DefinitionCache

HTMLPurifier_DefinitionCache::$type

Methods

add (line 7)

access: public

void add ( $def, $config)

$def
$config

Redefinition of:

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

cleanup (line 53)

access: public

void cleanup ( $config)

$config

Redefinition of:

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

flush (line 42)

access: public

void flush ( $config)

$config

Redefinition of:

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

generateBaseDirectoryPath (line 90)

Generates path to base directory that contains all definition type

Generates path to base directory that contains all definition type serials

todo: Make protected
access: public

void generateBaseDirectoryPath ( $config)

$config

generateDirectoryPath (line 80)

Generates the path to the directory contain this cache's serial files

todo: Make protected
access: public

void generateDirectoryPath ( $config)

$config

generateFilePath (line 70)

Generates the file path to the serial file corresponding to

Generates the file path to the serial file corresponding to the configuration and definition name

todo: Make protected
access: public

void generateFilePath ( $config)

$config

get (line 30)

access: public

void get ( $config)

$config

Redefinition of:

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

remove (line 36)

access: public

void remove ( $config)

$config

Redefinition of:

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

replace (line 22)

access: public

void replace ( $def, $config)

$def
$config

Redefinition of:

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

set (line 15)

access: public

void set ( $def, $config)

$def
$config

Redefinition of:

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

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_Serializer

Inherited Variables

Inherited Methods