\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.

Summary

Methods
Properties
Constants
validate()
parseCDATA()
make()
$minimized
$required
No constants found
mungeRgb()
expandCSSEscape()
No protected properties found
N/A
No private methods found
No private properties found
N/A

Properties

$minimized

$minimized

Tells us whether or not an HTML attribute is minimized.

Has no meaning in other contexts.

$required

$required

Tells us whether or not an HTML attribute is required.

Has no meaning in other contexts

Methods

validate()

validate(string  $string, \HTMLPurifier_Config  $config, \HTMLPurifier_Context  $context) : mixed

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.

Returns

mixed —

parseCDATA()

parseCDATA(mixed  $string) : mixed

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.

Parameters

mixed $string

Returns

mixed —

make()

make(string  $string) : \HTMLPurifier_AttrDef

Factory method for creating this class from a string.

Parameters

string $string

String construction info

Returns

\HTMLPurifier_AttrDef —

Created AttrDef object corresponding to $string

mungeRgb()

mungeRgb(string  $string) : string

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

Returns

string —

expandCSSEscape()

expandCSSEscape(mixed  $string) : mixed

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

Parameters

mixed $string

Returns

mixed —