ilHtmlPurifierAbstractLibWrapper Class Reference

Abstract class wrapping the HTMLPurifier instance. More...

Inheritance diagram for ilHtmlPurifierAbstractLibWrapper:

Collaboration diagram for ilHtmlPurifierAbstractLibWrapper:

Public Member Functions
	__construct ()
	Constructor. More...
	purify ($a_html, $a_config=null)
	Filters an HTML snippet/document to be XSS-free and standards-compliant. More...
	purifyArray (array $a_array_of_html, $a_config=null)
	Filters an array of HTML snippets/documents to be XSS-free and standards-compliant. More...
Public Member Functions inherited from ilHtmlPurifierInterface
	purify ($a_html)
	Filters an HTML snippet/document to be XSS-free and standards-compliant. More...
	purifyArray (array $a_array_of_html)
	Filters an array of HTML snippets/documents to be XSS-free and standards-compliant. More...

Static Public Member Functions
static	_getCacheDirectory ()
	Get the directory for HTMLPurifier cache files. More...

Protected Member Functions
	getPurifierConfigInstance ()
	Has to be implemented by subclasses to build the HTMLPurifier_Config instance with object specific configurations. More...
	setPurifier (HTMLPurifier $oPurifier)
	Set the purifier by subclass. More...
	getPurifier ()
	Get the purifier. More...
	removeUnsupportedElements ($a_array)
	Removes all unsupported elements. More...
	makeElementListTinyMceCompliant ($elements)

Protected Attributes
	$oPurifier = null

Detailed Description

Abstract class wrapping the HTMLPurifier instance.

Author

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

Version

$Id$ @abstract

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

Constructor & Destructor Documentation

__construct()

ilHtmlPurifierAbstractLibWrapper::__construct

(

)

Constructor.

@access public

Reimplemented in ilHtmlForumPostPurifier.

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

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

References getPurifierConfigInstance(), HTMLPurifier(), and setPurifier().

Here is the call graph for this function:

Member Function Documentation

_getCacheDirectory()

static ilHtmlPurifierAbstractLibWrapper::_getCacheDirectory ( )

staticfinal

Get the directory for HTMLPurifier cache files.

Returns

string Cache directory for HTMLPurifier @access public @final @statc

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

    {
        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 ilTermsOfServiceDocumentHtmlPurifier\__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

Get the purifier.

Returns

HTMLPurifier instance of HTMLPurifier @access protected

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

    {
        return $this->oPurifier;
    }

References $oPurifier.

getPurifierConfigInstance()

ilHtmlPurifierAbstractLibWrapper::getPurifierConfigInstance ( )

abstractprotected

Has to be implemented by subclasses to build the HTMLPurifier_Config instance with object specific configurations.

@abstract @access protected

Reimplemented in ilAssHtmlPurifier, ilHtmlForumPostPurifier, and ilTermsOfServiceDocumentHtmlPurifier.

Referenced by __construct().

Here is the caller graph for this function:

makeElementListTinyMceCompliant()

ilHtmlPurifierAbstractLibWrapper::makeElementListTinyMceCompliant (   $elements )

protected

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

    {
        // 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(), ilHtmlForumPostPurifier\getPurifierConfigInstance(), and ilTermsOfServiceDocumentHtmlPurifier\getPurifierConfigInstance().

Here is the caller graph for this function:

purify()

ilHtmlPurifierAbstractLibWrapper::purify (   $a_html,   $a_config = null  )

final

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

@access public

Parameters

string

$a_html

HTML snippet/document

Returns

string purified html @final

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

    {
        return $this->oPurifier->purify($a_html, $a_config);
    }

purifyArray()

ilHtmlPurifierAbstractLibWrapper::purifyArray ( array  $a_array_of_html,   $a_config = null  )

final

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

@access public

Parameters

array

$a_array_of_html

HTML snippet/document

Returns

array Array of HTML snippets/documents @final

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

    {
        return $this->oPurifier->purifyArray($a_array_of_html, $a_config);
    }

removeUnsupportedElements()

ilHtmlPurifierAbstractLibWrapper::removeUnsupportedElements (   $a_array )

finalprotected

Removes all unsupported elements.

Parameters

Array

$a_array

array of all elements

Returns

Array array of supported elements @access protected @final

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

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

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

Here is the caller graph for this function:

setPurifier()

ilHtmlPurifierAbstractLibWrapper::setPurifier ( HTMLPurifier  $oPurifier )

protected

Set the purifier by subclass.

Parameters

HTMLPurifier

$oPurifier

Instance of HTMLPurifier

Returns

ilHtmlPurifier This reference @access protected

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

    {
        $this->oPurifier = $oPurifier;
        return $this;
    }

References $oPurifier.

Referenced by __construct().

Here is the caller graph for this function:

Field Documentation

$oPurifier

ilHtmlPurifierAbstractLibWrapper::$oPurifier = null

protected

Definition at line 26 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