Skip to content

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.

Properties

single

Instance of component definition to defer validation to.

public $single

max

Max number of values allowed.

public $max

Methods

__construct

public __construct(\HTMLPurifier_AttrDef $single, int $max = 4): mixed

Parameters:

Parameter Type Description
$single \HTMLPurifier_AttrDef HTMLPurifier_AttrDef to multiply
$max int Max number of values allowed (usually four)

validate

Validates and cleans passed string according to a definition.

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

Parameters:

Parameter Type Description
$string string
$config \HTMLPurifier_Config
$context \HTMLPurifier_Context

Inherited methods

validate

Validates and cleans passed string according to a definition.

public validate(string $string, \HTMLPurifier_Config $config, \HTMLPurifier_Context $context): mixed
  • This method is abstract.

Parameters:

Parameter Type Description
$string string String to be validated and cleaned.
$config \HTMLPurifier_Config Mandatory HTMLPurifier_Config object.
$context \HTMLPurifier_Context Mandatory HTMLPurifier_Context object.

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:

Parameter Type Description
$string mixed

make

Factory method for creating this class from a string.

public make(string $string): \HTMLPurifier_AttrDef

Parameters:

Parameter Type Description
$string string String construction info

Return Value:

Created AttrDef object corresponding to $string


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:

Parameter Type Description
$string string a CSS colour definition

expandCSSEscape

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

protected expandCSSEscape(mixed $string): mixed

Parameters:

Parameter Type Description
$string mixed


Automatically generated on 2025-03-18