HTMLPurifier_HTMLModuleManager Klassenreferenz

Öffentliche Methoden
	__construct ()
	registerModule ($module, $overload=false)
	addModule ($module)
	addPrefix ($prefix)
	setup ($config)
	processModule ($module)
	getElements ()
	getElement ($name, $trusted=null)
Datenfelder
	$doctypes
	$doctype
	$attrTypes
	$modules = array()
	$registeredModules = array()
	$userModules = array()
	$elementLookup = array()
	$prefixes = array('HTMLPurifier_HTMLModule_')
	$contentSets
	$attrCollections
	$trusted = false

---

Ausführliche Beschreibung

Definiert in Zeile 3 der Datei HTMLModuleManager.php.

---

Beschreibung der Konstruktoren und Destruktoren

__construct

(

)

Definiert in Zeile 56 der Datei HTMLModuleManager.php.

---

Dokumentation der Elementfunktionen

addModule

(

$

module

)

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

Definiert in Zeile 181 der Datei HTMLModuleManager.php.

Hier ist ein Graph der zeigt, was diese Funktion aufruft:

addPrefix

(

$

prefix

)

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

Definiert in Zeile 191 der Datei HTMLModuleManager.php.

getElement	(	$	name,
		$	trusted = null
	)

Retrieves a single merged element definition

Parameter:

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

Rückgabe:

Merged HTMLPurifier_ElementDef

Zu beachten:

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

Definiert in Zeile 330 der Datei HTMLModuleManager.php.

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

getElements

(

)

Retrieves merged element definitions.

Rückgabe:

Array of HTMLPurifier_ElementDef

Definiert in Zeile 299 der Datei HTMLModuleManager.php.

Hier ist ein Graph der zeigt, was diese Funktion aufruft:

processModule

(

$

module

)

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

Definiert in Zeile 288 der Datei HTMLModuleManager.php.

Hier ist ein Graph der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

registerModule	(	$	module,
		$	overload = false
	)

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

Parameter:

	$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.

Zu beachten:

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!

Definiert in Zeile 145 der Datei HTMLModuleManager.php.

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

setup

(

$

config

)

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

Parameter:

$config

Instance of HTMLPurifier_Config

Definiert in Zeile 200 der Datei HTMLModuleManager.php.

Hier ist ein Graph der zeigt, was diese Funktion aufruft:

---

Dokumentation der Datenelemente

$attrCollections

Instance of HTMLPurifier_AttrCollections

Definiert in Zeile 51 der Datei HTMLModuleManager.php.

$attrTypes

Instance of HTMLPurifier_AttrTypes

Definiert in Zeile 19 der Datei HTMLModuleManager.php.

$contentSets

Instance of HTMLPurifier_ContentSets

Definiert in Zeile 50 der Datei HTMLModuleManager.php.

$doctype

Instance of current doctype

Definiert in Zeile 14 der Datei HTMLModuleManager.php.

$doctypes

Instance of HTMLPurifier_DoctypeRegistry

Definiert in Zeile 9 der Datei HTMLModuleManager.php.

$elementLookup = array()

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

Definiert in Zeile 45 der Datei HTMLModuleManager.php.

$modules = array()

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

Definiert in Zeile 25 der Datei HTMLModuleManager.php.

$prefixes = array('HTMLPurifier_HTMLModule_')

List of prefixes we should use for registering small names

Definiert in Zeile 48 der Datei HTMLModuleManager.php.

$registeredModules = array()

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.

Definiert in Zeile 32 der Datei HTMLModuleManager.php.

$trusted = false

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

Definiert in Zeile 54 der Datei HTMLModuleManager.php.

$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.

Definiert in Zeile 39 der Datei HTMLModuleManager.php.

---

Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei:

• HTMLPurifier/HTMLModuleManager.php