HTMLPurifier_HTMLModule_Image Class Reference

XHTML 1.1 Image Module provides basic image embedding. More...

Inheritance diagram for HTMLPurifier_HTMLModule_Image:

Collaboration diagram for HTMLPurifier_HTMLModule_Image:

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 = 'Image'
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 Image Module provides basic image embedding.

Note

There is specialized code for removing empty images in HTMLPurifier_Strategy_RemoveForeignElements

Definition at line 8 of file Image.php.

Member Function Documentation

HTMLPurifier_HTMLModule_Image::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 13 of file Image.php.

References $config, $img, and HTMLPurifier_HTMLModule\addElement().

                                   {
        $max = $config->get('HTML.MaxImgLength');
        $img = $this->addElement(
            'img', 'Inline', 'Empty', 'Common',
            array(
                'alt*' => 'Text',
                // According to the spec, it's Length, but percents can
                // be abused, so we allow only Pixels.
                'height' => 'Pixels#' . $max,
                'width'  => 'Pixels#' . $max,
                'longdesc' => 'URI',
                'src*' => new HTMLPurifier_AttrDef_URI(true), // embedded
            )
        );
        if ($max === null || $config->get('HTML.Trusted')) {
            $img->attr['height'] =
            $img->attr['width'] = 'Length';
        }

        // kind of strange, but splitting things up would be inefficient
        $img->attr_transform_pre[] =
        $img->attr_transform_post[] =
            new HTMLPurifier_AttrTransform_ImgRequired();
    }

Here is the call graph for this function:

Field Documentation

HTMLPurifier_HTMLModule_Image::$name = 'Image'

Definition at line 11 of file Image.php.

---

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

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