HTMLPurifier_AttrDef_Enum Class Reference

Inheritance diagram for HTMLPurifier_AttrDef_Enum:

Public Member Functions
	__construct ($valid_values=array(), $case_sensitive=false)
	make ($string)
	parseCDATA ($string)
	Convenience method that parses a string as if it were CDATA.
	validate ($string, $config, $context)

Public Attributes
	$minimized = false
	Tells us whether or not an HTML attribute is minimized.
	$required = false
	Tells us whether or not an HTML attribute is required.
	$valid_values = array()
	Lookup table of valid values.

Protected Member Functions
	expandCSSEscape ($string)
	Parses a possibly escaped CSS string and returns the "pure" version of it.
	mungeRgb ($string)
	Removes spaces from rgb(0, 0, 0) so that shorthand CSS properties work properly.

Protected Attributes
	$case_sensitive = false
	Bool indicating whether or not enumeration is case sensitive.

Constructor & Destructor Documentation

__construct()

HTMLPurifier_AttrDef_Enum::__construct	(		$valid_values = array(),
			$case_sensitive = false )

Parameters

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

Member Function Documentation

make()

HTMLPurifier_AttrDef_Enum::make

(

$string

)

Parameters

string

$string

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

Return values

HTMLPurifier_AttrDef_Enum

Reimplemented from HTMLPurifier_AttrDef.

mungeRgb()

HTMLPurifier_AttrDef::mungeRgb ( $string )

protectedinherited

Removes spaces from rgb(0, 0, 0) so that shorthand CSS properties work properly.

THIS IS A HACK!

Parameters

string

$string

a CSS colour definition

Return values

string

parseCDATA()

HTMLPurifier_AttrDef::parseCDATA ( $string )

inherited

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

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.

Note

This method is not entirely standards compliant, as trim() removes more types of whitespace than specified in the spec. In practice, this is rarely a problem, as those extra characters usually have already been removed by HTMLPurifier_Encoder.

Warning

This processing is inconsistent with XML's whitespace handling as specified by section 3.3.3 and referenced XHTML 1.0 section 4.7. However, note that we are NOT necessarily parsing XML, thus, this behavior may still be correct. We assume that newlines have been normalized.

validate()

HTMLPurifier_AttrDef_Enum::validate	(		$string,
			$config,
			$context )

Parameters

string	$string
HTMLPurifier_Config	$config
HTMLPurifier_Context	$context

Return values

bool|string

Reimplemented from HTMLPurifier_AttrDef.

Reimplemented in HTMLPurifier_AttrDef_HTML_FrameTarget.

Member Data Documentation

$case_sensitive

HTMLPurifier_AttrDef_Enum::$case_sensitive = false

protected

Bool indicating whether or not enumeration is case sensitive.

Note

In general this is always case insensitive.

$minimized

HTMLPurifier_AttrDef::$minimized = false

inherited

Tells us whether or not an HTML attribute is minimized.

Has no meaning in other contexts. @type bool

$required

HTMLPurifier_AttrDef::$required = false

inherited

Tells us whether or not an HTML attribute is required.

Has no meaning in other contexts @type bool

$valid_values

HTMLPurifier_AttrDef_Enum::$valid_values = array()

Lookup table of valid values.

@type array

Todo

Make protected

---

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

• lib/htmlpurifier/HTMLPurifier/AttrDef/Enum.php