HTMLPurifier_HTMLDefinition Class Reference

Inheritance diagram for HTMLPurifier_HTMLDefinition:

Collaboration diagram for HTMLPurifier_HTMLDefinition:

Public Member Functions
	addAttribute ($element_name, $attr_name, $def)
	addElement ($element_name, $type, $contents, $attr_collections, $attributes=array())
	addBlankElement ($element_name)
	getAnonymousModule ()
	__construct ()
	parseTinyMCEAllowedList ($list)
Public Member Functions inherited from HTMLPurifier_Definition
	setup ($config)

Data Fields
	$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
Data Fields inherited from HTMLPurifier_Definition
	$setup = false
	$optimized = null
	$type

Protected Member Functions
	doSetup ($config)
	processModules ($config)
	setupConfigStuff ($config)
	doSetup ($config)

Detailed Description

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.

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!

Constructor & Destructor Documentation

__construct()

__construct

(

)

Performs low-cost, preliminary initialization.

Member Function Documentation

addAttribute()

addAttribute	(		$element_name,
			$attr_name,
			$def
	)

Adds a custom attribute to a pre-existing element

Note

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

Parameters

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

Here is the call graph for this function:

addBlankElement()

addBlankElement

(

$element_name

)

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

Parameters

string

$element_name

Returns

HTMLPurifier_ElementDef

See also

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

Here is the call graph for this function:

addElement()

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

Adds a custom element to your HTML definition

See also

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

Here is the call graph for this function:

doSetup()

doSetup (   $config )

protected

Parameters

HTMLPurifier_Config

$config

Reimplemented from HTMLPurifier_Definition.

Here is the call graph for this function:

getAnonymousModule()

getAnonymousModule

(

)

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

Returns

HTMLPurifier_HTMLModule

Here is the caller graph for this function:

parseTinyMCEAllowedList()

parseTinyMCEAllowedList

(

$list

)

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

Warning

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

Parameters

array

$list

String list to parse

Returns

array

Todo:

Give this its own class, probably static interface

Here is the caller graph for this function:

processModules()

processModules (   $config )

protected

Extract out the information from the manager

Parameters

HTMLPurifier_Config

$config

Here is the caller graph for this function:

setupConfigStuff()

setupConfigStuff (   $config )

protected

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

Parameters

HTMLPurifier_Config

$config

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$doctype

$doctype

Doctype object @type HTMLPurifier_Doctype

$info

$info = array()

Associative array of element names to HTMLPurifier_ElementDef. @type HTMLPurifier_ElementDef[]

$info_attr_transform_post

$info_attr_transform_post = array()

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

$info_attr_transform_pre

$info_attr_transform_pre = array()

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

$info_block_wrapper

$info_block_wrapper = 'p'

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

Note

This is rarely used except for BLOCKQUOTEs in strict mode

$info_content_sets

$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. @type array

$info_global_attr

$info_global_attr = array()

Associative array of global attribute name to attribute definition. @type array

$info_injector

$info_injector = array()

Indexed list of HTMLPurifier_Injector to be used. @type HTMLPurifier_Injector[]

$info_parent

$info_parent = 'div'

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

$info_parent_def

$info_parent_def

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

$info_tag_transform

$info_tag_transform = array()

Associative array of deprecated tag name to HTMLPurifier_TagTransform. @type array

$manager

$manager

@type HTMLPurifier_HTMLModuleManager

$type

$type = 'HTML'

@type string

---

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

• C:/xoops2511b2/htdocs/xoops_lib/modules/protector/library/HTMLPurifier/HTMLDefinition.php