HTMLPurifier_HTMLModuleManager Class Reference

Public Member Functions
	__construct ()
	registerModule ($module, $overload=false)
	addModule ($module)
	addPrefix ($prefix)
	setup ($config)
	processModule ($module)
	getElements ()
	getElement ($name, $trusted=null)

Public Attributes
	$doctypes
	$doctype
	$attrTypes
	$modules = array()
	$registeredModules = array()
	$userModules = array()
	$elementLookup = array()
	$prefixes = array('HTMLPurifier_HTMLModule_')
	$contentSets
	$attrCollections
	$trusted = false

Detailed Description

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

Constructor & Destructor Documentation

__construct()

HTMLPurifier_HTMLModuleManager::__construct

(

)

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

Member Function Documentation

addModule()

HTMLPurifier_HTMLModuleManager::addModule

(

$module

)

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

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

addPrefix()

HTMLPurifier_HTMLModuleManager::addPrefix

(

$prefix

)

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

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

getElement()

HTMLPurifier_HTMLModuleManager::getElement	(		$name,
			$trusted = null
	)

Retrieves a single merged element definition

Parameters

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

Returns

HTMLPurifier_ElementDef Merged HTMLPurifier_ElementDef

Note

You may notice that modules are getting iterated over twice (once in getElements() and once here). This is because

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

getElements()

HTMLPurifier_HTMLModuleManager::getElements

(

)

Retrieves merged element definitions.

Returns

Array of HTMLPurifier_ElementDef

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

processModule()

HTMLPurifier_HTMLModuleManager::processModule

(

$module

)

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

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

registerModule()

HTMLPurifier_HTMLModuleManager::registerModule	(		$module,
			$overload = false
	)

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

Parameters

$module	Mixed: string module name, with or without HTMLPurifier_HTMLModule prefix, or instance of subclass of HTMLPurifier_HTMLModule.
$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.

Note

This function will not call autoload, you must instantiate (and thus invoke) autoload outside the method.

If a string is passed as a module name, different variants will be tested in this order:

• Check for HTMLPurifier_HTMLModule_$name
• Check all prefixes with $name in order they were added
• Check for literal object name
• Throw fatal error If your object name collides with an internal class, specify your module manually. All modules must have been included externally: registerModule will not perform inclusions for you!

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

setup()

HTMLPurifier_HTMLModuleManager::setup

(

$config

)

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

Parameters

HTMLPurifier_Config

$config

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

Member Data Documentation

$attrCollections

HTMLPurifier_HTMLModuleManager::$attrCollections

@type HTMLPurifier_AttrCollections

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

$attrTypes

HTMLPurifier_HTMLModuleManager::$attrTypes

@type HTMLPurifier_AttrTypes

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

$contentSets

HTMLPurifier_HTMLModuleManager::$contentSets

@type HTMLPurifier_ContentSets

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

$doctype

HTMLPurifier_HTMLModuleManager::$doctype

Instance of current doctype. @type string

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

$doctypes

HTMLPurifier_HTMLModuleManager::$doctypes

@type HTMLPurifier_DoctypeRegistry

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

$elementLookup

HTMLPurifier_HTMLModuleManager::$elementLookup = array()

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

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

$modules

HTMLPurifier_HTMLModuleManager::$modules = array()

Active instances of modules for the specified doctype are indexed, by name, in this array. @type HTMLPurifier_HTMLModule[]

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

$prefixes

HTMLPurifier_HTMLModuleManager::$prefixes = array('HTMLPurifier_HTMLModule_')

List of prefixes we should use for registering small names. @type array

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

$registeredModules

HTMLPurifier_HTMLModuleManager::$registeredModules = array()

Array of recognized HTMLPurifier_HTMLModule 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. @type HTMLPurifier_HTMLModule[]

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

$trusted

HTMLPurifier_HTMLModuleManager::$trusted = false

If set to true, unsafe elements and attributes will be allowed. @type bool

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

$userModules

HTMLPurifier_HTMLModuleManager::$userModules = array()

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

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

---

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

• plugins/htmlpurifier/HTMLPurifier.standalone.php