ilHtmlPurifierComposite Class Reference

Composite for nesting multiple purifiers. More...

Inheritance diagram for ilHtmlPurifierComposite:

Collaboration diagram for ilHtmlPurifierComposite:

Public Member Functions
	addPurifier (ilHtmlPurifierInterface $purifier)
	Adds a node to composite. More...
	removePurifier (ilHtmlPurifierInterface $purifier)
	Removes a node from composite. More...
	purify (string $html)
	Filters an HTML snippet/document to be XSS-free and standards-compliant. More...
	purifyArray (array $htmlCollection)
	Filters an array of HTML snippets/documents to be XSS-free and standards-compliant. More...
	purify (string $html)
	Filters an HTML snippet/document to be XSS-free and standards-compliant. More...
	purifyArray (array $htmlCollection)
	Filters an array of HTML snippets/documents to be XSS-free and standards-compliant. More...

Protected Attributes
array	$purifiers = []

Detailed Description

Composite for nesting multiple purifiers.

Author

Michael Jansen mjans.nosp@m.en@d.nosp@m.ataba.nosp@m.y.de

Definition at line 25 of file class.ilHtmlPurifierComposite.php.

Member Function Documentation

addPurifier()

ilHtmlPurifierComposite::addPurifier

(

ilHtmlPurifierInterface

$purifier

)

Adds a node to composite.

Parameters

ilHtmlPurifierInterface

$purifier

Instance of ilHtmlPurifierInterface

Returns

bool True if instance could be added, otherwise false

Definition at line 35 of file class.ilHtmlPurifierComposite.php.

                                                                  : bool
    {
        if (false === in_array($purifier, $this->purifiers, true)) {
            $this->purifiers[] = $purifier;
            return true;
        }
 
        return false;
    }

purify()

ilHtmlPurifierComposite::purify

(

string

$html

)

Filters an HTML snippet/document to be XSS-free and standards-compliant.

Parameters

string

$html

Returns

string

Implements ilHtmlPurifierInterface.

Definition at line 61 of file class.ilHtmlPurifierComposite.php.

                                        : string
    {
        foreach ($this->purifiers as $purifier) {
            $html = $purifier->purify($html);
        }
 
        return $html;
    }

purifyArray()

ilHtmlPurifierComposite::purifyArray

(

array

$htmlCollection

)

Filters an array of HTML snippets/documents to be XSS-free and standards-compliant.

Parameters

string[]

$htmlCollection

Returns

string[]

Exceptions

InvalidArgumentException

If one of the arrays element is not of tpye string

Implements ilHtmlPurifierInterface.

Definition at line 70 of file class.ilHtmlPurifierComposite.php.

                                                      : array
    {
        foreach ($htmlCollection as $key => $html) {
            if (!is_string($html)) {
                throw new InvalidArgumentException(sprintf(
                    'The element on index %s is not of type string: %s',
                    $key,
                    print_r($html, true)
                ));
            }
        }
 
        foreach ($htmlCollection as $key => $html) {
            foreach ($this->purifiers as $purifier) {
                $html = $purifier->purify($html);
            }
 
            $htmlCollection[$key] = $html;
        }
 
        return $htmlCollection;
    }

References ILIAS\LTI\ToolProvider\$key.

removePurifier()

ilHtmlPurifierComposite::removePurifier

(

ilHtmlPurifierInterface

$purifier

)

Removes a node from composite.

Parameters

ilHtmlPurifierInterface

$purifier

Instance of ilHtmlPurifierInterface

Returns

bool True if instance could be removed, otherwise false

Definition at line 50 of file class.ilHtmlPurifierComposite.php.

                                                                     : bool
    {
        $key = array_search($purifier, $this->purifiers, true);
        if (false === $key) {
            return false;
        }
        unset($this->purifiers[$key]);
 
        return true;
    }

References ILIAS\LTI\ToolProvider\$key.

Field Documentation

$purifiers

array ilHtmlPurifierComposite::$purifiers = []

protected

Definition at line 28 of file class.ilHtmlPurifierComposite.php.

---

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

• Services/Html/classes/class.ilHtmlPurifierComposite.php