HTMLPurifier Klassenreferenz

Öffentliche Methoden
	__construct ($config=null)
	addFilter ($filter)
	purify ($html, $config=null)
	purifyArray ($array_of_html, $config=null)
Öffentliche, statische Methoden
static	instance ($prototype=null)
static	getInstance ($prototype=null)
Datenfelder
	$version = '4.0.0'
const	VERSION = '4.0.0'
	$config
	$context
Geschützte Attribute
	$strategy
	$generator

---

Ausführliche Beschreibung

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

Zu beachten:

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).

Noch zu erledigen:

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

Definiert in Zeile 54 der Datei HTMLPurifier.php.

---

Beschreibung der Konstruktoren und Destruktoren

__construct

(

$

config = null

)

Initializes the purifier.

Parameter:

$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.

Definiert in Zeile 88 der Datei HTMLPurifier.php.

Hier ist ein Graph der zeigt, was diese Funktion aufruft:

---

Dokumentation der Elementfunktionen

addFilter

(

$

filter

)

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

Parameter:

$filter

HTMLPurifier_Filter object

Definiert in Zeile 100 der Datei HTMLPurifier.php.

static getInstance

(

$

prototype = null

)

[static]

Zu beachten:

Backwards compatibility, see instance()

Definiert in Zeile 231 der Datei HTMLPurifier.php.

Hier ist ein Graph der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

static instance

(

$

prototype = null

)

[static]

Singleton for enforcing just one HTML Purifier in your system

Parameter:

$prototype

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

Definiert in Zeile 215 der Datei HTMLPurifier.php.

Hier ist ein Graph der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

purify	(	$	html,
		$	config = null
	)

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

Parameter:

	$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.

Rückgabe:

Purified HTML

Definiert in Zeile 115 der Datei HTMLPurifier.php.

Hier ist ein Graph der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

purifyArray	(	$	array_of_html,
		$	config = null
	)

Filters an array of HTML snippets

Parameter:

$config

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

Rückgabe:

Array of purified HTML

Definiert in Zeile 199 der Datei HTMLPurifier.php.

Hier ist ein Graph der zeigt, was diese Funktion aufruft:

---

Dokumentation der Datenelemente

$config

Global configuration object

Definiert in Zeile 64 der Datei HTMLPurifier.php.

$context

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

Definiert in Zeile 78 der Datei HTMLPurifier.php.

$generator [protected]

Definiert in Zeile 72 der Datei HTMLPurifier.php.

$strategy [protected]

Definiert in Zeile 72 der Datei HTMLPurifier.php.

$version = '4.0.0'

Version of HTML Purifier

Definiert in Zeile 58 der Datei HTMLPurifier.php.

const VERSION = '4.0.0'

Constant with version of HTML Purifier

Definiert in Zeile 61 der Datei HTMLPurifier.php.

---

Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei:

• HTMLPurifier.php