ilHtmlPurifierAbstractLibWrapper Class Reference

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)
	@inheritDoc More...
	purifyArray (array $htmlCollection)
	@inheritDoc 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
	$purifier

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

Constructor & Destructor Documentation

__construct()

ilHtmlPurifierAbstractLibWrapper::__construct

(

)

ilHtmlPurifierAbstractLibWrapper constructor.

Reimplemented in ilHtmlForumPostPurifier.

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

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

References getPurifierConfigInstance(), and setPurifier().

Here is the call graph for this function:

Member Function Documentation

_getCacheDirectory()

static ilHtmlPurifierAbstractLibWrapper::_getCacheDirectory ( )

staticfinal

Returns

string

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

                                                      : string
    {
        if (!file_exists(ilUtil::getDataDir() . '/HTMLPurifier') ||
            !is_dir(ilUtil::getDataDir() . '/HTMLPurifier')) {
            ilUtil::makeDirParents(ilUtil::getDataDir() . '/HTMLPurifier');
        }
 
        return ilUtil::getDataDir() . '/HTMLPurifier';
    }

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

Referenced by ilAccessibilityDocumentHtmlPurifier\__construct(), ilTermsOfServiceDocumentHtmlPurifier\__construct(), ilWebDAVMountInstructionsDocumentPurifier\__construct(), ilAssHtmlPurifier\getPurifierConfigInstance(), and ilHtmlForumPostPurifier\getPurifierConfigInstance().

Here is the call graph for this function:

Here is the caller graph for this function:

getPurifier()

ilHtmlPurifierAbstractLibWrapper::getPurifier ( )

protected

Returns

HTMLPurifier

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

                                     : HTMLPurifier
    {
        return $this->purifier;
    }

References $purifier.

getPurifierConfigInstance()

ilHtmlPurifierAbstractLibWrapper::getPurifierConfigInstance ( )

abstractprotected

Returns

HTMLPurifier_Config

Reimplemented in ilAssHtmlPurifier, ilAccessibilityDocumentHtmlPurifier, ilHtmlForumPostPurifier, ilTermsOfServiceDocumentHtmlPurifier, and ilWebDAVMountInstructionsDocumentPurifier.

Referenced by __construct().

Here is the caller graph for this function:

makeElementListTinyMceCompliant()

ilHtmlPurifierAbstractLibWrapper::makeElementListTinyMceCompliant ( array  $elements )

protected

Parameters

string[]

$elements

Returns

string[]

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

                                                                        : 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;
    }

Referenced by ilAssHtmlPurifier\getAllowedElements(), ilAccessibilityDocumentHtmlPurifier\getPurifierConfigInstance(), ilHtmlForumPostPurifier\getPurifierConfigInstance(), ilTermsOfServiceDocumentHtmlPurifier\getPurifierConfigInstance(), and ilWebDAVMountInstructionsDocumentPurifier\getPurifierConfigInstance().

Here is the caller graph for this function:

purify()

ilHtmlPurifierAbstractLibWrapper::purify ( string  $html )

final

@inheritDoc

Implements ilHtmlPurifierInterface.

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

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

purifyArray()

ilHtmlPurifierAbstractLibWrapper::purifyArray ( array  $htmlCollection )

final

@inheritDoc

Implements ilHtmlPurifierInterface.

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

                                                             : array
    {
        return $this->purifier->purifyArray($htmlCollection);
    }

removeUnsupportedElements()

ilHtmlPurifierAbstractLibWrapper::removeUnsupportedElements ( array  $elements )

finalprotected

Removes all unsupported elements.

Parameters

string[]

$elements

Returns

string[]

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

                                                                        : array
    {
        $supportedElements = array();
 
        $notSupportedTags = array(
            'rp',
            'rt',
            'rb',
            'rtc',
            'rbc',
            'ruby',
            'u',
            'strike',
            'param',
            'object'
        );
 
        foreach ($elements as $element) {
            if (!in_array($element, $notSupportedTags)) {
                $supportedElements[] = $element;
            }
        }
 
        return $supportedElements;
    }

Referenced by ilAssHtmlPurifier\getAllowedElements(), ilAccessibilityDocumentHtmlPurifier\getPurifierConfigInstance(), ilHtmlForumPostPurifier\getPurifierConfigInstance(), ilTermsOfServiceDocumentHtmlPurifier\getPurifierConfigInstance(), and ilWebDAVMountInstructionsDocumentPurifier\getPurifierConfigInstance().

Here is the caller graph for this function:

setPurifier()

ilHtmlPurifierAbstractLibWrapper::setPurifier ( HTMLPurifier  $purifier )

protected

Parameters

HTMLPurifier

$purifier

Returns

ilHtmlPurifierAbstractLibWrapper

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

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

References $purifier.

Referenced by __construct().

Here is the caller graph for this function:

Field Documentation

$purifier

ilHtmlPurifierAbstractLibWrapper::$purifier

protected

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

Referenced by getPurifier(), and setPurifier().

---

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

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