HTMLPurifier_DefinitionCache_Serializer Class Reference

Inheritance diagram for HTMLPurifier_DefinitionCache_Serializer:

Public Member Functions
	add ($def, $config)
	Adds a definition object to the cache.
	checkDefType ($def)
	Checks if a definition's type jives with the cache's type.
	cleanup ($config)
	flush ($config)
	generateBaseDirectoryPath ($config)
	Generates path to base directory that contains all definition type serials.
	generateDirectoryPath ($config)
	Generates the path to the directory contain this cache's serial files.
	generateFilePath ($config)
	Generates the file path to the serial file corresponding to the configuration and definition name.
	generateKey ($config)
	Generates a unique identifier for a particular configuration.
	get ($config)
	isOld ($key, $config)
	Tests whether or not a key is old with respect to the configuration's version and revision number.
	remove ($config)
	replace ($def, $config)
	set ($def, $config)

Public Attributes
	$type
	@type string

Member Function Documentation

add()

HTMLPurifier_DefinitionCache_Serializer::add	(		$def,
			$config )

Adds a definition object to the cache.

Parameters

HTMLPurifier_Definition	$def
HTMLPurifier_Config	$config

Reimplemented from HTMLPurifier_DefinitionCache.

checkDefType()

HTMLPurifier_DefinitionCache::checkDefType ( $def )

inherited

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

Note

Throws an error on failure

Parameters

HTMLPurifier_Definition

$def

Definition object to check

Return values

bool	true if good, false if not

cleanup()

HTMLPurifier_DefinitionCache_Serializer::cleanup

(

$config

)

Parameters

HTMLPurifier_Config

$config

Return values

bool

Reimplemented from HTMLPurifier_DefinitionCache.

flush()

HTMLPurifier_DefinitionCache_Serializer::flush

(

$config

)

Parameters

HTMLPurifier_Config

$config

Return values

bool

Reimplemented from HTMLPurifier_DefinitionCache.

generateBaseDirectoryPath()

HTMLPurifier_DefinitionCache_Serializer::generateBaseDirectoryPath

(

$config

)

Generates path to base directory that contains all definition type serials.

Parameters

HTMLPurifier_Config

$config

Return values

mixed|string

Todo

Make protected

generateDirectoryPath()

HTMLPurifier_DefinitionCache_Serializer::generateDirectoryPath

(

$config

)

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

Parameters

HTMLPurifier_Config

$config

Return values

string

Note

No trailing slash

Todo

Make protected

generateFilePath()

HTMLPurifier_DefinitionCache_Serializer::generateFilePath

(

$config

)

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

Parameters

HTMLPurifier_Config

$config

Return values

string

Todo

Make protected

generateKey()

HTMLPurifier_DefinitionCache::generateKey ( $config )

inherited

Generates a unique identifier for a particular configuration.

Parameters

HTMLPurifier_Config

$config

Instance of HTMLPurifier_Config

Return values

string

get()

HTMLPurifier_DefinitionCache_Serializer::get

(

$config

)

Parameters

HTMLPurifier_Config

$config

Return values

bool|HTMLPurifier_Config

Reimplemented from HTMLPurifier_DefinitionCache.

isOld()

HTMLPurifier_DefinitionCache::isOld ( $key, $config )

inherited

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

Return values

bool

remove()

HTMLPurifier_DefinitionCache_Serializer::remove

(

$config

)

Parameters

HTMLPurifier_Config

$config

Return values

bool

Reimplemented from HTMLPurifier_DefinitionCache.

replace()

HTMLPurifier_DefinitionCache_Serializer::replace	(		$def,
			$config )

Parameters

HTMLPurifier_Definition	$def
HTMLPurifier_Config	$config

Return values

int|bool

Reimplemented from HTMLPurifier_DefinitionCache.

set()

HTMLPurifier_DefinitionCache_Serializer::set	(		$def,
			$config )

Parameters

HTMLPurifier_Definition	$def
HTMLPurifier_Config	$config

Return values

int|bool

Reimplemented from HTMLPurifier_DefinitionCache.

---

The documentation for this class was generated from the following file:

• lib/htmlpurifier/HTMLPurifier/DefinitionCache/Serializer.php