\HTMLPurifier_AttrDef_CSS_Multiple

Framework class for strings that involve multiple values.

Certain CSS properties such as border-width and margin allow multiple lengths to be specified. This class can take a vanilla border-width definition and multiply it, usually into a max of four.

Summary

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

$single

$single : 

Instance of component definition to defer validation to.

Type

$max

$max : 

Max number of values allowed.

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(\HTMLPurifier_AttrDef  $single, integer  $max = 4) 

Parameters

\HTMLPurifier_AttrDef $single

HTMLPurifier_AttrDef to multiply

integer $max

Max number of values allowed (usually four)

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