ilAccessibilityDocumentHtmlPurifier Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilAccessibilityDocumentHtmlPurifier:

Collaboration diagram for ilAccessibilityDocumentHtmlPurifier:

Public Member Functions
	__construct (?array $allowedTags=null, ?string $cacheDirectory=null)
Public Member Functions inherited from ilHtmlPurifierAbstractLibWrapper
	__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...

Protected Member Functions
	getPurifierConfigInstance ()
Protected Member Functions inherited from ilHtmlPurifierAbstractLibWrapper
	getPurifierConfigInstance ()
	setPurifier (HTMLPurifier $purifier)
	getPurifier ()
	removeUnsupportedElements (array $elements)
	Removes all unsupported elements. More...
	makeElementListTinyMceCompliant (array $elements)

Protected Attributes
string	$cacheDirectory = ''
Protected Attributes inherited from ilHtmlPurifierAbstractLibWrapper
HTMLPurifier	$purifier

Private Attributes
array	$allowedTags = []

Additional Inherited Members
Static Public Member Functions inherited from ilHtmlPurifierAbstractLibWrapper
static	_getCacheDirectory ()

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Class ilAccessibilityDocumentHtmlPurifier

Definition at line 22 of file class.ilAccessibilityDocumentHtmlPurifier.php.

Constructor & Destructor Documentation

__construct()

ilAccessibilityDocumentHtmlPurifier::__construct	(	?array	$allowedTags = null,
		?string	$cacheDirectory = null
	)

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

References $allowedTags, $cacheDirectory, ILIAS\GlobalScreen\Provider\__construct(), ilHtmlPurifierAbstractLibWrapper\_getCacheDirectory(), ilObjAdvancedEditing\_getUsedHTMLTags(), and null.

    {
        if (null === $cacheDirectory) {
            $cacheDirectory = ilHtmlPurifierAbstractLibWrapper::_getCacheDirectory();
        }
        $this->cacheDirectory = $cacheDirectory;

        if (null === $allowedTags) {
            $allowedTags = ilObjAdvancedEditing::_getUsedHTMLTags('textarea');
        }
        $this->allowedTags = $allowedTags;

        parent::__construct();
        $this->allowedTags = $allowedTags;
    }

Here is the call graph for this function:

Member Function Documentation

getPurifierConfigInstance()

ilAccessibilityDocumentHtmlPurifier::getPurifierConfigInstance ( )

protected

Definition at line 43 of file class.ilAccessibilityDocumentHtmlPurifier.php.

References $allowedTags, ilHtmlPurifierAbstractLibWrapper\makeElementListTinyMceCompliant(), and ilHtmlPurifierAbstractLibWrapper\removeUnsupportedElements().

                                                  : HTMLPurifier_Config
    {
        $config = HTMLPurifier_Config::createDefault();
        $config->set('HTML.DefinitionID', 'ilias accessibility document');
        $config->set('HTML.DefinitionRev', 1);
        $config->set('HTML.TargetBlank', true);
        $config->set('Cache.SerializerPath', $this->cacheDirectory);
        $config->set('HTML.Doctype', 'XHTML 1.0 Strict');

        $tags = $this->allowedTags;
        $tags = $this->makeElementListTinyMceCompliant($tags);

        $tags[] = 'b';
        $tags[] = 'i';

        $config->set('HTML.AllowedElements', $this->removeUnsupportedElements($tags));
        $config->set('HTML.ForbiddenAttributes', 'div@style');

        if ($def = $config->maybeGetRawHTMLDefinition()) {
            $def->addAttribute('a', 'target', 'Enum#_blank,_self,_target,_top');
        }

        return $config;
    }

Here is the call graph for this function:

Field Documentation

$allowedTags

array ilAccessibilityDocumentHtmlPurifier::$allowedTags = []

private

Definition at line 24 of file class.ilAccessibilityDocumentHtmlPurifier.php.

Referenced by __construct(), and getPurifierConfigInstance().

$cacheDirectory

string ilAccessibilityDocumentHtmlPurifier::$cacheDirectory = ''

protected

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

Referenced by __construct().

---

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

• components/ILIAS/Accessibility/classes/Document/class.ilAccessibilityDocumentHtmlPurifier.php