HTMLPurifier 4.4.0
|
Facade that coordinates HTML Purifier's subsystems in order to purify HTML. More...
Public Member Functions | |
__construct ($config=null) | |
Initializes the purifier. | |
addFilter ($filter) | |
Adds a filter to process the output. | |
purify ($html, $config=null) | |
Filters an HTML snippet/document to be XSS-free and standards-compliant. | |
purifyArray ($array_of_html, $config=null) | |
Filters an array of HTML snippets. | |
__construct ($config=null) | |
Initializes the purifier. | |
addFilter ($filter) | |
Adds a filter to process the output. | |
purify ($html, $config=null) | |
Filters an HTML snippet/document to be XSS-free and standards-compliant. | |
purifyArray ($array_of_html, $config=null) | |
Filters an array of HTML snippets. | |
Static Public Member Functions | |
static | instance ($prototype=null) |
Singleton for enforcing just one HTML Purifier in your system. | |
static | getInstance ($prototype=null) |
static | instance ($prototype=null) |
Singleton for enforcing just one HTML Purifier in your system. | |
static | getInstance ($prototype=null) |
Public Attributes | |
$version = '4.4.0' | |
Version of HTML Purifier. | |
const | VERSION = '4.4.0' |
Constant with version of HTML Purifier. | |
$config | |
Global configuration object. | |
$generator | |
$context | |
Resultant HTMLPurifier_Context of last run purification. | |
Protected Attributes | |
$strategy | |
Private Attributes | |
$filters = array() | |
Array of extra HTMLPurifier_Filter objects to run on HTML, for backwards compatibility. | |
Static Private Attributes | |
static | $instance |
Single instance of HTML Purifier. |
Facade that coordinates HTML Purifier's subsystems in order to purify HTML.
Definition at line 54 of file HTMLPurifier.php.
HTMLPurifier::__construct | ( | $ | config = null | ) |
Initializes the purifier.
$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.
References $config, and HTMLPurifier_Config::create().
HTMLPurifier::__construct | ( | $ | config = null | ) |
Initializes the purifier.
$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 108 of file HTMLPurifier.standalone.php.
References $config, and HTMLPurifier_Config::create().
HTMLPurifier::addFilter | ( | $ | filter | ) |
Adds a filter to process the output.
First come first serve
$filter | HTMLPurifier_Filter object |
Definition at line 100 of file HTMLPurifier.php.
HTMLPurifier::addFilter | ( | $ | filter | ) |
Adds a filter to process the output.
First come first serve
$filter | HTMLPurifier_Filter object |
Definition at line 120 of file HTMLPurifier.standalone.php.
static HTMLPurifier::getInstance | ( | $ | prototype = null | ) | [static] |
Definition at line 231 of file HTMLPurifier.php.
References instance().
Referenced by phorum_htmlpurifier_before_editor(), phorum_htmlpurifier_common(), phorum_htmlpurifier_editor_after_subject(), phorum_htmlpurifier_format(), phorum_htmlpurifier_quote(), and HTMLPurifier_ConfigSchema_Builder_Xml::writeHTMLDiv().
static HTMLPurifier::getInstance | ( | $ | prototype = null | ) | [static] |
Definition at line 251 of file HTMLPurifier.standalone.php.
References instance().
static HTMLPurifier::instance | ( | $ | prototype = null | ) | [static] |
Singleton for enforcing just one HTML Purifier in your system.
$prototype | Optional prototype HTMLPurifier instance to overload singleton with, or HTMLPurifier_Config instance to configure the generated version with. |
Definition at line 235 of file HTMLPurifier.standalone.php.
References $instance, and HTMLPurifier().
static HTMLPurifier::instance | ( | $ | prototype = null | ) | [static] |
Singleton for enforcing just one HTML Purifier in your system.
$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.
References $instance, and HTMLPurifier().
Referenced by getInstance(), and purify().
HTMLPurifier::purify | ( | $ | html, |
$ | config = null |
||
) |
Filters an HTML snippet/document to be XSS-free and standards-compliant.
$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. |
Definition at line 115 of file HTMLPurifier.php.
References $config, $context, $filters, $html, HTMLPurifier_IDAccumulator::build(), HTMLPurifier_Encoder::convertFromUTF8(), HTMLPurifier_Encoder::convertToUTF8(), HTMLPurifier_Lexer::create(), HTMLPurifier_Config::create(), and instance().
Referenced by purifyArray().
HTMLPurifier::purify | ( | $ | html, |
$ | config = null |
||
) |
Filters an HTML snippet/document to be XSS-free and standards-compliant.
$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. |
Definition at line 135 of file HTMLPurifier.standalone.php.
References $config, $context, $filters, $html, HTMLPurifier_IDAccumulator::build(), HTMLPurifier_Encoder::convertFromUTF8(), HTMLPurifier_Encoder::convertToUTF8(), HTMLPurifier_Lexer::create(), HTMLPurifier_Config::create(), and instance().
HTMLPurifier::purifyArray | ( | $ | array_of_html, |
$ | config = null |
||
) |
Filters an array of HTML snippets.
$config | Optional HTMLPurifier_Config object for this operation. See HTMLPurifier::purify() for more details. |
Definition at line 199 of file HTMLPurifier.php.
HTMLPurifier::purifyArray | ( | $ | array_of_html, |
$ | config = null |
||
) |
Filters an array of HTML snippets.
$config | Optional HTMLPurifier_Config object for this operation. See HTMLPurifier::purify() for more details. |
Definition at line 219 of file HTMLPurifier.standalone.php.
HTMLPurifier::$config |
Global configuration object.
Definition at line 64 of file HTMLPurifier.php.
Referenced by __construct(), purify(), and purifyArray().
HTMLPurifier::$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.
Referenced by purify().
HTMLPurifier::$filters = array() [private] |
Array of extra HTMLPurifier_Filter objects to run on HTML, for backwards compatibility.
Definition at line 67 of file HTMLPurifier.php.
Referenced by purify().
HTMLPurifier::$generator |
Definition at line 72 of file HTMLPurifier.php.
static HTMLPurifier::$instance [static, private] |
Single instance of HTML Purifier.
Definition at line 70 of file HTMLPurifier.php.
Referenced by instance().
HTMLPurifier::$strategy [protected] |
Definition at line 72 of file HTMLPurifier.php.
HTMLPurifier::$version = '4.4.0' |
Version of HTML Purifier.
Definition at line 58 of file HTMLPurifier.php.
const HTMLPurifier::VERSION = '4.4.0' |
Constant with version of HTML Purifier.
Definition at line 61 of file HTMLPurifier.php.