\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.

Summary

Methods
Properties
Constants
__construct()
decorate()
copy()
add()
set()
replace()
get()
remove()
flush()
cleanup()
generateKey()
isOld()
checkDefType()
$cache
$name
$type
No constants found
No protected methods found
$definitions
N/A
No private methods found
No private properties found
N/A

Properties

$cache

$cache : 

Cache object we are decorating

Type

$name

$name : string

The name of the decorator

Type

string

$type

$type : 

Type

$definitions

$definitions : 

Type

Methods

__construct()

__construct(string  $type) 

Parameters

string $type

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

get()

get(\HTMLPurifier_Config  $config) : mixed

Retrieves a definition object from the cache

Parameters

\HTMLPurifier_Config $config

Returns

mixed

remove()

remove(\HTMLPurifier_Config  $config) 

Removes a definition object to the cache

Parameters

\HTMLPurifier_Config $config

flush()

flush(\HTMLPurifier_Config  $config) 

Clears all objects from cache

Parameters

\HTMLPurifier_Config $config

cleanup()

cleanup(\HTMLPurifier_Config  $config) 

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

Parameters

\HTMLPurifier_Config $config

generateKey()

generateKey(\HTMLPurifier_Config  $config) : string

Generates a unique identifier for a particular configuration

Parameters

\HTMLPurifier_Config $config

Instance of HTMLPurifier_Config

Returns

string

isOld()

isOld(string  $key, \HTMLPurifier_Config  $config) : boolean

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

boolean

checkDefType()

checkDefType(\HTMLPurifier_Definition  $def) : boolean

Checks if a definition's type jives with the cache's type

Parameters

\HTMLPurifier_Definition $def

Definition object to check

Returns

boolean —

true if good, false if not