HTMLPurifier_DefinitionCache Class Reference

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

Inheritance diagram for HTMLPurifier_DefinitionCache:

Collaboration diagram for HTMLPurifier_DefinitionCache:

Public Member Functions
	__construct ($type)
	generateKey ($config)
	Generates a unique identifier for a particular configuration. More...
	isOld ($key, $config)
	Tests whether or not a key is old with respect to the configuration's version and revision number. More...
	checkDefType ($def)
	Checks if a definition's type jives with the cache's type. More...
	add ($def, $config)
	Adds a definition object to the cache. More...
	set ($def, $config)
	Unconditionally saves a definition object to the cache. More...
	replace ($def, $config)
	Replace an object in the cache. More...
	get ($config)
	Retrieves a definition object from the cache. More...
	remove ($config)
	Removes a definition object to the cache. More...
	flush ($config)
	Clears all objects from cache. More...
	cleanup ($config)
	Clears all expired (older version or revision) objects from cache. More...

Data Fields
	$type
	string More...

Detailed Description

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

Todo:

Create a separate maintenance file advanced users can use to cache their custom HTMLDefinition, which can be loaded via a configuration directive

Implement memcached

Definition at line 11 of file DefinitionCache.php.

Constructor & Destructor Documentation

__construct()

HTMLPurifier_DefinitionCache::__construct

(

$type

)

Parameters

string

$type

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

Definition at line 22 of file DefinitionCache.php.

References $type.

    {
        $this->type = $type;
    }

Member Function Documentation

add()

HTMLPurifier_DefinitionCache::add (   $def,   $config  )

abstract

Adds a definition object to the cache.

Parameters

HTMLPurifier_Definition	$def
HTMLPurifier_Config	$config

Referenced by checkDefType().

Here is the caller graph for this function:

checkDefType()

HTMLPurifier_DefinitionCache::checkDefType

(

$def

)

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

Returns

bool true if good, false if not

Definition at line 71 of file DefinitionCache.php.

References $config, $def, add(), cleanup(), flush(), and replace().

Referenced by HTMLPurifier_DefinitionCache_Serializer\add(), HTMLPurifier_DefinitionCache_Serializer\replace(), and HTMLPurifier_DefinitionCache_Serializer\set().

    {
        if ($def->type !== $this->type) {
            trigger_error("Cannot use definition of type {$def->type} in cache for {$this->type}");
            return false;
        }
        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

cleanup()

HTMLPurifier_DefinitionCache::cleanup (   $config )

abstract

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

Note

Be careful implementing this method as flush. Flush must not interfere with other Definition types, and cleanup() should not be repeatedly called by userland code.

Parameters

HTMLPurifier_Config

$config

Referenced by checkDefType().

Here is the caller graph for this function:

flush()

HTMLPurifier_DefinitionCache::flush (   $config )

abstract

Clears all objects from cache.

Parameters

HTMLPurifier_Config

$config

Referenced by checkDefType().

Here is the caller graph for this function:

generateKey()

HTMLPurifier_DefinitionCache::generateKey

(

$config

)

Generates a unique identifier for a particular configuration.

Parameters

HTMLPurifier_Config

$config

Instance of HTMLPurifier_Config

Returns

string

Definition at line 32 of file DefinitionCache.php.

References $config.

Referenced by HTMLPurifier_DefinitionCache_Decorator_Memory\add(), HTMLPurifier_DefinitionCache_Serializer\generateFilePath(), HTMLPurifier_DefinitionCache_Decorator_Memory\get(), HTMLPurifier_DefinitionCache_Decorator_Memory\replace(), and HTMLPurifier_DefinitionCache_Decorator_Memory\set().

    {
        return $config->version . ',' . // possibly replace with function calls
               $config->getBatchSerial($this->type) . ',' .
               $config->get($this->type . '.DefinitionRev');
    }

Here is the caller graph for this function:

get()

HTMLPurifier_DefinitionCache::get (   $config )

abstract

Retrieves a definition object from the cache.

Parameters

HTMLPurifier_Config

$config

isOld()

HTMLPurifier_DefinitionCache::isOld	(		$key,
			$config
	)

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

bool

Definition at line 46 of file DefinitionCache.php.

References $config, $key, and $version.

Referenced by HTMLPurifier_DefinitionCache_Serializer\cleanup().

    {
        if (substr_count($key, ',') < 2) {
            return true;
        }
        list($version, $hash, $revision) = explode(',', $key, 3);
        $compare = version_compare($version, $config->version);
        // version mismatch, is always old
        if ($compare != 0) {
            return true;
        }
        // versions match, ids match, check revision number
        if ($hash == $config->getBatchSerial($this->type) &&
            $revision < $config->get($this->type . '.DefinitionRev')) {
            return true;
        }
        return false;
    }

Here is the caller graph for this function:

remove()

HTMLPurifier_DefinitionCache::remove (   $config )

abstract

Removes a definition object to the cache.

Parameters

HTMLPurifier_Config

$config

replace()

HTMLPurifier_DefinitionCache::replace (   $def,   $config  )

abstract

Replace an object in the cache.

Parameters

HTMLPurifier_Definition	$def
HTMLPurifier_Config	$config

Referenced by checkDefType().

Here is the caller graph for this function:

set()

HTMLPurifier_DefinitionCache::set (   $def,   $config  )

abstract

Unconditionally saves a definition object to the cache.

Parameters

HTMLPurifier_Definition	$def
HTMLPurifier_Config	$config

Field Documentation

$type

HTMLPurifier_DefinitionCache::$type

string

Definition at line 16 of file DefinitionCache.php.

Referenced by __construct(), and HTMLPurifier_DefinitionCache_Serializer\generateDirectoryPath().

---

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

• libs/composer/vendor/ezyang/htmlpurifier/library/HTMLPurifier/DefinitionCache.php