Class HTMLPurifier_HTMLDefinition

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.

HTMLPurifier_Definition

HTMLPurifier_HTMLDefinition

Note: This class is inspected by Printer_HTMLDefinition; please update that class if things here change.
Warning: Directives that change this object's structure must be in the HTML or Attr namespace!
Located at x2engine/framework/vendors/htmlpurifier/HTMLPurifier.standalone.php

Methods summary
`public`	# `addAttribute( string $element_name, string $attr_name, mixed $def )` Adds a custom attribute to a pre-existing element Adds a custom attribute to a pre-existing element Parameters `$element_name` `string` $element_name Element name to add attribute to `$attr_name` `string` $attr_name Name of attribute `$def` `mixed` $def Attribute definition, can be string or object, see HTMLPurifier_AttrTypes for details Note This is strictly convenience, and does not have a corresponding method in HTMLPurifier_HTMLModule
`public`	# `addElement( mixed $element_name, mixed $type, mixed $contents, mixed $attr_collections, mixed $attributes = array() )` Adds a custom element to your HTML definition Adds a custom element to your HTML definition See HTMLPurifier_HTMLModule::addElement() for detailed parameter and return value descriptions.
`public HTMLPurifier_ElementDef`	# `addBlankElement( string $element_name )` Adds a blank element to your HTML definition, for overriding existing behavior Adds a blank element to your HTML definition, for overriding existing behavior Parameters `$element_name` `string` $element_name Returns `HTMLPurifier_ElementDef` See HTMLPurifier_HTMLModule::addBlankElement() for detailed parameter and return value descriptions.
`public HTMLPurifier_HTMLModule`	# `getAnonymousModule( )` Retrieves a reference to the anonymous module, so you can bust out advanced features without having to make your own module. Retrieves a reference to the anonymous module, so you can bust out advanced features without having to make your own module. Returns `HTMLPurifier_HTMLModule`
`public`	# `__construct( )` Performs low-cost, preliminary initialization. Performs low-cost, preliminary initialization.
`protected`	# `doSetup( HTMLPurifier_Config $config )` Parameters `$config` `HTMLPurifier_Config` $config
`protected`	# `processModules( HTMLPurifier_Config $config )` Extract out the information from the manager Extract out the information from the manager Parameters `$config` `HTMLPurifier_Config` $config
`protected`	# `setupConfigStuff( HTMLPurifier_Config $config )` Sets up stuff based on config. We need a better way of doing this. Sets up stuff based on config. We need a better way of doing this. Parameters `$config` `HTMLPurifier_Config` $config
`public array`	# `parseTinyMCEAllowedList( array $list )` Parses a TinyMCE-flavored Allowed Elements and Attributes list into separate lists for processing. Format is element[attr1\|attr2],element2... Parses a TinyMCE-flavored Allowed Elements and Attributes list into separate lists for processing. Format is element[attr1\|attr2],element2... Parameters `$list` `array` $list String list to parse Returns `array` Warning Although it's largely drawn from TinyMCE's implementation, it is different, and you'll probably have to modify your lists

Methods inherited from HTMLPurifier_Definition
`setup()`

Properties summary
`public array`	`$info`	`array()`	# Associative array of element names to HTMLPurifier_ElementDef. Associative array of element names to HTMLPurifier_ElementDef. Type HTMLPurifier_ElementDef[]
`public array`	`$info_global_attr`	`array()`	# Associative array of global attribute name to attribute definition. Associative array of global attribute name to attribute definition. Type array
`public string`	`$info_parent`	`'div'`	# String name of parent element HTML will be going into. String name of parent element HTML will be going into. Type string
`public mixed`	`$info_parent_def`		# Definition for parent element, allows parent element to be a tag that's not allowed inside the HTML fragment. Definition for parent element, allows parent element to be a tag that's not allowed inside the HTML fragment. Type HTMLPurifier_ElementDef
`public string`	`$info_block_wrapper`	`'p'`	# String name of element used to wrap inline elements in block context. String name of element used to wrap inline elements in block context. Note This is rarely used except for BLOCKQUOTEs in strict mode Type string
`public array`	`$info_tag_transform`	`array()`	# Associative array of deprecated tag name to HTMLPurifier_TagTransform. Associative array of deprecated tag name to HTMLPurifier_TagTransform. Type array
`public array`	`$info_attr_transform_pre`	`array()`	# Indexed list of HTMLPurifier_AttrTransform to be performed before validation. Indexed list of HTMLPurifier_AttrTransform to be performed before validation. Type HTMLPurifier_AttrTransform[]
`public array`	`$info_attr_transform_post`	`array()`	# Indexed list of HTMLPurifier_AttrTransform to be performed after validation. Indexed list of HTMLPurifier_AttrTransform to be performed after validation. Type HTMLPurifier_AttrTransform[]
`public array`	`$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. Nested lookup array of content set name (Block, Inline) to element name to whether or not it belongs in that content set. Type array
`public array`	`$info_injector`	`array()`	# Indexed list of HTMLPurifier_Injector to be used. Indexed list of HTMLPurifier_Injector to be used. Type HTMLPurifier_Injector[]
`public mixed`	`$doctype`		# Doctype object Doctype object Type HTMLPurifier_Doctype
`public string`	`$type`	`'HTML'`	# Type string
`public mixed`	`$manager`		# Type HTMLPurifier_HTMLModuleManager

Properties inherited from HTMLPurifier_Definition
`$optimized, $setup`

Packages

Classes

Interfaces

Exceptions

Functions

Class HTMLPurifier_HTMLDefinition

Parameters

Note

See

Parameters

Returns

See

Returns

Parameters

Parameters

Parameters

Parameters

Returns

Warning

Type

Type

Type

Type

Note

Type

Type

Type

Type

Type

Type

Type

Type

Type