Class HTMLPurifier_Config


					
	public

__construct(HTMLPurifier_ConfigSchema $definition, HTMLPurifier_PropertyList $parent = null)

Constructor

Parameters

$definition

ConfigSchema that defines what directives are allowed.

#


					
	public
					static

create(mixed $config, HTMLPurifier_ConfigSchema $schema = null): HTMLPurifier_Config

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

Parameters

`$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.
`$schema`	Schema object

Returns

Configured object

#


					
	public
					static

inherit(HTMLPurifier_Config $config): HTMLPurifier_Config

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

Parameters

$config

Configuration object to inherit from.

Returns

object with $config as its parent.

#


					
	public
					static

createDefault(): HTMLPurifier_Config

Convenience constructor that creates a default configuration object.

Returns

default object.

#


					
	public

get(string $key, mixed $a = null): mixed

Retrieves a value from the configuration.

Parameters

$key

String key

#


					
	public

getBatch(string $namespace): array

Retrieves an array of directives to values from a given namespace

Parameters

$namespace

String namespace

#


					
	public

getBatchSerial(string $namespace): string

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

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

Parameters

$namespace

Namespace to get serial for

#


					
	public

getSerial(): string

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

#


					
	public

getAll()

Retrieves all directives, organized by namespace

#


					
	public

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

Sets a value to configuration.

Parameters

`$key`	key
`$value`	value

#


					
	public

getHTMLDefinition(bool $raw = false, bool $optimized = false): HTMLPurifier_HTMLDefinition|null

Retrieves object reference to the HTML definition.

Parameters

`$raw`	Return a copy that has not been setup yet. Must be called before it's been setup, otherwise won't work.
`$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.

#


					
	public

getCSSDefinition(bool $raw = false, bool $optimized = false): HTMLPurifier_CSSDefinition|null

Retrieves object reference to the CSS definition

Parameters

`$raw`	Return a copy that has not been setup yet. Must be called before it's been setup, otherwise won't work.
`$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.

#


					
	public

getURIDefinition(bool $raw = false, bool $optimized = false): HTMLPurifier_URIDefinition|null

Retrieves object reference to the URI definition

Parameters

`$raw`	Return a copy that has not been setup yet. Must be called before it's been setup, otherwise won't work.
`$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.

#


					
	public

getDefinition(string $type, bool $raw = false, bool $optimized = false): HTMLPurifier_Definition|null

Retrieves a definition

Parameters

`$type`	Type of definition: HTML, CSS, etc
`$raw`	Whether or not definition should be returned raw
`$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."

Throws

HTMLPurifier_Exception

#


					
	public

maybeGetRawDefinition($name)

#


					
	public

maybeGetRawHTMLDefinition(): HTMLPurifier_HTMLDefinition|null

#


					
	public

maybeGetRawCSSDefinition(): HTMLPurifier_CSSDefinition|null

#


					
	public

maybeGetRawURIDefinition(): HTMLPurifier_URIDefinition|null

#


					
	public

loadArray(array $config_array)

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

Parameters

$config_array

Configuration associative array

#


					
	public
					static

getAllowedDirectivesForForm(array $allowed, HTMLPurifier_ConfigSchema $schema = null): array

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

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

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

#


					
	public
					static

loadArrayFromForm(
	array $array,
	string|bool $index = false,
	array|bool $allowed = true,
	bool $mq_fix = true,
	HTMLPurifier_ConfigSchema $schema = null,
): mixed

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

Parameters

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

#


					
	public

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

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

Parameters

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

#


					
	public
					static

prepareArrayFromForm(
	array $array,
	string|bool $index = false,
	array|bool $allowed = true,
	bool $mq_fix = true,
	HTMLPurifier_ConfigSchema $schema = null,
): array

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

Parameters

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

#


					
	public

loadIni(string $filename)

Loads configuration values from an ini file

Parameters

$filename

Name of ini file

#


					
	public

isFinalized(string|bool $error = false): bool

Checks whether or not the configuration object is finalized.

Parameters

$error

String error message, or false for no error

#


					
	public

autoFinalize()

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

#


					
	public

finalize()

Finalizes a configuration object, prohibiting further change

#


					
	protected

triggerError(string $msg, int $no)

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

Parameters

`$msg`	An error message
`$no`	An error number

#


					
	public

serialize(): string

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

#

Properties
`public`	`$version = '4.15.0'` HTML Purifier's version HTML Purifier's version	#
`public`	`$autoFinalize = true` Whether or not to automatically finalize the object if a read operation is done. Whether or not to automatically finalize the object if a read operation is done.	#
`protected`	`$serials = []` Namespace indexed array of serials for specific namespaces. Namespace indexed array of serials for specific namespaces.	#
`protected`	`$serial` Serial for entire configuration object. Serial for entire configuration object.	#
`protected`	`$parser = null` Parser for variables. Parser for variables.	#
`public`	`$def` Reference HTMLPurifier_ConfigSchema for value checking. Reference HTMLPurifier_ConfigSchema for value checking.	#
`protected`	`$definitions` Indexed array of definitions. Indexed array of definitions.	#
`protected`	`$finalized = false` Whether or not config is finalized. Whether or not config is finalized.	#
`protected`	`$plist` Property list containing configuration directives. Property list containing configuration directives.	#
`public`	`$chatty = true` Set to false if you do not want line and file numbers in errors. (useful when unit testing). This will also compress… 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.	#

Namespaces

Classes

Interfaces

Exceptions

Functions

Class HTMLPurifier_Config

Parameters

Parameters

Returns

Parameters

Returns

Returns

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Throws

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters