HTMLPurifier_AttrDef_CSS_Composite Class Reference

Allows multiple validators to attempt to validate attribute. More...

Inheritance diagram for HTMLPurifier_AttrDef_CSS_Composite:

Collaboration diagram for HTMLPurifier_AttrDef_CSS_Composite:

Public Member Functions
	__construct ($defs)
	validate ($string, $config, $context)
Public Member Functions inherited from HTMLPurifier_AttrDef
	parseCDATA ($string)
	Convenience method that parses a string as if it were CDATA.
	make ($string)
	Factory method for creating this class from a string.

Data Fields
	$defs
	List of objects that may process strings.
Data Fields inherited from HTMLPurifier_AttrDef
	$minimized = false
	Tells us whether or not an HTML attribute is minimized.
	$required = false
	Tells us whether or not an HTML attribute is required.

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.
	expandCSSEscape ($string)
	Parses a possibly escaped CSS string and returns the "pure" version of it.

Detailed Description

Allows multiple validators to attempt to validate attribute.

Composite is just what it sounds like: a composite of many validators. This means that multiple HTMLPurifier_AttrDef objects will have a whack at the string. If one of them passes, that's what is returned. This is especially useful for CSS values, which often are a choice between an enumerated set of predefined values or a flexible data type.

Definition at line 12 of file Composite.php.

Constructor & Destructor Documentation

HTMLPurifier_AttrDef_CSS_Composite::__construct

(

$defs

)

Parameters

HTMLPurifier_AttrDef[]

$defs List of HTMLPurifier_AttrDef objects

Definition at line 25 of file Composite.php.

References $defs.

    {
        $this->defs = $defs;
    }

Member Function Documentation

HTMLPurifier_AttrDef_CSS_Composite::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 Composite.php.

References $result.

    {
        foreach ($this->defs as $i => $def) {
            $result = $this->defs[$i]->validate($string, $config, $context);
            if ($result !== false) {
                return $result;
            }
        }
        return false;
    }

Field Documentation

HTMLPurifier_AttrDef_CSS_Composite::$defs

List of objects that may process strings.

HTMLPurifier_AttrDef[]

Todo:

Make protected

Definition at line 20 of file Composite.php.

Referenced by __construct().

---

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

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