Abstract Class HTMLPurifier_AttrDef

InheritanceHTMLPurifier_AttrDef
SubclassesHTMLPurifier_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_Clone, HTMLPurifier_AttrDef_Enum, HTMLPurifier_AttrDef_HTML_Bool, HTMLPurifier_AttrDef_HTML_Class, HTMLPurifier_AttrDef_HTML_Color, 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, HTMLPurifier_AttrDef_URI_Email_SimpleCheck, HTMLPurifier_AttrDef_URI_Host, HTMLPurifier_AttrDef_URI_IPv4, HTMLPurifier_AttrDef_URI_IPv6

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.

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$minimized Tells us whether or not an HTML attribute is minimized. HTMLPurifier_AttrDef
$required Tells us whether or not an HTML attribute is required. HTMLPurifier_AttrDef

Public Methods

Hide inherited methods

MethodDescriptionDefined By
make() Factory method for creating this class from a string. HTMLPurifier_AttrDef
parseCDATA() Convenience method that parses a string as if it were CDATA. HTMLPurifier_AttrDef
validate() Validates and cleans passed string according to a definition. HTMLPurifier_AttrDef

Protected Methods

Hide inherited methods

MethodDescriptionDefined By
expandCSSEscape() Parses a possibly escaped CSS string and returns the "pure" version of it. HTMLPurifier_AttrDef
mungeRgb() Removes spaces from rgb(0, 0, 0) so that shorthand CSS properties work properly. THIS IS A HACK! HTMLPurifier_AttrDef

Property Details

$minimized public property

Has no meaning in other contexts.

public $minimized false
$required public property

Has no meaning in other contexts

public $required false

Method Details

expandCSSEscape() protected method

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

protected void expandCSSEscape ( $string )
$string
make() public method

Factory method for creating this class from a string.

public HTMLPurifier_AttrDef make ( $string )
$string string

String construction info

return HTMLPurifier_AttrDef

Created AttrDef object corresponding to $string

mungeRgb() protected method

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

protected string mungeRgb ( $string )
$string string

A CSS colour definition

parseCDATA() public method

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.

public void parseCDATA ( $string )
$string
validate() public abstract method

Validates and cleans passed string according to a definition.

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

String to be validated and cleaned.

$config HTMLPurifier_Config

Mandatory HTMLPurifier_Config object.

$context HTMLPurifier_Context

Mandatory HTMLPurifier_Context object.