HTMLPurifier_HTMLModule_List Class Reference

XHTML 1.1 List Module, defines list-oriented elements. More...

Inheritance diagram for HTMLPurifier_HTMLModule_List:

Collaboration diagram for HTMLPurifier_HTMLModule_List:

Public Member Functions
	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.
Public Member Functions inherited from 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.
	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.

Data Fields
	$name = 'List'
	$content_sets = array('Flow' => 'List')
Data Fields inherited from HTMLPurifier_HTMLModule
	$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

XHTML 1.1 List Module, defines list-oriented elements.

Core Module.

Definition at line 6 of file List.php.

Member Function Documentation

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

$config

Instance of HTMLPurifier_Config

Reimplemented from HTMLPurifier_HTMLModule.

Definition at line 22 of file List.php.

References HTMLPurifier_HTMLModule\addElement().

                                   {
        $ol = $this->addElement('ol', 'List', new HTMLPurifier_ChildDef_List(), 'Common');
        $ul = $this->addElement('ul', 'List', new HTMLPurifier_ChildDef_List(), 'Common');
        // XXX The wrap attribute is handled by MakeWellFormed.  This is all
        // quite unsatisfactory, because we generated this
        // *specifically* for lists, and now a big chunk of the handling
        // is done properly by the List ChildDef.  So actually, we just
        // want enough information to make autoclosing work properly,
        // and then hand off the tricky stuff to the ChildDef.
        $ol->wrap = 'li';
        $ul->wrap = 'li';
        $this->addElement('dl', 'List', 'Required: dt | dd', 'Common');

        $this->addElement('li', false, 'Flow', 'Common');

        $this->addElement('dd', false, 'Flow', 'Common');
        $this->addElement('dt', false, 'Inline', 'Common');
    }

Here is the call graph for this function:

Field Documentation

HTMLPurifier_HTMLModule_List::$content_sets = array('Flow' => 'List')

Definition at line 20 of file List.php.

HTMLPurifier_HTMLModule_List::$name = 'List'

Definition at line 9 of file List.php.

---

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

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