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
	transform ($attr, $config, $context)
	Abstract: makes changes to the attributes dependent on multiple values. More...

	prependCSS (&$attr, $css)
	Prepends CSS properties to the style attribute, creating the attribute if it doesn't exist. More...

	confiscateAttr (&$attr, $key)
	Retrieves and removes an attribute. More...

Protected Attributes
	$attr
	string More...

	$css
	array More...

Detailed Description

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

Definition at line 6 of file ImgSpace.php.

Constructor & Destructor Documentation

◆ __construct()

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

◆ transform()

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

Parameters

array	$attr
HTMLPurifier_Config	$config
HTMLPurifier_Context	$context

Returns: array

Definition at line 38 of file ImgSpace.php.

References $attr, $style, 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

◆ $attr

HTMLPurifier_AttrTransform_ImgSpace::$attr

protected

string

Definition at line 11 of file ImgSpace.php.

Referenced by __construct(), and transform().

◆ $css

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

Public Member Functions

Protected Attributes