HTMLPurifier_Definition Class Reference

Super-class for definition datatype objects, implements serialization functions for the class. More...

Inheritance diagram for HTMLPurifier_Definition:

Collaboration diagram for HTMLPurifier_Definition:

Public Member Functions
	setup ($config)
	Setup function that aborts if already setup.

Data Fields
	$setup = false
	Has setup() been called yet? bool.
	$optimized = null
	If true, write out the final definition object to the cache after setup.
	$type
	What type of definition is it? string.

Protected Member Functions
	doSetup ($config)
	Sets up the definition object into the final form, something not done by the constructor.

Detailed Description

Super-class for definition datatype objects, implements serialization functions for the class.

Definition at line 7 of file Definition.php.

Member Function Documentation

HTMLPurifier_Definition::doSetup (   $config )

abstractprotected

Sets up the definition object into the final form, something not done by the constructor.

Parameters

HTMLPurifier_Config

$config

Reimplemented in HTMLPurifier_HTMLDefinition, HTMLPurifier_URIDefinition, and HTMLPurifier_CSSDefinition.

Referenced by setup().

Here is the caller graph for this function:

HTMLPurifier_Definition::setup

(

$config

)

Setup function that aborts if already setup.

Parameters

HTMLPurifier_Config

$config

Definition at line 45 of file Definition.php.

References doSetup().

    {
        if ($this->setup) {
            return;
        }
        $this->setup = true;
        $this->doSetup($config);
    }

Here is the call graph for this function:

Field Documentation

HTMLPurifier_Definition::$optimized = null

If true, write out the final definition object to the cache after setup.

This will be true only if all invocations to get a raw definition object are also optimized. This does not cause file system thrashing because on subsequent calls the cached object is used and any writes to the raw definition object are short circuited. See enduser-customize.html for the high-level picture. bool

Definition at line 26 of file Definition.php.

HTMLPurifier_Definition::$setup = false

Has setup() been called yet? bool.

Definition at line 14 of file Definition.php.

HTMLPurifier_Definition::$type

What type of definition is it? string.

Definition at line 32 of file Definition.php.

---

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

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