Docs For Class HTMLPurifier

Description

Base class for all validating attribute definitions.

Base class for all validating attribute definitions. This family of classes forms the core for not only HTML attribute validation, but also any sort of string that needs to be validated or cleaned (which means CSS properties and composite definitions are defined here too). Besides defining (through code) what precisely makes the string valid, subclasses are also responsible for cleaning the code if possible.

abstract:

Located in /library/HTMLPurifier/AttrDef.php (line 13)

Direct descendents

Class	Description
HTMLPurifier_AttrDef_CSS	Validates the HTML attribute style, otherwise known as CSS.
HTMLPurifier_AttrDef_CSS_Background	Validates shorthand CSS property background.
HTMLPurifier_AttrDef_CSS_BackgroundPosition	Validates the value of background-position.
HTMLPurifier_AttrDef_CSS_Border	Validates the border property as defined by CSS.
HTMLPurifier_AttrDef_CSS_Color	Validates Color as defined by CSS.
HTMLPurifier_AttrDef_CSS_Composite	Allows multiple validators to attempt to validate attribute.
HTMLPurifier_AttrDef_CSS_DenyElementDecorator	Decorator which enables CSS properties to be disabled for specific elements.
HTMLPurifier_AttrDef_CSS_Filter	Microsoft's proprietary filter: CSS property
HTMLPurifier_AttrDef_CSS_Font	Validates shorthand CSS property font.
HTMLPurifier_AttrDef_CSS_FontFamily	Validates a font family list according to CSS spec
HTMLPurifier_AttrDef_CSS_ImportantDecorator	Decorator which enables !important to be used in CSS values.
HTMLPurifier_AttrDef_CSS_Length	Represents a Length as defined by CSS.
HTMLPurifier_AttrDef_CSS_ListStyle	Validates shorthand CSS property list-style.
HTMLPurifier_AttrDef_CSS_Multiple	Framework class for strings that involve multiple values.
HTMLPurifier_AttrDef_CSS_Number	Validates a number as defined by the CSS spec.
HTMLPurifier_AttrDef_CSS_Percentage	Validates a Percentage as defined by the CSS spec.
HTMLPurifier_AttrDef_CSS_TextDecoration	Validates the value for the CSS property text-decoration
HTMLPurifier_AttrDef_Enum	Validates a keyword against a list of valid values.
HTMLPurifier_AttrDef_HTML_Bool	Validates a boolean attribute
HTMLPurifier_AttrDef_HTML_Color	Validates a color according to the HTML spec.
HTMLPurifier_AttrDef_HTML_ID	Validates the HTML attribute ID.
HTMLPurifier_AttrDef_HTML_LinkTypes	Validates a rel/rev link attribute against a directive of allowed values
HTMLPurifier_AttrDef_HTML_Nmtokens	Validates contents based on NMTOKENS attribute type.
HTMLPurifier_AttrDef_HTML_Pixels	Validates an integer representation of pixels according to the HTML spec.
HTMLPurifier_AttrDef_Integer	Validates an integer.
HTMLPurifier_AttrDef_Lang	Validates the HTML attribute lang, effectively a language code.
HTMLPurifier_AttrDef_Text	Validates arbitrary text according to the HTML spec.
HTMLPurifier_AttrDef_URI	Validates a URI as defined by RFC 3986.
HTMLPurifier_AttrDef_URI_Email	Base class for all validating attribute definitions.
HTMLPurifier_AttrDef_URI_Host	Validates a host according to the IPv4, IPv6 and DNS (future) specifications.
HTMLPurifier_AttrDef_URI_IPv4	Validates an IPv4 address

Variable Summary

mixed $minimized

mixed $required

Method Summary

Created make ($string $string)

void mungeRgb ( $string)

void parseCDATA ( $string)

void validate ($string $string, $config $config, $context $context)

Variables

mixed $minimized = false (line 20)

Tells us whether or not an HTML attribute is minimized. meaning in other contexts.

Tells us whether or not an HTML attribute is minimized. Has no meaning in other contexts.

access: public

Redefined in descendants as:

HTMLPurifier_AttrDef_HTML_Bool::$minimized

mixed $required = false (line 26)

Tells us whether or not an HTML attribute is required.

Tells us whether or not an HTML attribute is required. Has no meaning in other contexts

access: public

Methods

make (line 69)

Factory method for creating this class from a string.

return: AttrDef object corresponding to $string
access: public

Created make ($string $string)

$string $string: String construction info

Redefined in descendants as:

mungeRgb (line 81)

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

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

access: protected

void mungeRgb ( $string)

$string

parseCDATA (line 58)

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

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.

access: public

void parseCDATA ( $string)

$string

validate (line 35)

Validates and cleans passed string according to a definition.

abstract:
access: public

void validate ($string $string, $config $config, $context $context)

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

Redefined in descendants as:

Class HTMLPurifier_AttrDef