PHP Class HTMLPurifier_AttrTransform, yii

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.

Show file Open project: yiisoft/yii

Public Methods

Method	Description
confiscateAttr ( &$attr, mixed $key ) : mixed	Retrieves and removes an attribute
prependCSS ( &$attr, string $css )	Prepends CSS properties to the style attribute, creating the attribute if it doesn't exist.
transform ( array $attr, HTMLPurifier_Config $config, HTMLPurifier_Context $context ) : array	Abstract: makes changes to the attributes dependent on multiple values.

Method Details

confiscateAttr() public method

Retrieves and removes an attribute

public confiscateAttr ( &$attr, mixed $key ) : mixed
$key	mixed	Key of attribute to confiscate
return	mixed

prependCSS() public method

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

public prependCSS ( &$attr, string $css )
$css	string	CSS to prepend

transform() abstract public method

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

abstract public transform ( array $attr, HTMLPurifier_Config $config, HTMLPurifier_Context $context ) : array
$attr	array	Assoc array of attributes, usually from HTMLPurifier_Token_Tag::$attr
$config	HTMLPurifier_Config	Mandatory HTMLPurifier_Config object.
$context	HTMLPurifier_Context	Mandatory HTMLPurifier_Context object
return	array	Processed attribute array.