Abstract class wrapping the HTMLPurifier instance. More...

Inheritance diagram for ilHtmlPurifierAbstractLibWrapper:

Collaboration diagram for ilHtmlPurifierAbstractLibWrapper:

Public Member Functions
	__construct ()
	ilHtmlPurifierAbstractLibWrapper constructor. 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...

Static Public Member Functions
static	_getCacheDirectory ()

Protected Member Functions
	getPurifierConfigInstance ()

	setPurifier (HTMLPurifier $purifier)

	getPurifier ()

	removeUnsupportedElements (array $elements)
	Removes all unsupported elements. More...

	makeElementListTinyMceCompliant (array $elements)

Protected Attributes
HTMLPurifier	$purifier

Private Attributes
const	HTML_PURIFIER_DIRECTORY = '/HTMLPurifier'

const	NOT_SUPPORTED_TAGS

Detailed Description

Abstract class wrapping the HTMLPurifier instance.

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

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

Constructor & Destructor Documentation

◆ __construct()

ilHtmlPurifierAbstractLibWrapper::__construct ( )

ilHtmlPurifierAbstractLibWrapper constructor.

Definition at line 46 of file class.ilHtmlPurifierAbstractLibWrapper.php.

References getPurifierConfigInstance(), and setPurifier().

     {
         $this->setPurifier(
             new HTMLPurifier($this->getPurifierConfigInstance())
         );
     }

Here is the call graph for this function:

Member Function Documentation

◆ _getCacheDirectory()

static ilHtmlPurifierAbstractLibWrapper::_getCacheDirectory ( )

staticfinal

Definition at line 86 of file class.ilHtmlPurifierAbstractLibWrapper.php.

References ilFileUtils\getDataDir(), and ilFileUtils\makeDirParents().

Referenced by ilWebDAVMountInstructionsDocumentPurifier\__construct(), ilAccessibilityDocumentHtmlPurifier\__construct(), ILIAS\LegalDocuments\HTMLPurifier\__construct(), ilHtmlForumPostPurifier\getPurifierConfigInstance(), ilExcInstructionPurifier\getPurifierConfigInstance(), ilSvyStandardPurifier\getPurifierConfigInstance(), and ilAssHtmlPurifier\getPurifierConfigInstance().

                                                      : string
     {
         if (!is_dir(ilFileUtils::getDataDir() . self::HTML_PURIFIER_DIRECTORY)) {
             ilFileUtils::makeDirParents(ilFileUtils::getDataDir() . self::HTML_PURIFIER_DIRECTORY);
         }
 
         return ilFileUtils::getDataDir() . self::HTML_PURIFIER_DIRECTORY;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPurifier()

ilHtmlPurifierAbstractLibWrapper::getPurifier ( )

finalprotected

Definition at line 81 of file class.ilHtmlPurifierAbstractLibWrapper.php.

References $purifier.

                                           : HTMLPurifier
     {
         return $this->purifier;
     }

◆ getPurifierConfigInstance()

ilHtmlPurifierAbstractLibWrapper::getPurifierConfigInstance ( )

abstractprotected

Referenced by __construct(), and purifyArray().

Here is the caller graph for this function:

◆ makeElementListTinyMceCompliant()

ilHtmlPurifierAbstractLibWrapper::makeElementListTinyMceCompliant ( array $elements )

finalprotected

Parameters

string[] $elements

Returns: string[]

Definition at line 117 of file class.ilHtmlPurifierAbstractLibWrapper.php.

Referenced by ilAssHtmlPurifier\getAllowedElements(), ilHtmlForumPostPurifier\getPurifierConfigInstance(), ilExcInstructionPurifier\getPurifierConfigInstance(), ilSvyStandardPurifier\getPurifierConfigInstance(), ilWebDAVMountInstructionsDocumentPurifier\getPurifierConfigInstance(), ilAccessibilityDocumentHtmlPurifier\getPurifierConfigInstance(), and ILIAS\LegalDocuments\HTMLPurifier\getPurifierConfigInstance().

                                                                              : array
     {
         // Bugfix #5945: Necessary because TinyMCE does not use the "u"
         // html element but <span style="text-decoration: underline">E</span>
 
         if (in_array('u', $elements) && !in_array('span', $elements)) {
             $elements[] = 'span';
         }
 
         return $elements;
     }

Here is the caller graph for this function:

◆ purify()

ilHtmlPurifierAbstractLibWrapper::purify ( string $html )

final

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

Implements ilHtmlPurifierInterface.

Definition at line 53 of file class.ilHtmlPurifierAbstractLibWrapper.php.

                                               : string
     {
         return $this->purifier->purify($html);
     }

◆ purifyArray()

ilHtmlPurifierAbstractLibWrapper::purifyArray ( array $htmlCollection )

final

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 58 of file class.ilHtmlPurifierAbstractLibWrapper.php.

References ILIAS\LTI\ToolProvider\$key, and getPurifierConfigInstance().

                                                             : 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)
                 ));
             }
         }
 
         return $this->purifier->purifyArray($htmlCollection);
     }

Here is the call graph for this function:

◆ removeUnsupportedElements()

ilHtmlPurifierAbstractLibWrapper::removeUnsupportedElements ( array $elements )

finalprotected

Removes all unsupported elements.

Parameters

string[] $elements

Returns: string[]

Definition at line 100 of file class.ilHtmlPurifierAbstractLibWrapper.php.

Referenced by ilAssHtmlPurifier\getAllowedElements(), ilHtmlForumPostPurifier\getPurifierConfigInstance(), ilExcInstructionPurifier\getPurifierConfigInstance(), ilSvyStandardPurifier\getPurifierConfigInstance(), ilWebDAVMountInstructionsDocumentPurifier\getPurifierConfigInstance(), ilAccessibilityDocumentHtmlPurifier\getPurifierConfigInstance(), and ILIAS\LegalDocuments\HTMLPurifier\getPurifierConfigInstance().

                                                                        : array
     {
         $supportedElements = [];
 
         foreach ($elements as $element) {
             if (!in_array($element, self::NOT_SUPPORTED_TAGS)) {
                 $supportedElements[] = $element;
             }
         }
 
         return $supportedElements;
     }

Here is the caller graph for this function:

◆ setPurifier()

ilHtmlPurifierAbstractLibWrapper::setPurifier ( HTMLPurifier $purifier )

finalprotected

Definition at line 75 of file class.ilHtmlPurifierAbstractLibWrapper.php.

References $purifier.

Referenced by __construct().

                                                                 : self
     {
         $this->purifier = $purifier;
         return $this;
     }

Here is the caller graph for this function:

Field Documentation

◆ $purifier

HTMLPurifier ilHtmlPurifierAbstractLibWrapper::$purifier

protected

Definition at line 41 of file class.ilHtmlPurifierAbstractLibWrapper.php.

Referenced by getPurifier(), and setPurifier().

◆ HTML_PURIFIER_DIRECTORY

const ilHtmlPurifierAbstractLibWrapper::HTML_PURIFIER_DIRECTORY = '/HTMLPurifier'

private

Definition at line 27 of file class.ilHtmlPurifierAbstractLibWrapper.php.

◆ NOT_SUPPORTED_TAGS

const ilHtmlPurifierAbstractLibWrapper::NOT_SUPPORTED_TAGS

private

Initial value:

= [
        'rp',
        'rt',
        'rb',
        'rtc',
        'rbc',
        'ruby',
        'u',
        'strike',
        'param',
        'object'
    ]

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

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

Services/Html/classes/class.ilHtmlPurifierAbstractLibWrapper.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _getCacheDirectory()

◆ getPurifier()

◆ getPurifierConfigInstance()

◆ makeElementListTinyMceCompliant()

◆ purify()

◆ purifyArray()

◆ removeUnsupportedElements()

◆ setPurifier()

Field Documentation

◆ $purifier

◆ HTML_PURIFIER_DIRECTORY

◆ NOT_SUPPORTED_TAGS