HTMLPurifier_AttrTransform Class Reference

Processes an entire attribute array for corrections needing multiple values. More...

Inheritance diagram for HTMLPurifier_AttrTransform:

Collaboration diagram for HTMLPurifier_AttrTransform:

Public Member Functions
	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...

Detailed Description

Processes an entire attribute array for corrections needing multiple values.

Occasionally, a certain attribute will need to be removed and popped onto another value. Instead of creating a complex return syntax for HTMLPurifier_AttrDef, we just pass the whole attribute array to a specialized object and have that do the special work. That is the family of HTMLPurifier_AttrTransform.

An attribute transformation can be assigned to run before or after HTMLPurifier_AttrDef validation. See HTMLPurifier_HTMLDefinition for more details.

Definition at line 17 of file AttrTransform.php.

Member Function Documentation

confiscateAttr()

HTMLPurifier_AttrTransform::confiscateAttr	(	&	$attr,
			$key
	)

Retrieves and removes an attribute.

Parameters

array	&$attr	Attribute array to process (passed by reference)
mixed	$key	Key of attribute to confiscate

Returns

mixed

Definition at line 49 of file AttrTransform.php.

Referenced by HTMLPurifier_AttrTransform_Background\transform(), HTMLPurifier_AttrTransform_Border\transform(), HTMLPurifier_AttrTransform_BgColor\transform(), HTMLPurifier_AttrTransform_Name\transform(), HTMLPurifier_AttrTransform_Length\transform(), and HTMLPurifier_AttrTransform_ImgSpace\transform().

    {
        if (!isset($attr[$key])) {
            return null;
        }
        $value = $attr[$key];
        unset($attr[$key]);
        return $value;
    }

Here is the caller graph for this function:

prependCSS()

HTMLPurifier_AttrTransform::prependCSS	(	&	$attr,
			$css
	)

Prepends CSS properties to the style attribute, creating the attribute if it doesn't exist.

Parameters

array	&$attr	Attribute array to process (passed by reference)
string	$css	CSS to prepend

Definition at line 37 of file AttrTransform.php.

Referenced by HTMLPurifier_AttrTransform_Background\transform(), HTMLPurifier_AttrTransform_Border\transform(), HTMLPurifier_AttrTransform_BgColor\transform(), HTMLPurifier_AttrTransform_Length\transform(), HTMLPurifier_AttrTransform_BoolToCSS\transform(), HTMLPurifier_AttrTransform_ImgSpace\transform(), and HTMLPurifier_AttrTransform_EnumToCSS\transform().

    {
        $attr['style'] = isset($attr['style']) ? $attr['style'] : '';
        $attr['style'] = $css . $attr['style'];
    }

Here is the caller graph for this function:

transform()

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

abstract

Abstract: makes changes to the attributes dependent on multiple values.

Parameters

array	$attr	Assoc array of attributes, usually from HTMLPurifier_Token_Tag::$attr
HTMLPurifier_Config	$config	Mandatory HTMLPurifier_Config object.
HTMLPurifier_Context	$context	Mandatory HTMLPurifier_Context object

Returns

array Processed attribute array.

---

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

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