HTMLPurifier_HTMLDefinition Klassenreferenz

Klassendiagramm für HTMLPurifier_HTMLDefinition:

Zusammengehörigkeiten von HTMLPurifier_HTMLDefinition:

Öffentliche Methoden
	addAttribute ($element_name, $attr_name, $def)
	addElement ($element_name, $type, $contents, $attr_collections, $attributes=array())
	addBlankElement ($element_name)
	getAnonymousModule ()
	__construct ()
	parseTinyMCEAllowedList ($list)
Öffentliche Methoden geerbt von HTMLPurifier_Definition
	setup ($config)

Datenfelder
	$info = array()
	$info_global_attr = array()
	$info_parent = 'div'
	$info_parent_def
	$info_block_wrapper = 'p'
	$info_tag_transform = array()
	$info_attr_transform_pre = array()
	$info_attr_transform_post = array()
	$info_content_sets = array()
	$info_injector = array()
	$doctype
	$type = 'HTML'
	$manager
Datenfelder geerbt von HTMLPurifier_Definition
	$setup = false
	$optimized = null
	$type

Geschützte Methoden
	doSetup ($config)
	processModules ($config)
	setupConfigStuff ($config)
Geschützte Methoden geerbt von HTMLPurifier_Definition
	doSetup ($config)

Private Attribute
	$_anonModule = null

Ausführliche Beschreibung

Definition of the purified HTML that describes allowed children, attributes, and many other things.

Conventions:

All member variables that are prefixed with info (including the main $info array) are used by HTML Purifier internals and should not be directly edited when customizing the HTMLDefinition. They can usually be set via configuration directives or custom modules.

On the other hand, member variables without the info prefix are used internally by the HTMLDefinition and MUST NOT be used by other HTML Purifier internals. Many of them, however, are public, and may be edited by userspace code to tweak the behavior of HTMLDefinition.

Zu beachten

This class is inspected by Printer_HTMLDefinition; please update that class if things here change.

Warnung

Directives that change this object's structure must be in the HTML or Attr namespace!

Definiert in Zeile 26 der Datei HTMLDefinition.php.

Beschreibung der Konstruktoren und Destruktoren

__construct

(

)

Performs low-cost, preliminary initialization.

Definiert in Zeile 185 der Datei HTMLDefinition.php.

Dokumentation der Elementfunktionen

addAttribute	(		$element_name,
			$attr_name,
			$def
	)

Adds a custom attribute to a pre-existing element

Zu beachten

This is strictly convenience, and does not have a corresponding method in HTMLPurifier_HTMLModule

Parameter

string	$element_name	Element name to add attribute to
string	$attr_name	Name of attribute
mixed	$def	Attribute definition, can be string or object, see HTMLPurifier_AttrTypes for details

Definiert in Zeile 113 der Datei HTMLDefinition.php.

Benutzt getAnonymousModule().

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

addBlankElement

(

$element_name)

Adds a blank element to your HTML definition, for overriding existing behavior

Parameter

string

$element_name

Rückgabe

HTMLPurifier_ElementDef

Siehe auch

HTMLPurifier_HTMLModule::addBlankElement() for detailed parameter and return value descriptions.

Definiert in Zeile 146 der Datei HTMLDefinition.php.

Benutzt getAnonymousModule().

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

addElement	(		$element_name,
			$type,
			$contents,
			$attr_collections,
			$attributes = array()
	)

Adds a custom element to your HTML definition

Siehe auch

HTMLPurifier_HTMLModule::addElement() for detailed parameter and return value descriptions.

Definiert in Zeile 129 der Datei HTMLDefinition.php.

Benutzt $type und getAnonymousModule().

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

doSetup (   $config)

protected

Parameter

HTMLPurifier_Config

$config

Definiert in Zeile 193 der Datei HTMLDefinition.php.

Benutzt processModules() und setupConfigStuff().

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

getAnonymousModule

(

)

Retrieves a reference to the anonymous module, so you can bust out advanced features without having to make your own module.

Rückgabe

HTMLPurifier_HTMLModule

Definiert in Zeile 159 der Datei HTMLDefinition.php.

Benutzt $_anonModule.

Wird benutzt von addAttribute(), addBlankElement() und addElement().

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

parseTinyMCEAllowedList

(

$list)

Parses a TinyMCE-flavored Allowed Elements and Attributes list into separate lists for processing. Format is element[attr1|attr2],element2...

Warnung

Although it's largely drawn from TinyMCE's implementation, it is different, and you'll probably have to modify your lists

Parameter

array

$list

String list to parse

Rückgabe

array

Noch zu erledigen:

Give this its own class, probably static interface

Definiert in Zeile 458 der Datei HTMLDefinition.php.

Wird benutzt von setupConfigStuff().

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

processModules (   $config)

protected

Extract out the information from the manager

Parameter

HTMLPurifier_Config

$config

Definiert in Zeile 210 der Datei HTMLDefinition.php.

Wird benutzt von doSetup().

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

setupConfigStuff (   $config)

protected

Sets up stuff based on config. We need a better way of doing this.

Parameter

HTMLPurifier_Config

$config

Definiert in Zeile 261 der Datei HTMLDefinition.php.

Benutzt $info und parseTinyMCEAllowedList().

Wird benutzt von doSetup().

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

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

Dokumentation der Datenelemente

$_anonModule = null

private

Definiert in Zeile 168 der Datei HTMLDefinition.php.

Wird benutzt von getAnonymousModule().

$doctype

Doctype object HTMLPurifier_Doctype

Definiert in Zeile 98 der Datei HTMLDefinition.php.

$info = array()

Associative array of element names to HTMLPurifier_ElementDef. HTMLPurifier_ElementDef[]

Definiert in Zeile 35 der Datei HTMLDefinition.php.

Wird benutzt von setupConfigStuff().

$info_attr_transform_post = array()

Indexed list of HTMLPurifier_AttrTransform to be performed after validation. HTMLPurifier_AttrTransform[]

Definiert in Zeile 79 der Datei HTMLDefinition.php.

$info_attr_transform_pre = array()

Indexed list of HTMLPurifier_AttrTransform to be performed before validation. HTMLPurifier_AttrTransform[]

Definiert in Zeile 73 der Datei HTMLDefinition.php.

$info_block_wrapper = 'p'

String name of element used to wrap inline elements in block context. string

Zu beachten

This is rarely used except for BLOCKQUOTEs in strict mode

Definiert in Zeile 61 der Datei HTMLDefinition.php.

$info_content_sets = array()

Nested lookup array of content set name (Block, Inline) to element name to whether or not it belongs in that content set. array

Definiert in Zeile 86 der Datei HTMLDefinition.php.

$info_global_attr = array()

Associative array of global attribute name to attribute definition. array

Definiert in Zeile 41 der Datei HTMLDefinition.php.

$info_injector = array()

Indexed list of HTMLPurifier_Injector to be used. HTMLPurifier_Injector[]

Definiert in Zeile 92 der Datei HTMLDefinition.php.

$info_parent = 'div'

String name of parent element HTML will be going into. string

Definiert in Zeile 47 der Datei HTMLDefinition.php.

$info_parent_def

Definition for parent element, allows parent element to be a tag that's not allowed inside the HTML fragment. HTMLPurifier_ElementDef

Definiert in Zeile 54 der Datei HTMLDefinition.php.

$info_tag_transform = array()

Associative array of deprecated tag name to HTMLPurifier_TagTransform. array

Definiert in Zeile 67 der Datei HTMLDefinition.php.

$manager

HTMLPurifier_HTMLModuleManager

Definiert in Zeile 180 der Datei HTMLDefinition.php.

$type = 'HTML'

string

Definiert in Zeile 175 der Datei HTMLDefinition.php.

Wird benutzt von addElement().

---

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

• HTMLPurifier/HTMLDefinition.php