Référence de la classe HTMLPurifier

Fonctions membres publiques
	__construct ($config=null)
	addFilter ($filter)
	purify ($html, $config=null)
	purifyArray ($array_of_html, $config=null)

Fonctions membres publiques statiques
static	instance ($prototype=null)
static	getInstance ($prototype=null)

Champs de données
	$version = '4.12.0'
const	VERSION = '4.12.0'
	$config
	$context

Attributs protégés
	$strategy
	$generator

Attributs privés
	$filters = array()

Attributs privés statiques
static	$instance

Description détaillée

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

A faire:

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

Documentation des constructeurs et destructeur

__construct()

__construct

(

$config = null

)

Initializes the purifier.

Paramètres

HTMLPurifier_Config | mixed

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

Voici le graphe d'appel pour cette fonction :

Documentation des fonctions membres

addFilter()

addFilter

(

$filter

)

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

Paramètres

HTMLPurifier_Filter

$filter

HTMLPurifier_Filter object

getInstance()

static getInstance (   $prototype = null )

static

Singleton for enforcing just one HTML Purifier in your system

Paramètres

HTMLPurifier | HTMLPurifier_Config

$prototype

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

Renvoie

HTMLPurifier

Note

Backwards compatibility, see instance()

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

instance()

static instance (   $prototype = null )

static

Singleton for enforcing just one HTML Purifier in your system

Paramètres

HTMLPurifier | HTMLPurifier_Config

$prototype

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

Renvoie

HTMLPurifier

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

purify()

purify	(		$html,
			$config = null
	)

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

Paramètres

string	$html	String of HTML to purify
HTMLPurifier_Config	$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.

Renvoie

string Purified HTML

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

purifyArray()

purifyArray	(		$array_of_html,
			$config = null
	)

Filters an array of HTML snippets

Paramètres

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

Renvoie

string[] Array of purified HTML

Voici le graphe d'appel pour cette fonction :

Documentation des champs

$config

$config

Global configuration object. @type HTMLPurifier_Config

$context

$context

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

$filters

$filters = array()

private

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

$generator

$generator

protected

@type HTMLPurifier_Generator

$instance

$instance

staticprivate

Single instance of HTML Purifier. @type HTMLPurifier

$strategy

$strategy

protected

@type HTMLPurifier_Strategy_Core

$version

$version = '4.12.0'

Version of HTML Purifier. @type string

VERSION

const VERSION = '4.12.0'

Constant with version of HTML Purifier.

---

La documentation de cette classe a été générée à partir du fichier suivant :

• XoopsCore25-2.5.11-Beta1/htdocs/xoops_lib/modules/protector/library/HTMLPurifier.php