HTMLPurifier_DefinitionCacheFactory Class Reference

Responsible for creating definition caches. More...

Collaboration diagram for HTMLPurifier_DefinitionCacheFactory:

Public Member Functions
	setup ()
	Initialize default decorators. More...
	register ($short, $long)
	Registers a new definition cache object. More...
	create ($type, $config)
	Factory method that creates a cache object based on configuration. More...
	addDecorator ($decorator)
	Registers a decorator to add to all new cache objects. More...

Static Public Member Functions
static	instance ($prototype=null)
	Retrieves an instance of global definition cache factory. More...

Protected Attributes
	$caches = array('Serializer' => array())
	@type array More...
	$implementations = array()
	@type array More...
	$decorators = array()
	@type HTMLPurifier_DefinitionCache_Decorator[] More...

Detailed Description

Responsible for creating definition caches.

Definition at line 6 of file DefinitionCacheFactory.php.

Member Function Documentation

addDecorator()

HTMLPurifier_DefinitionCacheFactory::addDecorator

(

$decorator

)

Registers a decorator to add to all new cache objects.

Parameters

HTMLPurifier_DefinitionCache_Decorator | string

$decorator

An instance or the name of a decorator

Definition at line 96 of file DefinitionCacheFactory.php.

    {
        if (is_string($decorator)) {
            $class = "HTMLPurifier_DefinitionCache_Decorator_$decorator";
            $decorator = new $class;
        }
        $this->decorators[$decorator->name] = $decorator;
    }

Referenced by setup().

Here is the caller graph for this function:

create()

HTMLPurifier_DefinitionCacheFactory::create	(		$type,
			$config
	)

Factory method that creates a cache object based on configuration.

Parameters

string	$type	Name of definitions handled by cache
HTMLPurifier_Config	$config	Config instance

Returns

mixed

Definition at line 64 of file DefinitionCacheFactory.php.

    {
        $method = $config->get('Cache.DefinitionImpl');
        if ($method === null) {
            return new HTMLPurifier_DefinitionCache_Null($type);
        }
        if (!empty($this->caches[$method][$type])) {
            return $this->caches[$method][$type];
        }
        if (isset($this->implementations[$method]) &&
            class_exists($class = $this->implementations[$method], false)) {
            $cache = new $class($type);
        } else {
            if ($method != 'Serializer') {
                trigger_error("Unrecognized DefinitionCache $method, using Serializer instead", E_USER_WARNING);
            }
            $cache = new HTMLPurifier_DefinitionCache_Serializer($type);
        }
        foreach ($this->decorators as $decorator) {
            $new_cache = $decorator->decorate($cache);
            // prevent infinite recursion in PHP 4
            unset($cache);
            $cache = $new_cache;
        }
        $this->caches[$method][$type] = $cache;
        return $this->caches[$method][$type];
    }

instance()

static HTMLPurifier_DefinitionCacheFactory::instance (   $prototype = null )

static

Retrieves an instance of global definition cache factory.

Parameters

HTMLPurifier_DefinitionCacheFactory

$prototype

Returns

HTMLPurifier_DefinitionCacheFactory

Definition at line 36 of file DefinitionCacheFactory.php.

    {
        static $instance;
        if ($prototype !== null) {
            $instance = $prototype;
        } elseif ($instance === null || $prototype === true) {
            $instance = new HTMLPurifier_DefinitionCacheFactory();
            $instance->setup();
        }
        return $instance;
    }

Referenced by HTMLPurifier_Config\getDefinition().

Here is the caller graph for this function:

register()

HTMLPurifier_DefinitionCacheFactory::register	(		$short,
			$long
	)

Registers a new definition cache object.

Parameters

string	$short	Short name of cache object, for reference
string	$long	Full class name of cache object, for construction

Definition at line 53 of file DefinitionCacheFactory.php.

    {
        $this->implementations[$short] = $long;
    }

setup()

HTMLPurifier_DefinitionCacheFactory::setup

(

)

Initialize default decorators.

Definition at line 26 of file DefinitionCacheFactory.php.

    {
        $this->addDecorator('Cleanup');
    }

References addDecorator().

Here is the call graph for this function:

Field Documentation

$caches

HTMLPurifier_DefinitionCacheFactory::$caches = array('Serializer' => array())

protected

@type array

Definition at line 11 of file DefinitionCacheFactory.php.

$decorators

HTMLPurifier_DefinitionCacheFactory::$decorators = array()

protected

@type HTMLPurifier_DefinitionCache_Decorator[]

Definition at line 21 of file DefinitionCacheFactory.php.

$implementations

HTMLPurifier_DefinitionCacheFactory::$implementations = array()

protected

@type array

Definition at line 16 of file DefinitionCacheFactory.php.

---

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

• Services/Html/HtmlPurifier/library/HTMLPurifier/DefinitionCacheFactory.php