HTMLPurifier Class Reference

Public Member Functions
	__construct ($config=null)
	addFilter ($filter)
	purify ($html, $config=null)
	purifyArray ($array_of_html, $config=null)
Static Public Member Functions
static	instance ($prototype=null)
static	getInstance ($prototype=null)
Data Fields
	$version = '4.3.0'
const	VERSION = '4.3.0'
	$config
	$generator
	$context
Protected Attributes
	$strategy

---

Detailed Description

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

Note:

There are several points in which configuration can be specified for HTML Purifier. The precedence of these (from lowest to highest) is as follows:

1. Instance: new HTMLPurifier($config)
2. Invocation: purify($html, $config) These configurations are entirely independent of each other and are *not* merged (this behavior may change in the future).

Todo:

We need an easier way to inject strategies using the configuration object.

Definition at line 54 of file HTMLPurifier.php.

---

Constructor & Destructor Documentation

__construct

(

$

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.

Definition at line 88 of file HTMLPurifier.php.

Here is the call graph for this function:

---

Member Function Documentation

addFilter

(

$

filter

)

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

Parameters:

$filter

HTMLPurifier_Filter object

Definition at line 100 of file HTMLPurifier.php.

static getInstance

(

$

prototype = null

)

[static]

Note:

Backwards compatibility, see instance()

Definition at line 231 of file HTMLPurifier.php.

Here is the call graph for this function:

Here is the caller graph for this function:

static instance

(

$

prototype = null

)

[static]

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.

Definition at line 215 of file HTMLPurifier.php.

Here is the caller graph for this function:

purify	(	$	html,
		$	config = null
	)

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

Parameters:

$html	String of HTML to purify
$config	HTMLPurifier_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

Definition at line 115 of file HTMLPurifier.php.

Here is the call graph for this function:

Here is the caller graph for this function:

purifyArray	(	$	array_of_html,
		$	config = null
	)

Filters an array of HTML snippets

Parameters:

$config

Optional HTMLPurifier_Config object for this operation. See HTMLPurifier::purify() for more details.

Returns:

Array of purified HTML

Definition at line 199 of file HTMLPurifier.php.

Here is the call graph for this function:

---

Field Documentation

$config

Global configuration object

Definition at line 64 of file HTMLPurifier.php.

$context

Resultant HTMLPurifier_Context of last run purification. Is an array of contexts if the last called method was purifyArray().

Definition at line 78 of file HTMLPurifier.php.

$generator

Definition at line 72 of file HTMLPurifier.php.

$strategy [protected]

Definition at line 72 of file HTMLPurifier.php.

$version = '4.3.0'

Version of HTML Purifier

Definition at line 58 of file HTMLPurifier.php.

const VERSION = '4.3.0'

Constant with version of HTML Purifier

Definition at line 61 of file HTMLPurifier.php.

---

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

• C:/xampp/htdocs/moodle/lib/htmlpurifier/HTMLPurifier.php