HTMLPurifier 4.4.0
HTMLPurifier_HTMLModule_Iframe Class Reference

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

Inheritance diagram for HTMLPurifier_HTMLModule_Iframe:
HTMLPurifier_HTMLModule HTMLPurifier_HTMLModule

List of all members.

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.
 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 Attributes

 $name = 'Iframe'
 Short unique string identifier of the module.
 $safe = false
 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)

Lazy load construction of the module after determining whether or not it's needed, and also when a finalized configuration object is available.

Parameters:
$configInstance of HTMLPurifier_Config

Reimplemented from HTMLPurifier_HTMLModule.

Definition at line 16 of file Iframe.php.

References $config, and HTMLPurifier_HTMLModule::addElement().

HTMLPurifier_HTMLModule_Iframe::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:
$configInstance of HTMLPurifier_Config

Reimplemented from HTMLPurifier_HTMLModule.

Definition at line 12698 of file HTMLPurifier.standalone.php.

References $config, and HTMLPurifier_HTMLModule::addElement().


Member Data Documentation

HTMLPurifier_HTMLModule_Iframe::$name = 'Iframe'

Short unique string identifier of the module.

Reimplemented from HTMLPurifier_HTMLModule.

Definition at line 13 of file Iframe.php.

HTMLPurifier_HTMLModule_Iframe::$safe = false

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")

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.

Reimplemented from HTMLPurifier_HTMLModule.

Definition at line 14 of file Iframe.php.


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