HTMLPurifier_DefinitionCache_Decorator Class Reference

Inheritance diagram for HTMLPurifier_DefinitionCache_Decorator:

List of all members.

Public Member Functions
	__construct ()
	decorate (&$cache)
	Lazy decorator function.
	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.
	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.
	__construct ()
	decorate (&$cache)
	Lazy decorator function.
	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.
	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 Attributes
	$cache
	Cache object we are decorating.

---

Detailed Description

Definition at line 3 of file Decorator.php.

---

Constructor & Destructor Documentation

HTMLPurifier_DefinitionCache_Decorator::__construct

(

)

Definition at line 11 of file Decorator.php.

HTMLPurifier_DefinitionCache_Decorator::__construct

(

)

Definition at line 12057 of file HTMLPurifier.standalone.php.

---

Member Function Documentation

HTMLPurifier_DefinitionCache_Decorator::add	(	$	def,
		$	config
	)

Adds a definition object to the cache.

Reimplemented from HTMLPurifier_DefinitionCache.

Reimplemented in HTMLPurifier_DefinitionCache_Decorator_Cleanup, HTMLPurifier_DefinitionCache_Decorator_Memory, HTMLPurifier_DefinitionCache_Decorator_Cleanup, and HTMLPurifier_DefinitionCache_Decorator_Memory.

Definition at line 32 of file Decorator.php.

References $config, and $def.

HTMLPurifier_DefinitionCache_Decorator::add	(	$	def,
		$	config
	)

Adds a definition object to the cache.

Reimplemented from HTMLPurifier_DefinitionCache.

Reimplemented in HTMLPurifier_DefinitionCache_Decorator_Cleanup, HTMLPurifier_DefinitionCache_Decorator_Memory, HTMLPurifier_DefinitionCache_Decorator_Cleanup, and HTMLPurifier_DefinitionCache_Decorator_Memory.

Definition at line 12078 of file HTMLPurifier.standalone.php.

References $config, and $def.

HTMLPurifier_DefinitionCache_Decorator::cleanup

(

$

config

)

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

Note:

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

Reimplemented from HTMLPurifier_DefinitionCache.

Definition at line 56 of file Decorator.php.

References $config.

Referenced by HTMLPurifier_DefinitionCache_Decorator_Cleanup::add(), HTMLPurifier_DefinitionCache_Decorator_Cleanup::get(), HTMLPurifier_DefinitionCache_Decorator_Cleanup::replace(), and HTMLPurifier_DefinitionCache_Decorator_Cleanup::set().

HTMLPurifier_DefinitionCache_Decorator::cleanup

(

$

config

)

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

Note:

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

Reimplemented from HTMLPurifier_DefinitionCache.

Definition at line 12102 of file HTMLPurifier.standalone.php.

References $config.

HTMLPurifier_DefinitionCache_Decorator::copy

(

)

Cross-compatible clone substitute.

Reimplemented in HTMLPurifier_DefinitionCache_Decorator_Cleanup, HTMLPurifier_DefinitionCache_Decorator_Memory, HTMLPurifier_DefinitionCache_Decorator_Cleanup, and HTMLPurifier_DefinitionCache_Decorator_Memory.

Definition at line 12074 of file HTMLPurifier.standalone.php.

HTMLPurifier_DefinitionCache_Decorator::copy

(

)

Cross-compatible clone substitute.

Reimplemented in HTMLPurifier_DefinitionCache_Decorator_Cleanup, HTMLPurifier_DefinitionCache_Decorator_Memory, HTMLPurifier_DefinitionCache_Decorator_Cleanup, and HTMLPurifier_DefinitionCache_Decorator_Memory.

Definition at line 28 of file Decorator.php.

Referenced by decorate().

HTMLPurifier_DefinitionCache_Decorator::decorate

(

&$

cache

)

Lazy decorator function.

Parameters:

$cache

Reference to cache object to decorate

Definition at line 17 of file Decorator.php.

References $cache, and copy().

HTMLPurifier_DefinitionCache_Decorator::decorate

(

&$

cache

)

Lazy decorator function.

Parameters:

$cache

Reference to cache object to decorate

Definition at line 12063 of file HTMLPurifier.standalone.php.

References $cache, and copy().

HTMLPurifier_DefinitionCache_Decorator::flush

(

$

config

)

Clears all objects from cache.

Reimplemented from HTMLPurifier_DefinitionCache.

Definition at line 12098 of file HTMLPurifier.standalone.php.

References $config.

HTMLPurifier_DefinitionCache_Decorator::flush

(

$

config

)

Clears all objects from cache.

Reimplemented from HTMLPurifier_DefinitionCache.

Definition at line 52 of file Decorator.php.

References $config.

HTMLPurifier_DefinitionCache_Decorator::get

(

$

config

)

Retrieves a definition object from the cache.

Reimplemented from HTMLPurifier_DefinitionCache.

Reimplemented in HTMLPurifier_DefinitionCache_Decorator_Cleanup, HTMLPurifier_DefinitionCache_Decorator_Memory, HTMLPurifier_DefinitionCache_Decorator_Cleanup, and HTMLPurifier_DefinitionCache_Decorator_Memory.

Definition at line 44 of file Decorator.php.

References $config.

HTMLPurifier_DefinitionCache_Decorator::get

(

$

config

)

Retrieves a definition object from the cache.

Reimplemented from HTMLPurifier_DefinitionCache.

Reimplemented in HTMLPurifier_DefinitionCache_Decorator_Cleanup, HTMLPurifier_DefinitionCache_Decorator_Memory, HTMLPurifier_DefinitionCache_Decorator_Cleanup, and HTMLPurifier_DefinitionCache_Decorator_Memory.

Definition at line 12090 of file HTMLPurifier.standalone.php.

References $config.

HTMLPurifier_DefinitionCache_Decorator::remove

(

$

config

)

Removes a definition object to the cache.

Reimplemented from HTMLPurifier_DefinitionCache.

Definition at line 48 of file Decorator.php.

References $config.

HTMLPurifier_DefinitionCache_Decorator::remove

(

$

config

)

Removes a definition object to the cache.

Reimplemented from HTMLPurifier_DefinitionCache.

Definition at line 12094 of file HTMLPurifier.standalone.php.

References $config.

HTMLPurifier_DefinitionCache_Decorator::replace	(	$	def,
		$	config
	)

Replace an object in the cache.

Reimplemented from HTMLPurifier_DefinitionCache.

Reimplemented in HTMLPurifier_DefinitionCache_Decorator_Cleanup, HTMLPurifier_DefinitionCache_Decorator_Memory, HTMLPurifier_DefinitionCache_Decorator_Cleanup, and HTMLPurifier_DefinitionCache_Decorator_Memory.

Definition at line 40 of file Decorator.php.

References $config, and $def.

HTMLPurifier_DefinitionCache_Decorator::replace	(	$	def,
		$	config
	)

Replace an object in the cache.

Reimplemented from HTMLPurifier_DefinitionCache.

Reimplemented in HTMLPurifier_DefinitionCache_Decorator_Cleanup, HTMLPurifier_DefinitionCache_Decorator_Memory, HTMLPurifier_DefinitionCache_Decorator_Cleanup, and HTMLPurifier_DefinitionCache_Decorator_Memory.

Definition at line 12086 of file HTMLPurifier.standalone.php.

References $config, and $def.

HTMLPurifier_DefinitionCache_Decorator::set	(	$	def,
		$	config
	)

Unconditionally saves a definition object to the cache.

Reimplemented from HTMLPurifier_DefinitionCache.

Reimplemented in HTMLPurifier_DefinitionCache_Decorator_Cleanup, HTMLPurifier_DefinitionCache_Decorator_Memory, HTMLPurifier_DefinitionCache_Decorator_Cleanup, and HTMLPurifier_DefinitionCache_Decorator_Memory.

Definition at line 36 of file Decorator.php.

References $config, and $def.

HTMLPurifier_DefinitionCache_Decorator::set	(	$	def,
		$	config
	)

Unconditionally saves a definition object to the cache.

Reimplemented from HTMLPurifier_DefinitionCache.

Reimplemented in HTMLPurifier_DefinitionCache_Decorator_Cleanup, HTMLPurifier_DefinitionCache_Decorator_Memory, HTMLPurifier_DefinitionCache_Decorator_Cleanup, and HTMLPurifier_DefinitionCache_Decorator_Memory.

Definition at line 12082 of file HTMLPurifier.standalone.php.

References $config, and $def.

---

Member Data Documentation

HTMLPurifier_DefinitionCache_Decorator::$cache

Cache object we are decorating.

Definition at line 9 of file Decorator.php.

Referenced by decorate().

---

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

• /home/ezyang/Dev/htmlpurifier/library/HTMLPurifier/DefinitionCache/Decorator.php
• /home/ezyang/Dev/htmlpurifier/library/HTMLPurifier.standalone.php