HTMLPurifier_AttrTransform_EnumToCSS Class Reference

Generic pre-transform that converts an attribute with a fixed number of values (enumerated) to CSS. More...

Inheritance diagram for HTMLPurifier_AttrTransform_EnumToCSS:

Collaboration diagram for HTMLPurifier_AttrTransform_EnumToCSS:

Public Member Functions
	__construct ($attr, $enum_to_css, $case_sensitive=false)
	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
	Name of attribute to transform from.
	$enumToCSS = array()
	Lookup array of attribute values to CSS.
	$caseSensitive = false
	Case sensitivity of the matching.

Detailed Description

Generic pre-transform that converts an attribute with a fixed number of values (enumerated) to CSS.

Definition at line 7 of file EnumToCSS.php.

Constructor & Destructor Documentation

HTMLPurifier_AttrTransform_EnumToCSS::__construct	(		$attr,
			$enum_to_css,
			$case_sensitive = false
	)

Parameters

string	$attr	Attribute name to transform from
array	$enum_to_css	Lookup array of attribute values to CSS
bool	$case_sensitive	Case sensitivity indicator, default false

Definition at line 34 of file EnumToCSS.php.

References $attr.

    {
        $this->attr = $attr;
        $this->enumToCSS = $enum_to_css;
        $this->caseSensitive = (bool)$case_sensitive;
    }

Member Function Documentation

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

Parameters

array	$attr
HTMLPurifier_Config	$config
HTMLPurifier_Context	$context

Returns

array

Reimplemented from HTMLPurifier_AttrTransform.

Definition at line 47 of file EnumToCSS.php.

References $attr, and HTMLPurifier_AttrTransform\prependCSS().

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

        $value = trim($attr[$this->attr]);
        unset($attr[$this->attr]);

        if (!$this->caseSensitive) {
            $value = strtolower($value);
        }

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

Here is the call graph for this function:

Field Documentation

HTMLPurifier_AttrTransform_EnumToCSS::$attr

protected

Name of attribute to transform from.

string

Definition at line 13 of file EnumToCSS.php.

Referenced by __construct(), and transform().

HTMLPurifier_AttrTransform_EnumToCSS::$caseSensitive = false

protected

Case sensitivity of the matching.

bool

Warning

Currently can only be guaranteed to work with ASCII values.

Definition at line 27 of file EnumToCSS.php.

HTMLPurifier_AttrTransform_EnumToCSS::$enumToCSS = array()

protected

Lookup array of attribute values to CSS.

array

Definition at line 19 of file EnumToCSS.php.

---

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

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