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.
- Full name:
\HTMLPurifier_AttrDef_CSS_Multiple
- Parent class:
\HTMLPurifier_AttrDef
Properties
single
Instance of component definition to defer validation to.
max
Max number of values allowed.
Methods
__construct
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.
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.
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!
Parameters:
Parameter | Type | Description |
---|---|---|
$string |
string | a CSS colour definition |
expandCSSEscape
Parses a possibly escaped CSS string and returns the "pure" version of it.
Parameters:
Parameter | Type | Description |
---|---|---|
$string |
mixed |
Automatically generated on 2025-03-18