HTMLPurifier_AttrTransform Class Reference

Inheritance diagram for HTMLPurifier_AttrTransform:

Public Member Functions
	transform ($attr, $config, $context)
	prependCSS (&$attr, $css)
	confiscateAttr (&$attr, $key)

---

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	(	&$	attr,
		$	key
	)

Retrieves and removes an attribute

Parameters:

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

Definition at line 47 of file AttrTransform.php.

Here is the caller graph for this function:

prependCSS	(	&$	attr,
		$	css
	)

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

Parameters:

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

Definition at line 37 of file AttrTransform.php.

Here is the caller graph for this function:

transform	(	$	attr,
		$	config,
		$	context
	)		[abstract]

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

Parameters:

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

Returns:

Processed attribute array.

Reimplemented in HTMLPurifier_AttrTransform_EnumToCSS, HTMLPurifier_AttrTransform_BoolToCSS, HTMLPurifier_AttrTransform_SafeParam, HTMLPurifier_AttrTransform_ImgSpace, HTMLPurifier_AttrTransform_Length, HTMLPurifier_AttrTransform_Nofollow, HTMLPurifier_AttrTransform_Input, HTMLPurifier_AttrTransform_NameSync, HTMLPurifier_AttrTransform_ImgRequired, HTMLPurifier_AttrTransform_BdoDir, HTMLPurifier_AttrTransform_Lang, HTMLPurifier_AttrTransform_SafeObject, HTMLPurifier_AttrTransform_Name, HTMLPurifier_AttrTransform_Textarea, HTMLPurifier_AttrTransform_Background, HTMLPurifier_AttrTransform_BgColor, HTMLPurifier_AttrTransform_Border, HTMLPurifier_AttrTransform_ScriptRequired, and HTMLPurifier_AttrTransform_SafeEmbed.

---

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

• C:/xampp/htdocs/moodle/lib/htmlpurifier/HTMLPurifier/AttrTransform.php