Framework class for strings that involve multiple values. More...

Inheritance diagram for HTMLPurifier_AttrDef_CSS_Multiple:

Collaboration diagram for HTMLPurifier_AttrDef_CSS_Multiple:

Public Member Functions
	__construct ($single, $max=4)

	validate ($string, $config, $context)

Public Member Functions inherited from HTMLPurifier_AttrDef
	validate ($string, $config, $context)
	Validates and cleans passed string according to a definition. More...

	parseCDATA ($string)
	Convenience method that parses a string as if it were CDATA. More...

	make ($string)
	Factory method for creating this class from a string. More...

Data Fields
	$single
	Instance of component definition to defer validation to. More...

	$max
	Max number of values allowed. More...

Data Fields inherited from HTMLPurifier_AttrDef
	$minimized = false
	Tells us whether or not an HTML attribute is minimized. More...

	$required = false
	Tells us whether or not an HTML attribute is required. More...

Additional Inherited Members
Protected Member Functions inherited from HTMLPurifier_AttrDef
	mungeRgb ($string)
	Removes spaces from rgb(0, 0, 0) so that shorthand CSS properties work properly. More...

	expandCSSEscape ($string)
	Parses a possibly escaped CSS string and returns the "pure" version of it. More...

Detailed Description

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.

Note: Even though the CSS specification isn't clear about it, inherit can only be used alone: it will never manifest as part of a multi shorthand declaration. Thus, this class does not allow inherit.

Definition at line 14 of file Multiple.php.

Constructor & Destructor Documentation

◆ __construct()

HTMLPurifier_AttrDef_CSS_Multiple::__construct	(	$single,
		$max = `4`
	)

Parameters

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

Definition at line 33 of file Multiple.php.

References $max, and $single.

     {
         $this->single = $single;
         $this->max = $max;
     }

Member Function Documentation

◆ validate()

HTMLPurifier_AttrDef_CSS_Multiple::validate	(	$string,
		$config,
		$context
	)

Parameters

string	$string
HTMLPurifier_Config	$config
HTMLPurifier_Context	$context

Returns: bool|string

Definition at line 45 of file Multiple.php.

References $config, $context, $i, $max, $result, HTMLPurifier_AttrDef\mungeRgb(), and HTMLPurifier_AttrDef\parseCDATA().

     {
         $string = $this->mungeRgb($this->parseCDATA($string));
         if ($string === '') {
             return false;
         }
         $parts = explode(' ', $string); // parseCDATA replaced \r, \t and \n
         $length = count($parts);
         $final = '';
         for ($i = 0, $num = 0; $i < $length && $num < $this->max; $i++) {
             if (ctype_space($parts[$i])) {
                 continue;
             }
             $result = $this->single->validate($parts[$i], $config, $context);
             if ($result !== false) {
                 $final .= $result . ' ';
                 $num++;
             }
         }
         if ($final === '') {
             return false;
         }
         return rtrim($final);
     }

Here is the call graph for this function:

Field Documentation

◆ $max

HTMLPurifier_AttrDef_CSS_Multiple::$max

Max number of values allowed.

Todo:: Make protected

Definition at line 27 of file Multiple.php.

Referenced by __construct(), and validate().

◆ $single

HTMLPurifier_AttrDef_CSS_Multiple::$single

Instance of component definition to defer validation to.

HTMLPurifier_AttrDef

Todo:: Make protected

Definition at line 21 of file Multiple.php.

Referenced by __construct().

The documentation for this class was generated from the following file:

libs/composer/vendor/ezyang/htmlpurifier/library/HTMLPurifier/AttrDef/CSS/Multiple.php

Public Member Functions

Data Fields

Additional Inherited Members