\HTMLPurifier_AttrDef_CSS_Composite

Allows multiple validators to attempt to validate attribute.

Composite is just what it sounds like: a composite of many validators. This means that multiple HTMLPurifier_AttrDef objects will have a whack at the string. If one of them passes, that's what is returned. This is especially useful for CSS values, which often are a choice between an enumerated set of predefined values or a flexible data type.

Summary

Methods
Properties
Constants
validate()
parseCDATA()
make()
__construct()
$minimized
$required
$defs
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.

Type

$required

$required : 

Tells us whether or not an HTML attribute is required.

Has no meaning in other contexts

Type

$defs

$defs : 

List of objects that may process strings.

Type

Methods

validate()

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

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

boolean|string

parseCDATA()

parseCDATA(  $string) 

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

$string

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

__construct()

__construct(array<mixed,\HTMLPurifier_AttrDef>  $defs) 

Parameters

array<mixed,\HTMLPurifier_AttrDef> $defs

List of HTMLPurifier_AttrDef objects

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(  $string) 

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

Parameters

$string