HTMLPurifier_DefinitionCache_Decorator Class Reference

Inheritance diagram for HTMLPurifier_DefinitionCache_Decorator:

Collaboration diagram for HTMLPurifier_DefinitionCache_Decorator:

Public Member Functions
	__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
	$cache
	Cache object we are decorating @type HTMLPurifier_DefinitionCache. More...
	$name
Data Fields inherited from HTMLPurifier_DefinitionCache
	$type
	@type string More...

Detailed Description

Definition at line 3 of file Decorator.php.

Constructor & Destructor Documentation

__construct()

HTMLPurifier_DefinitionCache_Decorator::__construct

(

)

Definition at line 18 of file Decorator.php.

    {
    }

Member Function Documentation

add()

HTMLPurifier_DefinitionCache_Decorator::add	(		$def,
			$config
	)

Parameters

HTMLPurifier_Definition	$def
HTMLPurifier_Config	$config

Returns

mixed

Reimplemented from HTMLPurifier_DefinitionCache.

Reimplemented in HTMLPurifier_DefinitionCache_Decorator_Cleanup, and HTMLPurifier_DefinitionCache_Decorator_Memory.

Definition at line 50 of file Decorator.php.

    {
        return $this->cache->add($def, $config);
    }

cleanup()

HTMLPurifier_DefinitionCache_Decorator::cleanup

(

$config

)

Parameters

HTMLPurifier_Config

$config

Returns

mixed

Reimplemented from HTMLPurifier_DefinitionCache.

Definition at line 106 of file Decorator.php.

    {
        return $this->cache->cleanup($config);
    }

copy()

HTMLPurifier_DefinitionCache_Decorator::copy

(

)

Cross-compatible clone substitute.

Returns

HTMLPurifier_DefinitionCache_Decorator

Reimplemented in HTMLPurifier_DefinitionCache_Decorator_Cleanup, and HTMLPurifier_DefinitionCache_Decorator_Memory.

Definition at line 40 of file Decorator.php.

    {
        return new HTMLPurifier_DefinitionCache_Decorator();
    }

Referenced by decorate().

Here is the caller graph for this function:

decorate()

HTMLPurifier_DefinitionCache_Decorator::decorate

(

&

$cache

)

Lazy decorator function.

Parameters

HTMLPurifier_DefinitionCache

$cache

Reference to cache object to decorate

Returns

HTMLPurifier_DefinitionCache_Decorator

Definition at line 27 of file Decorator.php.

    {
        $decorator = $this->copy();
        // reference is necessary for mocks in PHP 4
        $decorator->cache =& $cache;
        $decorator->type = $cache->type;
        return $decorator;
    }

References $cache, and copy().

Here is the call graph for this function:

flush()

HTMLPurifier_DefinitionCache_Decorator::flush

(

$config

)

Parameters

HTMLPurifier_Config

$config

Returns

mixed

Reimplemented from HTMLPurifier_DefinitionCache.

Definition at line 97 of file Decorator.php.

    {
        return $this->cache->flush($config);
    }

get()

HTMLPurifier_DefinitionCache_Decorator::get

(

$config

)

Parameters

HTMLPurifier_Config

$config

Returns

mixed

Reimplemented from HTMLPurifier_DefinitionCache.

Reimplemented in HTMLPurifier_DefinitionCache_Decorator_Cleanup, and HTMLPurifier_DefinitionCache_Decorator_Memory.

Definition at line 79 of file Decorator.php.

    {
        return $this->cache->get($config);
    }

remove()

HTMLPurifier_DefinitionCache_Decorator::remove

(

$config

)

Parameters

HTMLPurifier_Config

$config

Returns

mixed

Reimplemented from HTMLPurifier_DefinitionCache.

Definition at line 88 of file Decorator.php.

    {
        return $this->cache->remove($config);
    }

replace()

HTMLPurifier_DefinitionCache_Decorator::replace	(		$def,
			$config
	)

Parameters

HTMLPurifier_Definition	$def
HTMLPurifier_Config	$config

Returns

mixed

Reimplemented from HTMLPurifier_DefinitionCache.

Reimplemented in HTMLPurifier_DefinitionCache_Decorator_Cleanup, and HTMLPurifier_DefinitionCache_Decorator_Memory.

Definition at line 70 of file Decorator.php.

    {
        return $this->cache->replace($def, $config);
    }

set()

HTMLPurifier_DefinitionCache_Decorator::set	(		$def,
			$config
	)

Parameters

HTMLPurifier_Definition	$def
HTMLPurifier_Config	$config

Returns

mixed

Reimplemented from HTMLPurifier_DefinitionCache.

Reimplemented in HTMLPurifier_DefinitionCache_Decorator_Cleanup, and HTMLPurifier_DefinitionCache_Decorator_Memory.

Definition at line 60 of file Decorator.php.

    {
        return $this->cache->set($def, $config);
    }

Field Documentation

$cache

HTMLPurifier_DefinitionCache_Decorator::$cache

Cache object we are decorating @type HTMLPurifier_DefinitionCache.

Definition at line 10 of file Decorator.php.

Referenced by decorate().

$name

HTMLPurifier_DefinitionCache_Decorator::$name

Definition at line 16 of file Decorator.php.

---

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

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