HTMLPurifier_HTMLModule_Edit Class Reference

XHTML 1.1 Edit Module, defines editing-related elements. More...

Inheritance diagram for HTMLPurifier_HTMLModule_Edit:

Collaboration diagram for HTMLPurifier_HTMLModule_Edit:

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.
	getChildDef ($def)
	Retrieves a proper HTMLPurifier_ChildDef subclass based on content_model and content_model_type member variables of the HTMLPurifier_ElementDef class.
Public Member Functions inherited from HTMLPurifier_HTMLModule
	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 = 'Edit'
	$defines_child_def = true
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 Edit Module, defines editing-related elements.

Text Extension Module.

Definition at line 7 of file Edit.php.

Member Function Documentation

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

$def	HTMLPurifier_ElementDef instance

Returns

HTMLPurifier_ChildDef subclass

Reimplemented from HTMLPurifier_HTMLModule.

Definition at line 30 of file Edit.php.

                                      {
        if ($def->content_model_type != 'chameleon') return false;
        $value = explode('!', $def->content_model);
        return new HTMLPurifier_ChildDef_Chameleon($value[0], $value[1]);
    }

HTMLPurifier_HTMLModule_Edit::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 12 of file Edit.php.

References HTMLPurifier_HTMLModule\addElement().

                                   {
        $contents = 'Chameleon: #PCDATA | Inline ! #PCDATA | Flow';
        $attr = array(
            'cite' => 'URI',
            // 'datetime' => 'Datetime', // not implemented
        );
        $this->addElement('del', 'Inline', $contents, 'Common', $attr);
        $this->addElement('ins', 'Inline', $contents, 'Common', $attr);
    }

Here is the call graph for this function:

Field Documentation

HTMLPurifier_HTMLModule_Edit::$defines_child_def = true

Definition at line 29 of file Edit.php.

HTMLPurifier_HTMLModule_Edit::$name = 'Edit'

Definition at line 10 of file Edit.php.

---

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

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