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 ()

	add ($def, $config)

	set ($def, $config)

	replace ($def, $config)

	get ($config)

Public Member Functions inherited from HTMLPurifier_DefinitionCache_Decorator
	__construct ()

	decorate (&$cache)
	Lazy decorator function. More...

	copy ()
	Cross-compatible clone substitute. More...

	add ($def, $config)

	set ($def, $config)

	replace ($def, $config)

	get ($config)

	remove ($config)

	flush ($config)

	cleanup ($config)

Public Member Functions inherited from HTMLPurifier_DefinitionCache
	__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
	$name = 'Cleanup'

Data Fields inherited from HTMLPurifier_DefinitionCache_Decorator
	$cache
	Cache object we are decorating. More...

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

◆ add()

HTMLPurifier_DefinitionCache_Decorator_Cleanup::add	(	$def,
		$config
	)

Definition at line 17 of file Cleanup.php.

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

◆ copy()

HTMLPurifier_DefinitionCache_Decorator_Cleanup::copy ( )

Definition at line 13 of file Cleanup.php.

                            {
         return new HTMLPurifier_DefinitionCache_Decorator_Cleanup();
     }

◆ get()

HTMLPurifier_DefinitionCache_Decorator_Cleanup::get ( $config )

Definition at line 35 of file Cleanup.php.

References $ret.

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

◆ replace()

HTMLPurifier_DefinitionCache_Decorator_Cleanup::replace	(	$def,
		$config
	)

Definition at line 29 of file Cleanup.php.

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

◆ set()

HTMLPurifier_DefinitionCache_Decorator_Cleanup::set	(	$def,
		$config
	)

Definition at line 23 of file Cleanup.php.

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

Field Documentation

◆ $name

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

Public Member Functions

Data Fields