Class HTMLPurifier_HTMLModule

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

Direct known subclasses

Indirect known subclasses

HTMLPurifier_HTMLModule_Tidy_Name, HTMLPurifier_HTMLModule_Tidy_Proprietary, HTMLPurifier_HTMLModule_Tidy_Strict, HTMLPurifier_HTMLModule_Tidy_Transitional, HTMLPurifier_HTMLModule_Tidy_XHTML, HTMLPurifier_HTMLModule_Tidy_XHTMLAndHTML4

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.
Note: 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).
Located at x2engine/framework/vendors/htmlpurifier/HTMLPurifier.standalone.php

Methods summary
`public HTMLPurifier_ChildDef`	# `getChildDef( HTMLPurifier_ElementDef $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. 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 `$def` `HTMLPurifier_ElementDef` $def Returns `HTMLPurifier_ChildDef` subclass
`public HTMLPurifier_ElementDef`	# `addElement( string $element, string\|boolean $type, string $contents, array $attr_includes = array(), array $attr = array() )` Convenience function that sets up a new element Convenience function that sets up a new element Parameters `$element` `string` $element Name of element to add `$type` `string\|boolean` $type What content set should element be registered to? Set as false to skip this step. `$contents` `string` $contents Allowed children in form of: "$content_model_type: $content_model" `$attr_includes` `array` $attr_includes What attribute collections to register to element? `$attr` `array` $attr What unique attributes does the element define? Returns `HTMLPurifier_ElementDef` Created element definition object, so you can set advanced parameters See HTMLPurifier_ElementDef:: for in-depth descriptions of these parameters.
`public HTMLPurifier_ElementDef`	# `addBlankElement( string $element )` Convenience function that creates a totally blank, non-standalone element. Convenience function that creates a totally blank, non-standalone element. Parameters `$element` `string` $element Name of element to create Returns `HTMLPurifier_ElementDef` Created element
`public`	# `addElementToContentSet( string $element, string $type )` Convenience function that registers an element to a content set Convenience function that registers an element to a content set Parameters `$element` `string` $element Element to register `$type` `string` $type Name content set (warning: case sensitive, usually upper-case first letter)
`public array`	# `parseContents( string $contents )` Convenience function that transforms single-string contents into separate content model and content model type Convenience function that transforms single-string contents into separate content model and content model type Parameters `$contents` `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.
`public`	# `mergeInAttrIncludes( array & $attr, array $attr_includes )` Convenience function that merges a list of attribute includes into an attribute array. Convenience function that merges a list of attribute includes into an attribute array. Parameters `$attr` `array` $attr Reference to attr array to modify `$attr_includes` `array` $attr_includes Array of includes / string include to merge in
`public array`	# `makeLookup( string $list )` Convenience function that generates a lookup table with boolean true as value. Convenience function that generates a lookup table with boolean true as value. Parameters `$list` `string` $list List of values to turn into a lookup Returns `array` array equivalent of list Note You can also pass an arbitrary number of arguments in place of the regular argument
`public`	# `setup( HTMLPurifier_Config $config )` Lazy load construction of the module after determining whether or not it's needed, and also when a finalized configuration object is available. Lazy load construction of the module after determining whether or not it's needed, and also when a finalized configuration object is available. Parameters `$config` `HTMLPurifier_Config` $config

Properties summary
`public mixed`	`$name`		# Short unique string identifier of the module. Short unique string identifier of the module. Type string
`public array`	`$elements`	`array()`	# Informally, a list of elements this module changes. Not used in any significant way. Informally, a list of elements this module changes. Not used in any significant way. Type array
`public array`	`$info`	`array()`	# Associative array of element names to element definitions. Some definitions may be incomplete, to be merged in later with the full definition. Associative array of element names to element definitions. Some definitions may be incomplete, to be merged in later with the full definition. Type array
`public array`	`$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. 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
`public array`	`$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. 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
`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()`	# List of HTMLPurifier_AttrTransform to be performed before validation. List of HTMLPurifier_AttrTransform to be performed before validation. Type array
`public array`	`$info_attr_transform_post`	`array()`	# List of HTMLPurifier_AttrTransform to be performed after validation. List of HTMLPurifier_AttrTransform to be performed after validation. Type array
`public array`	`$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. 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
`public boolean`	`$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! 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
`public boolean`	`$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") 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") 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. Type bool

Packages

Classes

Interfaces

Exceptions

Functions

Class HTMLPurifier_HTMLModule

Direct known subclasses

Indirect known subclasses

Parameters

Returns

Parameters

Returns

See

Parameters

Returns

Parameters

Parameters

Returns

Note

Parameters

Parameters

Returns

Note

Parameters

Type

Type

Type

Type

Type

Type

Type

Type

Type

Type

Note

Type