Validates shorthand CSS property background. More...

Inheritance diagram for HTMLPurifier_AttrDef_CSS_Background:

Collaboration diagram for HTMLPurifier_AttrDef_CSS_Background:

Public Member Functions
	__construct ($config)

	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...

Protected Attributes
	$info
	Local copy of component validators. More...

Additional Inherited Members
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...

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

Validates shorthand CSS property background.

Warning: Does not support url tokens that have internal spaces.

Definition at line 7 of file Background.php.

Constructor & Destructor Documentation

◆ __construct()

HTMLPurifier_AttrDef_CSS_Background::__construct ( $config )

Parameters

HTMLPurifier_Config $config

Definition at line 20 of file Background.php.

    {
        $def = $config->getCSSDefinition();
        $this->info['background-color'] = $def->info['background-color'];
        $this->info['background-image'] = $def->info['background-image'];
        $this->info['background-repeat'] = $def->info['background-repeat'];
        $this->info['background-attachment'] = $def->info['background-attachment'];
        $this->info['background-position'] = $def->info['background-position'];
    }

References $config, and $def.

Member Function Documentation

◆ validate()

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

Parameters

string	$string
HTMLPurifier_Config	$config
HTMLPurifier_Context	$context

Returns: bool|string

Reimplemented from HTMLPurifier_AttrDef.

Definition at line 36 of file Background.php.

    {
        // regular pre-processing
        $string = $this->parseCDATA($string);
        if ($string === '') {
            return false;
        }
 
        // munge rgb() decl if necessary
        $string = $this->mungeRgb($string);
 
        // assumes URI doesn't have spaces in it
        $bits = explode(' ', $string); // bits to process
 
        $caught = array();
        $caught['color'] = false;
        $caught['image'] = false;
        $caught['repeat'] = false;
        $caught['attachment'] = false;
        $caught['position'] = false;
 
        $i = 0; // number of catches
 
        foreach ($bits as $bit) {
            if ($bit === '') {
                continue;
            }
            foreach ($caught as $key => $status) {
                if ($key != 'position') {
                    if ($status !== false) {
                        continue;
                    }
                    $r = $this->info['background-' . $key]->validate($bit, $config, $context);
                } else {
                    $r = $bit;
                }
                if ($r === false) {
                    continue;
                }
                if ($key == 'position') {
                    if ($caught[$key] === false) {
                        $caught[$key] = '';
                    }
                    $caught[$key] .= $r . ' ';
                } else {
                    $caught[$key] = $r;
                }
                $i++;
                break;
            }
        }
 
        if (!$i) {
            return false;
        }
        if ($caught['position'] !== false) {
            $caught['position'] = $this->info['background-position']->
                validate($caught['position'], $config, $context);
        }
 
        $ret = array();
        foreach ($caught as $value) {
            if ($value === false) {
                continue;
            }
            $ret[] = $value;
        }
 
        if (empty($ret)) {
            return false;
        }
        return implode(' ', $ret);
    }