Docs For Class HTMLPurifier

Description

Located in /library/HTMLPurifier/HTMLModuleManager.php (line 3)

Variable Summary

mixed $attrCollections

mixed $attrTypes

mixed $contentSets

mixed $doctype

mixed $doctypes

mixed $elementLookup

mixed $modules

mixed $prefixes

mixed $registeredModules

mixed $trusted

mixed $userModules

Method Summary

HTMLPurifier_HTMLModuleManager __construct ()

void addModule ( $module)

void addPrefix ( $prefix)

Merged getElement ($name $name, [$trusted $trusted = null])

Array getElements ()

void processModule ( $module)

void registerModule ($module $module, [$overload $overload = false])

void setup ($config $config)

Variables

mixed $attrCollections (line 51)

< Instance of HTMLPurifier_ContentSets

access: public

mixed $attrTypes (line 19)

Instance of HTMLPurifier_AttrTypes

access: public

mixed $contentSets (line 50)

access: public

mixed $doctype (line 14)

Instance of current doctype

access: public

mixed $doctypes (line 9)

Instance of HTMLPurifier_DoctypeRegistry

access: public

mixed $elementLookup = array() (line 45)

Associative array of element name to list of modules that have definitions for the element; this array is dynamically filled.

access: public

mixed $modules = array() (line 25)

Active instances of modules for the specified doctype are indexed, by name, in this array.

access: public

mixed $prefixes = array('HTMLPurifier_HTMLModule_') (line 48)

List of prefixes we should use for registering small names

access: public

mixed $registeredModules = array() (line 32)

Array of recognized HTMLPurifier_Module instances, indexed by module's class name. user can overload a module by pre-emptively registering it.

Array of recognized HTMLPurifier_Module instances, indexed by module's class name. This array is usually lazy loaded, but a user can overload a module by pre-emptively registering it.

access: public

mixed $trusted = false (line 54)

If set to true, unsafe elements and attributes will be allowed

access: public

mixed $userModules = array() (line 39)

List of extra modules that were added by the user using addModule().

List of extra modules that were added by the user using addModule(). These get unconditionally merged into the current doctype, whatever it may be.

access: public

Methods

Constructor __construct (line 56)

access: public

HTMLPurifier_HTMLModuleManager __construct ()

addModule (line 177)

Adds a module to the current doctype by first registering it,

Adds a module to the current doctype by first registering it, and then tacking it on to the active doctype

access: public

void addModule ( $module)

$module

addPrefix (line 187)

Adds a class prefix that registerModule() will use to resolve a

Adds a class prefix that registerModule() will use to resolve a string name to a concrete class

access: public

void addPrefix ( $prefix)

$prefix

getElement (line 326)

Retrieves a single merged element definition

return: HTMLPurifier_ElementDef
access: public

Merged getElement ($name $name, [$trusted $trusted = null])

$name $name: Name of element
$trusted $trusted: Boolean trusted overriding parameter: set to true if you want the full version of an element

getElements (line 295)

Retrieves merged element definitions.

return: of HTMLPurifier_ElementDef
access: public

Array getElements ()

processModule (line 284)

Takes a module and adds it to the active module collection, registering it if necessary.

access: public

void processModule ( $module)

$module

registerModule (line 141)

Registers a module to the recognized module list, useful for overloading pre-existing modules.

access: public

void registerModule ($module $module, [$overload $overload = false])

$module $module: Mixed: string module name, with or without HTMLPurifier_HTMLModule prefix, or instance of subclass of HTMLPurifier_HTMLModule.
$overload $overload: Boolean whether or not to overload previous modules. If this is not set, and you do overload a module, HTML Purifier will complain with a warning.

setup (line 196)

Performs processing on modules, after being called you may

Performs processing on modules, after being called you may use getElement() and getElements()

access: public

void setup ($config $config)

$config $config: Instance of HTMLPurifier_Config

Class HTMLPurifier_HTMLModuleManager