HTMLPurifier_AttrDef_CSS_Length Class Reference

Represents a Length as defined by CSS. More...

Inheritance diagram for HTMLPurifier_AttrDef_CSS_Length:

Collaboration diagram for HTMLPurifier_AttrDef_CSS_Length:

Public Member Functions
	__construct ($min=null, $max=null)
	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
	$min
	HTMLPurifier_Length|string More...
	$max
	HTMLPurifier_Length|string 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

Represents a Length as defined by CSS.

Definition at line 6 of file Length.php.

Constructor & Destructor Documentation

__construct()

HTMLPurifier_AttrDef_CSS_Length::__construct	(		$min = null,
			$max = null
	)

Parameters

HTMLPurifier_Length | string	$min	Minimum length, or null for no bound. String is also acceptable.
HTMLPurifier_Length | string	$max	Maximum length, or null for no bound. String is also acceptable.

Definition at line 23 of file Length.php.

References $max, $min, and HTMLPurifier_Length\make().

    {
        $this->min = $min !== null ? HTMLPurifier_Length::make($min) : null;
        $this->max = $max !== null ? HTMLPurifier_Length::make($max) : null;
    }

Here is the call graph for this function:

Member Function Documentation

validate()

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

Parameters

string	$string
HTMLPurifier_Config	$config
HTMLPurifier_Context	$context

Returns

bool|string

Definition at line 35 of file Length.php.

References HTMLPurifier_Length\make(), and HTMLPurifier_AttrDef\parseCDATA().

    {
        $string = $this->parseCDATA($string);

        // Optimizations
        if ($string === '') {
            return false;
        }
        if ($string === '0') {
            return '0';
        }
        if (strlen($string) === 1) {
            return false;
        }

        $length = HTMLPurifier_Length::make($string);
        if (!$length->isValid()) {
            return false;
        }

        if ($this->min) {
            $c = $length->compareTo($this->min);
            if ($c === false) {
                return false;
            }
            if ($c < 0) {
                return false;
            }
        }
        if ($this->max) {
            $c = $length->compareTo($this->max);
            if ($c === false) {
                return false;
            }
            if ($c > 0) {
                return false;
            }
        }
        return $length->toString();
    }

Here is the call graph for this function:

Field Documentation

$max

HTMLPurifier_AttrDef_CSS_Length::$max

protected

HTMLPurifier_Length|string

Definition at line 17 of file Length.php.

Referenced by __construct().

$min

HTMLPurifier_AttrDef_CSS_Length::$min

protected

HTMLPurifier_Length|string

Definition at line 12 of file Length.php.

Referenced by __construct().

---

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

• Services/Html/HtmlPurifier/library/HTMLPurifier/AttrDef/CSS/Length.php