HTMLPurifier_AttrTransform_ImgSpace Class Reference

Pre-transform that changes deprecated hspace and vspace attributes to CSS. More...

Inheritance diagram for HTMLPurifier_AttrTransform_ImgSpace:

Collaboration diagram for HTMLPurifier_AttrTransform_ImgSpace:

Public Member Functions
	__construct ($attr)
	transform ($attr, $config, $context)
Public Member Functions inherited from HTMLPurifier_AttrTransform
	prependCSS (&$attr, $css)
	Prepends CSS properties to the style attribute, creating the attribute if it doesn't exist.
	confiscateAttr (&$attr, $key)
	Retrieves and removes an attribute.

Protected Attributes
	$attr
	string
	$css
	array

Detailed Description

Pre-transform that changes deprecated hspace and vspace attributes to CSS.

Definition at line 6 of file ImgSpace.php.

Constructor & Destructor Documentation

HTMLPurifier_AttrTransform_ImgSpace::__construct

(

$attr

)

Parameters

string

$attr

Definition at line 24 of file ImgSpace.php.

References $attr.

    {
        $this->attr = $attr;
        if (!isset($this->css[$attr])) {
            trigger_error(htmlspecialchars($attr) . ' is not valid space attribute');
        }
    }

Member Function Documentation

HTMLPurifier_AttrTransform_ImgSpace::transform	(		$attr,
			$config,
			$context
	)

Parameters

array	$attr
HTMLPurifier_Config	$config
HTMLPurifier_Context	$context

Returns

array

Reimplemented from HTMLPurifier_AttrTransform.

Definition at line 38 of file ImgSpace.php.

References $attr, HTMLPurifier_AttrTransform\confiscateAttr(), and HTMLPurifier_AttrTransform\prependCSS().

    {
        if (!isset($attr[$this->attr])) {
            return $attr;
        }

        $width = $this->confiscateAttr($attr, $this->attr);
        // some validation could happen here

        if (!isset($this->css[$this->attr])) {
            return $attr;
        }

        $style = '';
        foreach ($this->css[$this->attr] as $suffix) {
            $property = "margin-$suffix";
            $style .= "$property:{$width}px;";
        }
        $this->prependCSS($attr, $style);
        return $attr;
    }

Here is the call graph for this function:

Field Documentation

HTMLPurifier_AttrTransform_ImgSpace::$attr

protected

string

Definition at line 11 of file ImgSpace.php.

Referenced by __construct(), and transform().

HTMLPurifier_AttrTransform_ImgSpace::$css

protected

Initial value:

 array(
        'hspace' => array('left', 'right'),
        'vspace' => array('top', 'bottom')
    )

array

Definition at line 16 of file ImgSpace.php.

---

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

• Services/Html/HtmlPurifier/library/HTMLPurifier/AttrTransform/ImgSpace.php