HTMLPurifier_HTMLModule_Iframe Class Reference

XHTML 1.1 Iframe Module provides inline frames. More...

Inheritance diagram for HTMLPurifier_HTMLModule_Iframe:

Collaboration diagram for HTMLPurifier_HTMLModule_Iframe:

Public Member Functions
	setup ($config)
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 = 'Iframe'
	string
	$safe = false
	bool
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 Iframe Module provides inline frames.

Note

This module is not considered safe unless an Iframe whitelisting mechanism is specified. Currently, the only such mechanism is URL.SafeIframeRegexp

Definition at line 10 of file Iframe.php.

Member Function Documentation

HTMLPurifier_HTMLModule_Iframe::setup

(

$config

)

Parameters

HTMLPurifier_Config

$config

Reimplemented from HTMLPurifier_HTMLModule.

Definition at line 26 of file Iframe.php.

References HTMLPurifier_HTMLModule\addElement().

    {
        if ($config->get('HTML.SafeIframe')) {
            $this->safe = true;
        }
        $this->addElement(
            'iframe',
            'Inline',
            'Flow',
            'Common',
            array(
                'src' => 'URI#embedded',
                'width' => 'Length',
                'height' => 'Length',
                'name' => 'ID',
                'scrolling' => 'Enum#yes,no,auto',
                'frameborder' => 'Enum#0,1',
                'longdesc' => 'URI',
                'marginheight' => 'Pixels',
                'marginwidth' => 'Pixels',
            )
        );
    }

Here is the call graph for this function:

Field Documentation

HTMLPurifier_HTMLModule_Iframe::$name = 'Iframe'

string

Definition at line 16 of file Iframe.php.

HTMLPurifier_HTMLModule_Iframe::$safe = false

bool

Definition at line 21 of file Iframe.php.

---

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

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