HTMLPurifier_AttrDef
in package
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.
Table of Contents
Properties
- $minimized : mixed
- Tells us whether or not an HTML attribute is minimized.
- $required : mixed
- Tells us whether or not an HTML attribute is required.
Methods
- make() : HTMLPurifier_AttrDef
- Factory method for creating this class from a string.
- parseCDATA() : mixed
- Convenience method that parses a string as if it were CDATA.
- validate() : mixed
- Validates and cleans passed string according to a definition.
- expandCSSEscape() : mixed
- 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. THIS IS A HACK!
Properties
$minimized
Tells us whether or not an HTML attribute is minimized.
public
mixed
$minimized
= \false
Has no meaning in other contexts.
Tags
$required
Tells us whether or not an HTML attribute is required.
public
mixed
$required
= \false
Has no meaning in other contexts
Tags
Methods
make()
Factory method for creating this class from a string.
public
make(string $string) : HTMLPurifier_AttrDef
Parameters
- $string : string
-
String construction info
Return values
HTMLPurifier_AttrDef —Created AttrDef object corresponding to $string
parseCDATA()
Convenience method that parses a string as if it were CDATA.
public
parseCDATA(mixed $string) : mixed
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.
Parameters
- $string : mixed
Tags
validate()
Validates and cleans passed string according to a definition.
public
abstract validate(string $string, HTMLPurifier_Config $config, HTMLPurifier_Context $context) : mixed
Parameters
- $string : string
-
String to be validated and cleaned.
- $config : HTMLPurifier_Config
-
Mandatory HTMLPurifier_Config object.
- $context : HTMLPurifier_Context
-
Mandatory HTMLPurifier_Context object.
expandCSSEscape()
Parses a possibly escaped CSS string and returns the "pure" version of it.
protected
expandCSSEscape(mixed $string) : mixed
Parameters
- $string : mixed
mungeRgb()
Removes spaces from rgb(0, 0, 0) so that shorthand CSS properties work properly. THIS IS A HACK!
protected
mungeRgb(string $string) : string
Parameters
- $string : string
-
a CSS colour definition