Abstract Class HTMLPurifier_AttrDef
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
Property | Type | Description | Defined 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
Method | Description | Defined 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
Method | Description | Defined 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
Has no meaning in other contexts.
Has no meaning in other contexts
Method Details
Parses a possibly escaped CSS string and returns the "pure" version of it.
protected void expandCSSEscape ( $string ) | ||
$string |
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 |
---|
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 |
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 |
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. |