PHP Class HTMLPurifier_DefinitionCache, yii

Public Properties

Property	Type	Description
$type

Method	Description
__construct ( string $type )
add ( HTMLPurifier_Definition $def, HTMLPurifier_Config $config )	Adds a definition object to the cache
checkDefType ( HTMLPurifier_Definition $def ) : boolean	Checks if a definition's type jives with the cache's type
cleanup ( HTMLPurifier_Config $config )	Clears all expired (older version or revision) objects from cache
flush ( HTMLPurifier_Config $config )	Clears all objects from cache
generateKey ( HTMLPurifier_Config $config ) : string	Generates a unique identifier for a particular configuration
get ( HTMLPurifier_Config $config )	Retrieves a definition object from the cache
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.
remove ( HTMLPurifier_Config $config )	Removes a definition object to the cache
replace ( HTMLPurifier_Definition $def, HTMLPurifier_Config $config )	Replace an object in the cache
set ( HTMLPurifier_Definition $def, HTMLPurifier_Config $config )	Unconditionally saves a definition object to the cache

public __construct ( string $type )
$type	string	Type of definition objects this instance of the cache will handle.

Adds a definition object to the cache

abstract public add ( HTMLPurifier_Definition $def, HTMLPurifier_Config $config )
$def	HTMLPurifier_Definition
$config	HTMLPurifier_Config

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

public checkDefType ( HTMLPurifier_Definition $def ) : boolean
$def	HTMLPurifier_Definition	Definition object to check
return	boolean	true if good, false if not

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

abstract public cleanup ( HTMLPurifier_Config $config )
$config	HTMLPurifier_Config

Clears all objects from cache

abstract public flush ( HTMLPurifier_Config $config )
$config	HTMLPurifier_Config

Generates a unique identifier for a particular configuration

public generateKey ( HTMLPurifier_Config $config ) : string
$config	HTMLPurifier_Config	Instance of HTMLPurifier_Config
return	string

Retrieves a definition object from the cache

abstract public get ( HTMLPurifier_Config $config )
$config	HTMLPurifier_Config

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 ) : boolean
$key	string	Key to test
$config	HTMLPurifier_Config	Instance of HTMLPurifier_Config to test against
return	boolean

Removes a definition object to the cache

abstract public remove ( HTMLPurifier_Config $config )
$config	HTMLPurifier_Config

Replace an object in the cache

abstract public replace ( HTMLPurifier_Definition $def, HTMLPurifier_Config $config )
$def	HTMLPurifier_Definition
$config	HTMLPurifier_Config

Unconditionally saves a definition object to the cache

abstract public set ( HTMLPurifier_Definition $def, HTMLPurifier_Config $config )
$def	HTMLPurifier_Definition
$config	HTMLPurifier_Config

public $type