HTMLPurifier_AttrDef Class Reference

Inheritance diagram for HTMLPurifier_AttrDef:

Public Member Functions
	make ($string)
	Factory method for creating this class from a string.
	parseCDATA ($string)
	Convenience method that parses a string as if it were CDATA.
	validate ($string, $config, $context)
	Validates and cleans passed string according to a definition.

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.

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.

Member Function Documentation

make()

HTMLPurifier_AttrDef::make

(

$string

)

Factory method for creating this class from a string.

Parameters

string

$string

String construction info

Return values

HTMLPurifier_AttrDef

Created AttrDef object corresponding to $string

Reimplemented in HTMLPurifier_AttrDef_Clone, HTMLPurifier_AttrDef_Enum, HTMLPurifier_AttrDef_HTML_Bool, HTMLPurifier_AttrDef_HTML_Pixels, and HTMLPurifier_AttrDef_URI.

mungeRgb()

HTMLPurifier_AttrDef::mungeRgb ( $string )

protected

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

)

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::validate ( $string, $config, $context )

abstract

Validates and cleans passed string according to a definition.

Parameters

string	$string	String to be validated and cleaned.
HTMLPurifier_Config	$config	Mandatory HTMLPurifier_Config object.
HTMLPurifier_Context	$context	Mandatory HTMLPurifier_Context object.

Reimplemented in HTMLPurifier_AttrDef_Clone, HTMLPurifier_AttrDef_CSS, HTMLPurifier_AttrDef_CSS_AlphaValue, HTMLPurifier_AttrDef_CSS_Background, HTMLPurifier_AttrDef_CSS_BackgroundPosition, HTMLPurifier_AttrDef_CSS_Border, HTMLPurifier_AttrDef_CSS_Color, HTMLPurifier_AttrDef_CSS_Composite, HTMLPurifier_AttrDef_CSS_DenyElementDecorator, HTMLPurifier_AttrDef_CSS_Filter, HTMLPurifier_AttrDef_CSS_Font, HTMLPurifier_AttrDef_CSS_FontFamily, HTMLPurifier_AttrDef_CSS_Ident, HTMLPurifier_AttrDef_CSS_ImportantDecorator, HTMLPurifier_AttrDef_CSS_Length, HTMLPurifier_AttrDef_CSS_ListStyle, HTMLPurifier_AttrDef_CSS_Multiple, HTMLPurifier_AttrDef_CSS_Number, HTMLPurifier_AttrDef_CSS_Percentage, HTMLPurifier_AttrDef_CSS_TextDecoration, HTMLPurifier_AttrDef_CSS_URI, HTMLPurifier_AttrDef_Enum, HTMLPurifier_AttrDef_HTML_Bool, HTMLPurifier_AttrDef_HTML_Color, HTMLPurifier_AttrDef_HTML_ContentEditable, HTMLPurifier_AttrDef_HTML_FrameTarget, HTMLPurifier_AttrDef_HTML_ID, HTMLPurifier_AttrDef_HTML_Length, HTMLPurifier_AttrDef_HTML_LinkTypes, HTMLPurifier_AttrDef_HTML_MultiLength, HTMLPurifier_AttrDef_HTML_Nmtokens, HTMLPurifier_AttrDef_HTML_Pixels, HTMLPurifier_AttrDef_Integer, HTMLPurifier_AttrDef_Lang, HTMLPurifier_AttrDef_Text, HTMLPurifier_AttrDef_URI, HTMLPurifier_AttrDef_URI_Email_SimpleCheck, HTMLPurifier_AttrDef_URI_Host, HTMLPurifier_AttrDef_URI_IPv4, and HTMLPurifier_AttrDef_URI_IPv6.

Member Data Documentation

$minimized

HTMLPurifier_AttrDef::$minimized = false

Tells us whether or not an HTML attribute is minimized.

Has no meaning in other contexts. @type bool

$required

HTMLPurifier_AttrDef::$required = false

Tells us whether or not an HTML attribute is required.

Has no meaning in other contexts @type bool

---

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

• lib/htmlpurifier/HTMLPurifier/AttrDef.php