HTMLPurifier_AttrDef_Enum

Validates a keyword against a list of valid values.

• Full name: \HTMLPurifier_AttrDef_Enum
• Parent class: \HTMLPurifier_AttrDef

Properties

valid_values

Lookup table of valid values.

public $valid_values

---

case_sensitive

Bool indicating whether or not enumeration is case sensitive.

protected $case_sensitive

---

Methods

__construct

public __construct(array $valid_values = array(), bool $case_sensitive = false): mixed

Parameters:

Parameter	Type	Description
$valid_values	array	List of valid values
$case_sensitive	bool	Whether or not case sensitive

---

validate

Validates and cleans passed string according to a definition.

public validate(string $string, \HTMLPurifier_Config $config, \HTMLPurifier_Context $context): bool|string

Parameters:

Parameter	Type	Description
$string	string
$config	\HTMLPurifier_Config
$context	\HTMLPurifier_Context

---

make

Factory method for creating this class from a string.

public make(string $string): \HTMLPurifier_AttrDef_Enum

Parameters:

Parameter	Type	Description
$string	string	In form of comma-delimited list of case-insensitive valid values. Example: "foo,bar,baz". Prepend "s:" to make case sensitive

---

Inherited methods

validate

Validates and cleans passed string according to a definition.

public validate(string $string, \HTMLPurifier_Config $config, \HTMLPurifier_Context $context): mixed

• This method is abstract.

Parameters:

Parameter	Type	Description
$string	string	String to be validated and cleaned.
$config	\HTMLPurifier_Config	Mandatory HTMLPurifier_Config object.
$context	\HTMLPurifier_Context	Mandatory HTMLPurifier_Context object.

---

parseCDATA

Convenience method that parses a string as if it were CDATA.

public parseCDATA(mixed $string): mixed

This method process a string in the manner specified at http://www.w3.org/TR/html4/types.html#h-6.2 by removing leading and trailing whitespace, ignoring line feeds, and replacing carriage returns and tabs with spaces. While most useful for HTML attributes specified as CDATA, it can also be applied to most CSS values.

Parameters:

Parameter	Type	Description
$string	mixed

---

make

Factory method for creating this class from a string.

public make(string $string): \HTMLPurifier_AttrDef

Parameters:

Parameter	Type	Description
$string	string	String construction info

Return Value:

Created AttrDef object corresponding to $string

---

mungeRgb

Removes spaces from rgb(0, 0, 0) so that shorthand CSS properties work properly. THIS IS A HACK!

protected mungeRgb(string $string): string

Parameters:

Parameter	Type	Description
$string	string	a CSS colour definition

---

expandCSSEscape

Parses a possibly escaped CSS string and returns the "pure" version of it.

protected expandCSSEscape(mixed $string): mixed

Parameters:

Parameter	Type	Description
$string	mixed

---

---

Automatically generated on 2025-03-18