\HTMLPurifier_AttrTransform

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.

Summary

Methods
Properties
Constants
transform()
prependCSS()
confiscateAttr()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Methods

transform()

transform(array  $attr, \HTMLPurifier_Config  $config, \HTMLPurifier_Context  $context) : array

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.

prependCSS()

prependCSS(array  $attr, string  $css) : mixed

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

Returns

mixed —

confiscateAttr()

confiscateAttr(array  $attr, mixed  $key) : mixed

Retrieves and removes an attribute

Parameters

array $attr

Attribute array to process (passed by reference)

mixed $key

Key of attribute to confiscate

Returns

mixed —