HTMLPurifier_DefinitionCache_Decorator_Cleanup Class Reference

Definition cache decorator class that cleans up the cache whenever there is a cache miss. More...

Inheritance diagram for HTMLPurifier_DefinitionCache_Decorator_Cleanup:

Collaboration diagram for HTMLPurifier_DefinitionCache_Decorator_Cleanup:

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

Data Fields
	$name = 'Cleanup'
Data Fields inherited from HTMLPurifier_DefinitionCache_Decorator
	$cache
	Cache object we are decorating.
Data Fields inherited from HTMLPurifier_DefinitionCache
	$type

Detailed Description

Definition cache decorator class that cleans up the cache whenever there is a cache miss.

Definition at line 7 of file Cleanup.php.

Member Function Documentation

HTMLPurifier_DefinitionCache_Decorator_Cleanup::add	(		$def,
			$config
	)

Adds a definition object to the cache.

Reimplemented from HTMLPurifier_DefinitionCache_Decorator.

Definition at line 17 of file Cleanup.php.

References $config, and HTMLPurifier_DefinitionCache_Decorator\cleanup().

                                       {
        $status = parent::add($def, $config);
        if (!$status) parent::cleanup($config);
        return $status;
    }

Here is the call graph for this function:

HTMLPurifier_DefinitionCache_Decorator_Cleanup::copy

(

)

Cross-compatible clone substitute.

Reimplemented from HTMLPurifier_DefinitionCache_Decorator.

Definition at line 13 of file Cleanup.php.

                           {
        return new HTMLPurifier_DefinitionCache_Decorator_Cleanup();
    }

HTMLPurifier_DefinitionCache_Decorator_Cleanup::get

(

$config

)

Retrieves a definition object from the cache.

Reimplemented from HTMLPurifier_DefinitionCache_Decorator.

Definition at line 35 of file Cleanup.php.

References $config, $ret, and HTMLPurifier_DefinitionCache_Decorator\cleanup().

                                 {
        $ret = parent::get($config);
        if (!$ret) parent::cleanup($config);
        return $ret;
    }

Here is the call graph for this function:

HTMLPurifier_DefinitionCache_Decorator_Cleanup::replace	(		$def,
			$config
	)

Replace an object in the cache.

Reimplemented from HTMLPurifier_DefinitionCache_Decorator.

Definition at line 29 of file Cleanup.php.

References $config, and HTMLPurifier_DefinitionCache_Decorator\cleanup().

                                           {
        $status = parent::replace($def, $config);
        if (!$status) parent::cleanup($config);
        return $status;
    }

Here is the call graph for this function:

HTMLPurifier_DefinitionCache_Decorator_Cleanup::set	(		$def,
			$config
	)

Unconditionally saves a definition object to the cache.

Reimplemented from HTMLPurifier_DefinitionCache_Decorator.

Definition at line 23 of file Cleanup.php.

References $config, and HTMLPurifier_DefinitionCache_Decorator\cleanup().

                                       {
        $status = parent::set($def, $config);
        if (!$status) parent::cleanup($config);
        return $status;
    }

Here is the call graph for this function:

Field Documentation

HTMLPurifier_DefinitionCache_Decorator_Cleanup::$name = 'Cleanup'

Definition at line 11 of file Cleanup.php.

---

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

• Services/Html/HtmlPurifier/library/HTMLPurifier/DefinitionCache/Decorator/Cleanup.php