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.6.0'
 
const VERSION = '4.6.0'
 
 $config
 
 $context
 

Geschützte Attribute

 $strategy
 
 $generator
 

Private Attribute

 $filters = array()
 

Statische, private Attribute

static $instance
 

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
HTMLPurifier_Config$configOptional 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 114 der Datei HTMLPurifier.php.

Benutzt $config und HTMLPurifier_Config\create().

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
HTMLPurifier_Filter$filterHTMLPurifier_Filter object

Definiert in Zeile 125 der Datei HTMLPurifier.php.

static getInstance (   $prototype = null)
static

Singleton for enforcing just one HTML Purifier in your system

Parameter
HTMLPurifier | HTMLPurifier_Config$prototypeOptional prototype HTMLPurifier instance to overload singleton with, or HTMLPurifier_Config instance to configure the generated version with.
Rückgabe
HTMLPurifier
Zu beachten
Backwards compatibility, see instance()

Definiert in Zeile 286 der Datei HTMLPurifier.php.

Benutzt instance().

Wird benutzt von HTMLPurifier_ConfigSchema_Builder_Xml\writeHTMLDiv().

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
HTMLPurifier | HTMLPurifier_Config$prototypeOptional prototype HTMLPurifier instance to overload singleton with, or HTMLPurifier_Config instance to configure the generated version with.
Rückgabe
HTMLPurifier

Definiert in Zeile 261 der Datei HTMLPurifier.php.

Benutzt HTMLPurifier().

Wird benutzt von getInstance().

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
string$htmlString of HTML to purify
HTMLPurifier_Config$configConfig 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
string Purified HTML

Definiert in Zeile 146 der Datei HTMLPurifier.php.

Benutzt $config, $context, $filters, HTMLPurifier_IDAccumulator\build(), HTMLPurifier_Encoder\convertFromUTF8(), HTMLPurifier_Encoder\convertToUTF8(), HTMLPurifier_Lexer\create(), HTMLPurifier_Config\create() und HTMLPurifier_LanguageFactory\instance().

Wird benutzt von purifyArray().

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
string[]$array_of_html Array of html snippets
HTMLPurifier_Config$configOptional config object for this operation. See HTMLPurifier::purify() for more details.
Rückgabe
string[] Array of purified HTML

Definiert in Zeile 240 der Datei HTMLPurifier.php.

Benutzt $config, $context und purify().

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

Dokumentation der Datenelemente

$config

Global configuration object. HTMLPurifier_Config

Definiert in Zeile 72 der Datei HTMLPurifier.php.

Wird benutzt von __construct(), purify() und purifyArray().

$context

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

Definiert in Zeile 102 der Datei HTMLPurifier.php.

Wird benutzt von purify() und purifyArray().

$filters = array()
private

Array of extra filter objects to run on HTML, for backwards compatibility. HTMLPurifier_Filter[]

Definiert in Zeile 79 der Datei HTMLPurifier.php.

Wird benutzt von purify().

$generator
protected

HTMLPurifier_Generator

Definiert in Zeile 95 der Datei HTMLPurifier.php.

$instance
staticprivate

Single instance of HTML Purifier. HTMLPurifier

Definiert in Zeile 85 der Datei HTMLPurifier.php.

$strategy
protected

HTMLPurifier_Strategy_Core

Definiert in Zeile 90 der Datei HTMLPurifier.php.

$version = '4.6.0'

Version of HTML Purifier. string

Definiert in Zeile 61 der Datei HTMLPurifier.php.

const VERSION = '4.6.0'

Constant with version of HTML Purifier.

Definiert in Zeile 66 der Datei HTMLPurifier.php.


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




Korrekturen, Hinweise und Ergänzungen

Bitte scheuen Sie sich nicht und melden Sie, was auf dieser Seite sachlich falsch oder irreführend ist, was ergänzt werden sollte, was fehlt usw. Dazu bitte oben aus dem Menü Seite den Eintrag Support Forum wählen. Es ist eine kostenlose Anmeldung erforderlich, um Anmerkungen zu posten. Unpassende Postings, Spam usw. werden kommentarlos entfernt.