Public Member Functions
	__construct ($definition, $parent=null)

	get ($key, $a=null)

	getBatch ($namespace)

	getBatchSerial ($namespace)

	getSerial ()

	getAll ()

	set ($key, $value, $a=null)

	getHTMLDefinition ($raw=false, $optimized=false)

	getCSSDefinition ($raw=false, $optimized=false)

	getURIDefinition ($raw=false, $optimized=false)

	getDefinition ($type, $raw=false, $optimized=false)

	maybeGetRawDefinition ($name)

	maybeGetRawHTMLDefinition ()

	maybeGetRawCSSDefinition ()

	maybeGetRawURIDefinition ()

	loadArray ($config_array)

	mergeArrayFromForm ($array, $index=false, $allowed=true, $mq_fix=true)

	loadIni ($filename)

	isFinalized ($error=false)

	autoFinalize ()

	finalize ()

	serialize ()

Static Public Member Functions
static	create ($config, $schema=null)

static	inherit (HTMLPurifier_Config $config)

static	createDefault ()

static	getAllowedDirectivesForForm ($allowed, $schema=null)

static	loadArrayFromForm ($array, $index=false, $allowed=true, $mq_fix=true, $schema=null)

static	prepareArrayFromForm ($array, $index=false, $allowed=true, $mq_fix=true, $schema=null)

Public Attributes
	$version = '4.12.0'

	$autoFinalize = true

	$def

	$chatty = true

Protected Member Functions
	triggerError ($msg, $no)

Protected Attributes
	$serials = array()

	$serial

	$parser = null

	$definitions

	$finalized = false

	$plist

Detailed Description

Configuration object that triggers customizable behavior.

Warning: This class is strongly defined: that means that the class will fail if an undefined directive is retrieved or set.

Note: Many classes that could (although many times don't) use the configuration object make it a mandatory parameter. This is because a configuration object should always be forwarded, otherwise, you run the risk of missing a parameter and then being stumped when a configuration directive doesn't work.

Definition at line 1806 of file HTMLPurifier.standalone.php.

Constructor & Destructor Documentation

◆ __construct()

HTMLPurifier_Config::__construct	(	$definition,
		$parent = `null`
	)

Constructor

Parameters

HTMLPurifier_ConfigSchema	$definition	ConfigSchema that defines what directives are allowed.
HTMLPurifier_PropertyList	$parent

Definition at line 1895 of file HTMLPurifier.standalone.php.

Member Function Documentation

◆ autoFinalize()

HTMLPurifier_Config::autoFinalize ( )

Finalizes configuration only if auto finalize is on and not already finalized

Definition at line 2648 of file HTMLPurifier.standalone.php.

◆ create()

static HTMLPurifier_Config::create	(	$config,
		$schema = `null`
	)

static

Convenience constructor that creates a config object based on a mixed var

Parameters

mixed	$config	Variable that defines the state of the config object. Can be: a HTMLPurifier_Config() object, an array of directives based on loadArray(), or a string filename of an ini file.
HTMLPurifier_ConfigSchema	$schema	Schema object

Returns: HTMLPurifier_Config Configured object

Definition at line 1912 of file HTMLPurifier.standalone.php.

◆ createDefault()

static HTMLPurifier_Config::createDefault ( )

static

Convenience constructor that creates a default configuration object.

Returns: HTMLPurifier_Config default object.

Definition at line 1943 of file HTMLPurifier.standalone.php.

◆ finalize()

HTMLPurifier_Config::finalize ( )

Finalizes a configuration object, prohibiting further change

Definition at line 2660 of file HTMLPurifier.standalone.php.

◆ get()

HTMLPurifier_Config::get	(	$key,
		$a = `null`
	)

Retrieves a value from the configuration.

Parameters

string	$key	String key
mixed	$a

Returns: mixed

Definition at line 1958 of file HTMLPurifier.standalone.php.

◆ getAll()

HTMLPurifier_Config::getAll ( )

Retrieves all directives, organized by namespace

Warning: This is a pretty inefficient function, avoid if you can

Definition at line 2065 of file HTMLPurifier.standalone.php.

◆ getAllowedDirectivesForForm()

static HTMLPurifier_Config::getAllowedDirectivesForForm	(	$allowed,
		$schema = `null`
	)

static

Returns a list of array(namespace, directive) for all directives that are allowed in a web-form context as per an allowed namespaces/directives list.

Parameters

array	$allowed	List of allowed namespaces/directives
HTMLPurifier_ConfigSchema	$schema	Schema to use, if not global copy

Returns: array

Definition at line 2497 of file HTMLPurifier.standalone.php.

◆ getBatch()

HTMLPurifier_Config::getBatch ( $namespace )

Retrieves an array of directives to values from a given namespace

Parameters

string $namespace String namespace

Returns: array

Definition at line 2009 of file HTMLPurifier.standalone.php.

◆ getBatchSerial()

HTMLPurifier_Config::getBatchSerial ( $namespace )

Returns a SHA-1 signature of a segment of the configuration object that uniquely identifies that particular configuration

Parameters

string $namespace Namespace to get serial for

Returns: string

Note: Revision is handled specially and is removed from the batch before processing!

Definition at line 2036 of file HTMLPurifier.standalone.php.

◆ getCSSDefinition()

HTMLPurifier_Config::getCSSDefinition	(	$raw = `false`,
		$optimized = `false`
	)

Retrieves object reference to the CSS definition

Parameters

bool	$raw	Return a copy that has not been setup yet. Must be called before it's been setup, otherwise won't work.
bool	$optimized	If true, this method may return null, to indicate that a cached version of the modified definition object is available and no further edits are necessary. Consider using maybeGetRawCSSDefinition, which is more explicitly named, instead.

Returns: HTMLPurifier_CSSDefinition

Definition at line 2221 of file HTMLPurifier.standalone.php.

◆ getDefinition()

HTMLPurifier_Config::getDefinition	(	$type,
		$raw = `false`,
		$optimized = `false`
	)

Retrieves a definition

Parameters

string	$type	Type of definition: HTML, CSS, etc
bool	$raw	Whether or not definition should be returned raw
bool	$optimized	Only has an effect when $raw is true. Whether or not to return null if the result is already present in the cache. This is off by default for backwards compatibility reasons, but you need to do things this way in order to ensure that caching is done properly. Check out enduser-customize.html for more details. We probably won't ever change this default, as much as the maybe semantics is the "right thing to do."

Exceptions

HTMLPurifier_Exception

Returns: HTMLPurifier_Definition

Definition at line 2262 of file HTMLPurifier.standalone.php.

◆ getHTMLDefinition()

HTMLPurifier_Config::getHTMLDefinition	(	$raw = `false`,
		$optimized = `false`
	)

Retrieves object reference to the HTML definition.

Parameters

bool	$raw	Return a copy that has not been setup yet. Must be called before it's been setup, otherwise won't work.
bool	$optimized	If true, this method may return null, to indicate that a cached version of the modified definition object is available and no further edits are necessary. Consider using maybeGetRawHTMLDefinition, which is more explicitly named, instead.

Returns: HTMLPurifier_HTMLDefinition

Definition at line 2202 of file HTMLPurifier.standalone.php.

◆ getSerial()

HTMLPurifier_Config::getSerial ( )

Returns a SHA-1 signature for the entire configuration object that uniquely identifies that particular configuration

Returns: string

Definition at line 2052 of file HTMLPurifier.standalone.php.

◆ getURIDefinition()

HTMLPurifier_Config::getURIDefinition	(	$raw = `false`,
		$optimized = `false`
	)

Retrieves object reference to the URI definition

Parameters

bool	$raw	Return a copy that has not been setup yet. Must be called before it's been setup, otherwise won't work.
bool	$optimized	If true, this method may return null, to indicate that a cached version of the modified definition object is available and no further edits are necessary. Consider using maybeGetRawURIDefinition, which is more explicitly named, instead.

Returns: HTMLPurifier_URIDefinition

Definition at line 2240 of file HTMLPurifier.standalone.php.

◆ inherit()

static HTMLPurifier_Config::inherit ( HTMLPurifier_Config $config )

static

Creates a new config object that inherits from a previous one.

Parameters

HTMLPurifier_Config $config Configuration object to inherit from.

Returns: HTMLPurifier_Config object with $config as its parent.

Definition at line 1934 of file HTMLPurifier.standalone.php.

◆ isFinalized()

HTMLPurifier_Config::isFinalized ( $error = false )

Checks whether or not the configuration object is finalized.

Parameters

string | bool $error String error message, or false for no error

Returns: bool

Definition at line 2636 of file HTMLPurifier.standalone.php.

◆ loadArray()

HTMLPurifier_Config::loadArray ( $config_array )

Loads configuration values from an array with the following structure: Namespace.Directive => Value

Parameters

array $config_array Configuration associative array

Definition at line 2468 of file HTMLPurifier.standalone.php.

◆ loadArrayFromForm()

static HTMLPurifier_Config::loadArrayFromForm	(	$array,
		$index = `false`,
		$allowed = `true`,
		$mq_fix = `true`,
		$schema = `null`
	)

static

Loads configuration values from $_GET/$_POST that were posted via ConfigForm

Parameters

array	$array	$_GET or $_POST array to import
string \| bool	$index	Index/name that the config variables are in
array \| bool	$allowed	List of allowed namespaces/directives
bool	$mq_fix	Boolean whether or not to enable magic quotes fix
HTMLPurifier_ConfigSchema	$schema	Schema to use, if not global copy

Returns: mixed

Definition at line 2557 of file HTMLPurifier.standalone.php.

◆ loadIni()

HTMLPurifier_Config::loadIni ( $filename )

Loads configuration values from an ini file

Parameters

string $filename Name of ini file

Definition at line 2620 of file HTMLPurifier.standalone.php.

◆ maybeGetRawCSSDefinition()

HTMLPurifier_Config::maybeGetRawCSSDefinition ( )

Returns: HTMLPurifier_CSSDefinition

Definition at line 2449 of file HTMLPurifier.standalone.php.

◆ maybeGetRawDefinition()

HTMLPurifier_Config::maybeGetRawDefinition ( $name )

Definition at line 2433 of file HTMLPurifier.standalone.php.

◆ maybeGetRawHTMLDefinition()

HTMLPurifier_Config::maybeGetRawHTMLDefinition ( )

Returns: HTMLPurifier_HTMLDefinition

Definition at line 2441 of file HTMLPurifier.standalone.php.

◆ maybeGetRawURIDefinition()

HTMLPurifier_Config::maybeGetRawURIDefinition ( )

Returns: HTMLPurifier_URIDefinition

Definition at line 2457 of file HTMLPurifier.standalone.php.

◆ mergeArrayFromForm()

HTMLPurifier_Config::mergeArrayFromForm	(	$array,
		$index = `false`,
		$allowed = `true`,
		$mq_fix = `true`
	)

Merges in configuration values from $_GET/$_POST to object. NOT STATIC.

Parameters

array	$array	$_GET or $_POST array to import
string \| bool	$index	Index/name that the config variables are in
array \| bool	$allowed	List of allowed namespaces/directives
bool	$mq_fix	Boolean whether or not to enable magic quotes fix

Definition at line 2572 of file HTMLPurifier.standalone.php.

◆ prepareArrayFromForm()

static HTMLPurifier_Config::prepareArrayFromForm	(	$array,
		$index = `false`,
		$allowed = `true`,
		$mq_fix = `true`,
		$schema = `null`
	)

static

Prepares an array from a form into something usable for the more strict parts of HTMLPurifier_Config

Parameters

array	$array	$_GET or $_POST array to import
string \| bool	$index	Index/name that the config variables are in
array \| bool	$allowed	List of allowed namespaces/directives
bool	$mq_fix	Boolean whether or not to enable magic quotes fix
HTMLPurifier_ConfigSchema	$schema	Schema to use, if not global copy

Returns: array

Definition at line 2590 of file HTMLPurifier.standalone.php.

◆ serialize()

HTMLPurifier_Config::serialize ( )

Returns a serialized form of the configuration object that can be reconstituted.

Returns: string

Definition at line 2699 of file HTMLPurifier.standalone.php.

◆ set()

HTMLPurifier_Config::set	(	$key,
		$value,
		$a = `null`
	)

Sets a value to configuration.

Parameters

string	$key	key
mixed	$value	value
mixed	$a

Definition at line 2085 of file HTMLPurifier.standalone.php.

◆ triggerError()

HTMLPurifier_Config::triggerError	(	$msg,
		$no
	)

protected

Produces a nicely formatted error message by supplying the stack frame information OUTSIDE of HTMLPurifier_Config.

Parameters

string	$msg	An error message
int	$no	An error number

Definition at line 2673 of file HTMLPurifier.standalone.php.

Member Data Documentation

◆ $autoFinalize

HTMLPurifier_Config::$autoFinalize = true

Whether or not to automatically finalize the object if a read operation is done. @type bool

Definition at line 1820 of file HTMLPurifier.standalone.php.

◆ $chatty

HTMLPurifier_Config::$chatty = true

Set to false if you do not want line and file numbers in errors. (useful when unit testing). This will also compress some errors and exceptions. @type bool

Definition at line 1881 of file HTMLPurifier.standalone.php.

◆ $def

HTMLPurifier_Config::$def

Reference HTMLPurifier_ConfigSchema for value checking. @type HTMLPurifier_ConfigSchema

Note: This is public for introspective purposes. Please don't abuse!

Definition at line 1849 of file HTMLPurifier.standalone.php.

◆ $definitions

HTMLPurifier_Config::$definitions

protected

Indexed array of definitions. @type HTMLPurifier_Definition[]

Definition at line 1855 of file HTMLPurifier.standalone.php.

◆ $finalized

HTMLPurifier_Config::$finalized = false

protected

Whether or not config is finalized. @type bool

Definition at line 1861 of file HTMLPurifier.standalone.php.

◆ $parser

HTMLPurifier_Config::$parser = null

protected

Parser for variables. @type HTMLPurifier_VarParser_Flexible

Definition at line 1841 of file HTMLPurifier.standalone.php.

◆ $plist

HTMLPurifier_Config::$plist

protected

Property list containing configuration directives. @type array

Definition at line 1867 of file HTMLPurifier.standalone.php.

◆ $serial

HTMLPurifier_Config::$serial

protected

Serial for entire configuration object. @type string

Definition at line 1835 of file HTMLPurifier.standalone.php.

◆ $serials

HTMLPurifier_Config::$serials = array()

protected

Namespace indexed array of serials for specific namespaces.

See also: getSerial() for more info. @type string[]

Definition at line 1829 of file HTMLPurifier.standalone.php.

◆ $version

HTMLPurifier_Config::$version = '4.12.0'

HTML Purifier's version @type string

Definition at line 1813 of file HTMLPurifier.standalone.php.

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

plugins/htmlpurifier/HTMLPurifier.standalone.php

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ autoFinalize()

◆ create()

◆ createDefault()

◆ finalize()

◆ get()

◆ getAll()

◆ getAllowedDirectivesForForm()

◆ getBatch()

◆ getBatchSerial()

◆ getCSSDefinition()

◆ getDefinition()

◆ getHTMLDefinition()

◆ getSerial()

◆ getURIDefinition()

◆ inherit()

◆ isFinalized()

◆ loadArray()

◆ loadArrayFromForm()

◆ loadIni()

◆ maybeGetRawCSSDefinition()

◆ maybeGetRawDefinition()

◆ maybeGetRawHTMLDefinition()

◆ maybeGetRawURIDefinition()

◆ mergeArrayFromForm()

◆ prepareArrayFromForm()

◆ serialize()

◆ set()

◆ triggerError()

Member Data Documentation

◆ $autoFinalize

◆ $chatty

◆ $def

◆ $definitions

◆ $finalized

◆ $parser

◆ $plist

◆ $serial

◆ $serials

◆ $version