HTMLPurifier_HTMLModule Class Reference

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

Inheritance diagram for HTMLPurifier_HTMLModule:

Collaboration diagram for HTMLPurifier_HTMLModule:

Public Member Functions
	getChildDef ($def)
	Retrieves a proper HTMLPurifier_ChildDef subclass based on content_model and content_model_type member variables of the HTMLPurifier_ElementDef class.
	addElement ($element, $type, $contents, $attr_includes=array(), $attr=array())
	Convenience function that sets up a new element.
	addBlankElement ($element)
	Convenience function that creates a totally blank, non-standalone element.
	addElementToContentSet ($element, $type)
	Convenience function that registers an element to a content set.
	parseContents ($contents)
	Convenience function that transforms single-string contents into separate content model and content model type.
	mergeInAttrIncludes (&$attr, $attr_includes)
	Convenience function that merges a list of attribute includes into an attribute array.
	makeLookup ($list)
	Convenience function that generates a lookup table with boolean true as value.
	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.

Data Fields
	$name
	Short unique string identifier of the module.
	$elements = array()
	Informally, a list of elements this module changes.
	$info = array()
	Associative array of element names to element definitions.
	$content_sets = array()
	Associative array of content set names to content set additions.
	$attr_collections = array()
	Associative array of attribute collection names to attribute collection additions.
	$info_tag_transform = array()
	Associative array of deprecated tag name to HTMLPurifier_TagTransform.
	$info_attr_transform_pre = array()
	List of HTMLPurifier_AttrTransform to be performed before validation.
	$info_attr_transform_post = array()
	List of HTMLPurifier_AttrTransform to be performed after validation.
	$info_injector = array()
	List of HTMLPurifier_Injector to be performed during well-formedness fixing.
	$defines_child_def = false
	Boolean flag that indicates whether or not getChildDef is implemented.
	$safe = true
	Boolean flag whether or not this module is safe.

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

Definition at line 18 of file HTMLModule.php.

Member Function Documentation

HTMLPurifier_HTMLModule::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

Definition at line 174 of file HTMLModule.php.

Referenced by HTMLPurifier_HTMLModule_Tidy\populate(), HTMLPurifier_HTMLModule_Name\setup(), HTMLPurifier_HTMLModule_Target\setup(), HTMLPurifier_HTMLModule_TargetBlank\setup(), HTMLPurifier_HTMLModule_Nofollow\setup(), and HTMLPurifier_HTMLModule_Legacy\setup().

    {
        if (!isset($this->info[$element])) {
            $this->elements[] = $element;
            $this->info[$element] = new HTMLPurifier_ElementDef();
            $this->info[$element]->standalone = false;
        } else {
            trigger_error("Definition for $element already exists in module, cannot redefine");
        }
        return $this->info[$element];
    }

Here is the caller graph for this function:

HTMLPurifier_HTMLModule::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	$contents	Allowed children in form of: "$content_model_type: $content_model"
array	$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

Definition at line 144 of file HTMLModule.php.

References addElementToContentSet(), HTMLPurifier_ElementDef\create(), mergeInAttrIncludes(), and parseContents().

Referenced by HTMLPurifier_HTMLModule_SafeEmbed\setup(), HTMLPurifier_HTMLModule_Tables\setup(), HTMLPurifier_HTMLModule_Hypertext\setup(), HTMLPurifier_HTMLModule_SafeScripting\setup(), HTMLPurifier_HTMLModule_Proprietary\setup(), HTMLPurifier_HTMLModule_Ruby\setup(), HTMLPurifier_HTMLModule_Edit\setup(), HTMLPurifier_HTMLModule_Image\setup(), HTMLPurifier_HTMLModule_SafeObject\setup(), HTMLPurifier_HTMLModule_Object\setup(), HTMLPurifier_HTMLModule_Presentation\setup(), HTMLPurifier_HTMLModule_Bdo\setup(), HTMLPurifier_HTMLModule_Iframe\setup(), HTMLPurifier_HTMLModule_Legacy\setup(), HTMLPurifier_HTMLModule_Forms\setup(), HTMLPurifier_HTMLModule_List\setup(), and HTMLPurifier_HTMLModule_Text\setup().

    {
        $this->elements[] = $element;
        // parse content_model
        list($content_model_type, $content_model) = $this->parseContents($contents);
        // merge in attribute inclusions
        $this->mergeInAttrIncludes($attr, $attr_includes);
        // add element to content sets
        if ($type) {
            $this->addElementToContentSet($element, $type);
        }
        // create element
        $this->info[$element] = HTMLPurifier_ElementDef::create(
            $content_model,
            $content_model_type,
            $attr
        );
        // literal object $contents means direct child manipulation
        if (!is_string($contents)) {
            $this->info[$element]->child = $contents;
        }
        return $this->info[$element];
    }

Here is the call graph for this function:

Here is the caller graph for this function:

HTMLPurifier_HTMLModule::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)

Definition at line 192 of file HTMLModule.php.

Referenced by addElement().

    {
        if (!isset($this->content_sets[$type])) {
            $this->content_sets[$type] = '';
        } else {
            $this->content_sets[$type] .= ' | ';
        }
        $this->content_sets[$type] .= $element;
    }

Here is the caller graph for this function:

HTMLPurifier_HTMLModule::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.

Definition at line 123 of file HTMLModule.php.

    {
        return false;
    }

HTMLPurifier_HTMLModule::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

Definition at line 258 of file HTMLModule.php.

References $ret.

Referenced by HTMLPurifier_HTMLModule_Forms\setup(), and HTMLPurifier_HTMLModule_Text\setup().

    {
        if (is_string($list)) {
            $list = func_get_args();
        }
        $ret = array();
        foreach ($list as $value) {
            if (is_null($value)) {
                continue;
            }
            $ret[$value] = true;
        }
        return $ret;
    }

Here is the caller graph for this function:

HTMLPurifier_HTMLModule::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

Definition at line 238 of file HTMLModule.php.

Referenced by addElement().

    {
        if (!is_array($attr_includes)) {
            if (empty($attr_includes)) {
                $attr_includes = array();
            } else {
                $attr_includes = array($attr_includes);
            }
        }
        $attr[0] = $attr_includes;
    }

Here is the caller graph for this function:

HTMLPurifier_HTMLModule::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.

Definition at line 212 of file HTMLModule.php.

Referenced by addElement().

    {
        if (!is_string($contents)) {
            return array(null, null);
        } // defer
        switch ($contents) {
            // check for shorthand content model forms
            case 'Empty':
                return array('empty', '');
            case 'Inline':
                return array('optional', 'Inline | #PCDATA');
            case 'Flow':
                return array('optional', 'Flow | #PCDATA');
        }
        list($content_model_type, $content_model) = explode(':', $contents);
        $content_model_type = strtolower(trim($content_model_type));
        $content_model = trim($content_model);
        return array($content_model_type, $content_model);
    }

Here is the caller graph for this function:

HTMLPurifier_HTMLModule::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_Tidy, HTMLPurifier_HTMLModule_Scripting, HTMLPurifier_HTMLModule_Text, HTMLPurifier_HTMLModule_List, HTMLPurifier_HTMLModule_Forms, HTMLPurifier_HTMLModule_Legacy, HTMLPurifier_HTMLModule_StyleAttribute, HTMLPurifier_HTMLModule_Iframe, HTMLPurifier_HTMLModule_Bdo, HTMLPurifier_HTMLModule_Presentation, HTMLPurifier_HTMLModule_Object, HTMLPurifier_HTMLModule_Image, HTMLPurifier_HTMLModule_SafeObject, HTMLPurifier_HTMLModule_Edit, HTMLPurifier_HTMLModule_Nofollow, HTMLPurifier_HTMLModule_Ruby, HTMLPurifier_HTMLModule_Hypertext, HTMLPurifier_HTMLModule_Proprietary, HTMLPurifier_HTMLModule_SafeScripting, HTMLPurifier_HTMLModule_TargetBlank, HTMLPurifier_HTMLModule_SafeEmbed, HTMLPurifier_HTMLModule_Tables, HTMLPurifier_HTMLModule_Target, and HTMLPurifier_HTMLModule_Name.

Definition at line 279 of file HTMLModule.php.

    {
    }

Field Documentation

HTMLPurifier_HTMLModule::$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. array

Definition at line 62 of file HTMLModule.php.

HTMLPurifier_HTMLModule::$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. array

Definition at line 51 of file HTMLModule.php.

HTMLPurifier_HTMLModule::$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! bool

Definition at line 98 of file HTMLModule.php.

HTMLPurifier_HTMLModule::$elements = array()

Informally, a list of elements this module changes.

Not used in any significant way. array

Definition at line 34 of file HTMLModule.php.

Referenced by HTMLPurifier_HTMLModule_Name\setup(), and HTMLPurifier_HTMLModule_Target\setup().

HTMLPurifier_HTMLModule::$info = array()

Associative array of element names to element definitions.

Some definitions may be incomplete, to be merged in later with the full definition. array

Definition at line 42 of file HTMLModule.php.

HTMLPurifier_HTMLModule::$info_attr_transform_post = array()

List of HTMLPurifier_AttrTransform to be performed after validation.

array

Definition at line 80 of file HTMLModule.php.

HTMLPurifier_HTMLModule::$info_attr_transform_pre = array()

List of HTMLPurifier_AttrTransform to be performed before validation.

array

Definition at line 74 of file HTMLModule.php.

HTMLPurifier_HTMLModule::$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. array

Definition at line 89 of file HTMLModule.php.

HTMLPurifier_HTMLModule::$info_tag_transform = array()

Associative array of deprecated tag name to HTMLPurifier_TagTransform.

array

Definition at line 68 of file HTMLModule.php.

HTMLPurifier_HTMLModule::$name

Short unique string identifier of the module.

string

Definition at line 27 of file HTMLModule.php.

Referenced by HTMLPurifier_HTMLModule_Tidy\getFixType(), HTMLPurifier_HTMLModule_Tidy\populate(), and HTMLPurifier_HTMLModule_Tidy\setup().

HTMLPurifier_HTMLModule::$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")

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.

Definition at line 113 of file HTMLModule.php.

---

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

• Services/Html/HtmlPurifier/library/HTMLPurifier/HTMLModule.php