HTMLPurifier 4.4.0
HTMLPurifier_Definition Class Reference

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

Inheritance diagram for HTMLPurifier_Definition:
HTMLPurifier_CSSDefinition HTMLPurifier_CSSDefinition HTMLPurifier_HTMLDefinition HTMLPurifier_HTMLDefinition HTMLPurifier_URIDefinition HTMLPurifier_URIDefinition

List of all members.

Public Member Functions

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

Public Attributes

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

Protected Member Functions

 doSetup ($config)
 Sets up the definition object into the final form, something not done by the constructor.
 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) [abstract, protected]

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

Parameters:
$configHTMLPurifier_Config instance

Reimplemented in HTMLPurifier_CSSDefinition, HTMLPurifier_HTMLDefinition, HTMLPurifier_URIDefinition, HTMLPurifier_CSSDefinition, HTMLPurifier_HTMLDefinition, and HTMLPurifier_URIDefinition.

Referenced by setup().

HTMLPurifier_Definition::doSetup ( config) [abstract, protected]

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

Parameters:
$configHTMLPurifier_Config instance

Reimplemented in HTMLPurifier_CSSDefinition, HTMLPurifier_HTMLDefinition, HTMLPurifier_URIDefinition, HTMLPurifier_CSSDefinition, HTMLPurifier_HTMLDefinition, and HTMLPurifier_URIDefinition.

HTMLPurifier_Definition::setup ( config)

Setup function that aborts if already setup.

Parameters:
$configHTMLPurifier_Config instance

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

References $config, doSetup(), and setup().

HTMLPurifier_Definition::setup ( config)

Setup function that aborts if already setup.

Parameters:
$configHTMLPurifier_Config instance

Definition at line 42 of file Definition.php.

References $config, and doSetup().

Referenced by setup().


Member Data 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.

Definition at line 24 of file Definition.php.

HTMLPurifier_Definition::$setup = false

Has setup() been called yet?

Definition at line 13 of file Definition.php.

HTMLPurifier_Definition::$type

What type of definition is it?

Reimplemented in HTMLPurifier_CSSDefinition, HTMLPurifier_HTMLDefinition, and HTMLPurifier_URIDefinition.

Definition at line 29 of file Definition.php.


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