API - XOOPS 2.5.11 Beta 2
By monxoops.fr
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.14.0'
 
const VERSION = '4.14.0'
 
 $config
 
 $context
 

Protected Attributes

 $strategy
 
 $generator
 

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.

Constructor & Destructor Documentation

◆ __construct()

__construct (   $config = null)

Initializes the purifier.

Parameters
HTMLPurifier_Config | mixed$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.
Here is the call graph for this function:

Member Function Documentation

◆ addFilter()

addFilter (   $filter)

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

Parameters
HTMLPurifier_Filter$filterHTMLPurifier_Filter object

◆ getInstance()

static getInstance (   $prototype = null)
static

Singleton for enforcing just one HTML Purifier in your system

Parameters
HTMLPurifier | HTMLPurifier_Config$prototypeOptional prototype HTMLPurifier instance to overload singleton with, or HTMLPurifier_Config instance to configure the generated version with.
Returns
HTMLPurifier
Note
Backwards compatibility, see instance()
Here is the call graph for this function:
Here is the caller graph for this function:

◆ instance()

static instance (   $prototype = null)
static

Singleton for enforcing just one HTML Purifier in your system

Parameters
HTMLPurifier | HTMLPurifier_Config$prototypeOptional prototype HTMLPurifier instance to overload singleton with, or HTMLPurifier_Config instance to configure the generated version with.
Returns
HTMLPurifier
Here is the call graph for this function:
Here is the caller graph for this function:

◆ purify()

purify (   $html,
  $config = null 
)

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

Parameters
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.
Returns
string Purified HTML
Here is the call graph for this function:
Here is the caller graph for this function:

◆ purifyArray()

purifyArray (   $array_of_html,
  $config = null 
)

Filters an array of HTML snippets

Parameters
string[]$array_of_htmlArray of html snippets
HTMLPurifier_Config$configOptional config object for this operation. See HTMLPurifier::purify() for more details.
Returns
string[] Array of purified HTML
Here is the call graph for this function:
Here is the caller graph for this function:

Field Documentation

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

◆ $generator

$generator
protected

◆ $strategy

$strategy
protected

◆ $version

$version = '4.14.0'

Version of HTML Purifier. @type string

◆ VERSION

const VERSION = '4.14.0'

Constant with version of HTML Purifier.


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