Class HTMLPurifier

Facade that coordinates HTML Purifier's subsystems in order to purify HTML.

Located at xoops_lib\modules\protector\library\HTMLPurifier.php

Methods


					
	public

__construct(HTMLPurifier_Config|mixed $config = null)

Initializes the purifier.

Parameters

$config

Optional HTMLPurifier_Config object for all instances of the purifier, if omitted, a default configuration is supplied (which can be overridden on a per-use basis). The parameter can also be any type that HTMLPurifier_Config::create() supports.


					
	public

addFilter(HTMLPurifier_Filter $filter)

Adds a filter to process the output. First come first serve

Parameters

$filter

HTMLPurifier_Filter object


					
	public

purify(string $html, HTMLPurifier_Config $config = null): string

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

Parameters

`$html`	String of HTML to purify
`$config`	Config object for this operation, if omitted, defaults to the config object specified during this object's construction. The parameter can also be any type that HTMLPurifier_Config::create() supports.

Returns

Purified HTML


					
	public

purifyArray(string[] $array_of_html, HTMLPurifier_Config $config = null): string[]

Filters an array of HTML snippets

Parameters

`$array_of_html`	Array of html snippets
`$config`	Optional config object for this operation. See HTMLPurifier::purify() for more details.

Returns

Array of purified HTML


					
	public
					static

instance(HTMLPurifier|HTMLPurifier_Config $prototype = null): HTMLPurifier

Singleton for enforcing just one HTML Purifier in your system

Parameters

$prototype

Optional prototype HTMLPurifier instance to overload singleton with, or HTMLPurifier_Config instance to configure the generated version with.


					
	public
					static

getInstance(HTMLPurifier|HTMLPurifier_Config $prototype = null): HTMLPurifier

Singleton for enforcing just one HTML Purifier in your system

Parameters

$prototype

Optional prototype HTMLPurifier instance to overload singleton with, or HTMLPurifier_Config instance to configure the generated version with.

Constants
`public`	`VERSION = '4.15.0'` Constant with version of HTML Purifier. Constant with version of HTML Purifier.	#

Properties
`public`	`$version = '4.15.0'` Version of HTML Purifier. Version of HTML Purifier.	#
`public`	`$config` Global configuration object. Global configuration object.	#
`protected`	`$strategy`	#
`protected`	`$generator`	#
`public`	`$context` Resultant context of last run purification. Is an array of contexts if the last called method was purifyArray(). Resultant context of last run purification. Is an array of contexts if the last called method was purifyArray().	#

Namespaces

Classes

Interfaces

Exceptions

Functions

Class HTMLPurifier

Parameters

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Parameters