HTMLPurifier_HTMLModule Class Reference

Inheritance diagram for HTMLPurifier_HTMLModule:

Public Member Functions
	getChildDef ($def)
	addElement ($element, $type, $contents, $attr_includes=array(), $attr=array())
	addBlankElement ($element)
	addElementToContentSet ($element, $type)
	parseContents ($contents)
	mergeInAttrIncludes (&$attr, $attr_includes)
	makeLookup ($list)
	setup ($config)

Data Fields
	$name
	$elements = array()
	$info = array()
	$content_sets = array()
	$attr_collections = array()
	$info_tag_transform = array()
	$info_attr_transform_pre = array()
	$info_attr_transform_post = array()
	$info_injector = array()
	$defines_child_def = false
	$safe = true

Detailed Description

Represents an XHTML 1.1 module, with information on elements, tags and attributes.

Note

Even though this is technically XHTML 1.1, it is also used for regular HTML parsing. We are using modulization as a convenient way to represent the internals of HTMLDefinition, and our implementation is by no means conforming and does not directly use the normative DTDs or XML schemas.

The public variables in a module should almost directly correspond to the variables in HTMLPurifier_HTMLDefinition. However, the prefix info carries no special meaning in these objects (include it anyway if that's the correspondence though).

Todo:

Consider making some member functions protected

Member Function Documentation

addBlankElement()

addBlankElement

(

$element

)

Convenience function that creates a totally blank, non-standalone element.

Parameters

string

$element

Name of element to create

Returns

HTMLPurifier_ElementDef Created element

Here is the caller graph for this function:

addElement()

addElement	(		$element,
			$type,
			$contents,
			$attr_includes = array(),
			$attr = array()
	)

Convenience function that sets up a new element

Parameters

string	$element	Name of element to add
string | bool	$type	What content set should element be registered to? Set as false to skip this step.
string | HTMLPurifier_ChildDef	$contents	Allowed children in form of: "$content_model_type: $content_model"
array | string	$attr_includes	What attribute collections to register to element?
array	$attr	What unique attributes does the element define?

See also

HTMLPurifier_ElementDef:: for in-depth descriptions of these parameters.

Returns

HTMLPurifier_ElementDef Created element definition object, so you can set advanced parameters

Here is the call graph for this function:

Here is the caller graph for this function:

addElementToContentSet()

addElementToContentSet	(		$element,
			$type
	)

Convenience function that registers an element to a content set

Parameters

string	$element	Element to register
string	$type	Name content set (warning: case sensitive, usually upper-case first letter)

Here is the caller graph for this function:

getChildDef()

getChildDef

(

$def

)

Retrieves a proper HTMLPurifier_ChildDef subclass based on content_model and content_model_type member variables of the HTMLPurifier_ElementDef class. There is a similar function in HTMLPurifier_HTMLDefinition.

Parameters

HTMLPurifier_ElementDef

$def

Returns

HTMLPurifier_ChildDef subclass

Reimplemented in HTMLPurifier_HTMLModule_Edit, and HTMLPurifier_HTMLModule_Tidy_Strict.

makeLookup()

makeLookup

(

$list

)

Convenience function that generates a lookup table with boolean true as value.

Parameters

string

$list

List of values to turn into a lookup

Note

You can also pass an arbitrary number of arguments in place of the regular argument

Returns

array array equivalent of list

Here is the caller graph for this function:

mergeInAttrIncludes()

mergeInAttrIncludes	(	&	$attr,
			$attr_includes
	)

Convenience function that merges a list of attribute includes into an attribute array.

Parameters

array	$attr	Reference to attr array to modify
array	$attr_includes	Array of includes / string include to merge in

Here is the caller graph for this function:

parseContents()

parseContents

(

$contents

)

Convenience function that transforms single-string contents into separate content model and content model type

Parameters

string

$contents

Allowed children in form of: "$content_model_type: $content_model"

Returns

array

Note

If contents is an object, an array of two nulls will be returned, and the callee needs to take the original $contents and use it directly.

Here is the caller graph for this function:

setup()

setup

(

$config

)

Lazy load construction of the module after determining whether or not it's needed, and also when a finalized configuration object is available.

Parameters

HTMLPurifier_Config

$config

Reimplemented in HTMLPurifier_HTMLModule_Bdo, HTMLPurifier_HTMLModule_Edit, HTMLPurifier_HTMLModule_Forms, HTMLPurifier_HTMLModule_Hypertext, HTMLPurifier_HTMLModule_Iframe, HTMLPurifier_HTMLModule_Image, HTMLPurifier_HTMLModule_Legacy, HTMLPurifier_HTMLModule_List, HTMLPurifier_HTMLModule_Name, HTMLPurifier_HTMLModule_Nofollow, HTMLPurifier_HTMLModule_Object, HTMLPurifier_HTMLModule_Presentation, HTMLPurifier_HTMLModule_Proprietary, HTMLPurifier_HTMLModule_Ruby, HTMLPurifier_HTMLModule_SafeEmbed, HTMLPurifier_HTMLModule_SafeObject, HTMLPurifier_HTMLModule_SafeScripting, HTMLPurifier_HTMLModule_Scripting, HTMLPurifier_HTMLModule_StyleAttribute, HTMLPurifier_HTMLModule_Tables, HTMLPurifier_HTMLModule_Target, HTMLPurifier_HTMLModule_TargetBlank, HTMLPurifier_HTMLModule_TargetNoopener, HTMLPurifier_HTMLModule_TargetNoreferrer, HTMLPurifier_HTMLModule_Text, and HTMLPurifier_HTMLModule_Tidy.

Field Documentation

$attr_collections

$attr_collections = array()

Associative array of attribute collection names to attribute collection additions. More rarely used for adding attributes to the global collections. Example is the StyleAttribute module adding the style attribute to the Core. Corresponds to HTMLDefinition's attr_collections->info, since the object's data is only info, with extra behavior associated with it. @type array

$content_sets

$content_sets = array()

Associative array of content set names to content set additions. This is commonly used to, say, add an A element to the Inline content set. This corresponds to an internal variable $content_sets and NOT info_content_sets member variable of HTMLDefinition. @type array

$defines_child_def

$defines_child_def = false

Boolean flag that indicates whether or not getChildDef is implemented. For optimization reasons: may save a call to a function. Be sure to set it if you do implement getChildDef(), otherwise it will have no effect! @type bool

$elements

$elements = array()

Informally, a list of elements this module changes. Not used in any significant way. @type array

$info

$info = array()

Associative array of element names to element definitions. Some definitions may be incomplete, to be merged in later with the full definition. @type array

$info_attr_transform_post

$info_attr_transform_post = array()

List of HTMLPurifier_AttrTransform to be performed after validation. @type array

$info_attr_transform_pre

$info_attr_transform_pre = array()

List of HTMLPurifier_AttrTransform to be performed before validation. @type array

$info_injector

$info_injector = array()

List of HTMLPurifier_Injector to be performed during well-formedness fixing. An injector will only be invoked if all of it's pre-requisites are met; if an injector fails setup, there will be no error; it will simply be silently disabled. @type array

$info_tag_transform

$info_tag_transform = array()

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

$name

$name

Short unique string identifier of the module. @type string

$safe

$safe = true

Boolean flag whether or not this module is safe. If it is not safe, all of its members are unsafe. Modules are safe by default (this might be slightly dangerous, but it doesn't make much sense to force HTML Purifier, which is based off of safe HTML, to explicitly say, "This is safe," even though there are modules which are "unsafe")

@type bool

Note

Previously, safety could be applied at an element level granularity. We've removed this ability, so in order to add "unsafe" elements or attributes, a dedicated module with this property set to false must be used.

---

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

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