PSR-2 reformatting PHPDoc corrections
[htmlpurifier.git] / library / HTMLPurifier / HTMLModule / Iframe.php
blobf7e7c91c02cfe9f70eace8984d96f993d2454abd
1 <?php
3 /**
4 * XHTML 1.1 Iframe Module provides inline frames.
6 * @note This module is not considered safe unless an Iframe
7 * whitelisting mechanism is specified. Currently, the only
8 * such mechanism is %URL.SafeIframeRegexp
9 */
10 class HTMLPurifier_HTMLModule_Iframe extends HTMLPurifier_HTMLModule
13 /**
14 * @type string
16 public $name = 'Iframe';
18 /**
19 * @type bool
21 public $safe = false;
23 /**
24 * @param HTMLPurifier_Config $config
26 public function setup($config)
28 if ($config->get('HTML.SafeIframe')) {
29 $this->safe = true;
31 $this->addElement(
32 'iframe',
33 'Inline',
34 'Flow',
35 'Common',
36 array(
37 'src' => 'URI#embedded',
38 'width' => 'Length',
39 'height' => 'Length',
40 'name' => 'ID',
41 'scrolling' => 'Enum#yes,no,auto',
42 'frameborder' => 'Enum#0,1',
43 'longdesc' => 'URI',
44 'marginheight' => 'Pixels',
45 'marginwidth' => 'Pixels',
51 // vim: et sw=4 sts=4