HTMLPurifier_Config Class Reference

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)

Data Fields
	$version = '4.14.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.

Todo:

Reconsider some of the public member variables

Constructor & Destructor Documentation

__construct()

__construct	(		$definition,
			$parent = null
	)

Constructor

Parameters

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

Member Function Documentation

autoFinalize()

autoFinalize

(

)

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

Here is the call graph for this function:

Here is the caller graph for this function:

create()

static 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

Here is the call graph for this function:

Here is the caller graph for this function:

createDefault()

static createDefault ( )

static

Convenience constructor that creates a default configuration object.

Returns

HTMLPurifier_Config default object.

Here is the call graph for this function:

Here is the caller graph for this function:

finalize()

finalize

(

)

Finalizes a configuration object, prohibiting further change

Here is the caller graph for this function:

get()

get	(		$key,
			$a = null
	)

Retrieves a value from the configuration.

Parameters

string	$key	String key
mixed	$a

Returns

mixed

Here is the call graph for this function:

getAll()

getAll

(

)

Retrieves all directives, organized by namespace

Warning

This is a pretty inefficient function, avoid if you can

Here is the call graph for this function:

Here is the caller graph for this function:

getAllowedDirectivesForForm()

static 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

Here is the call graph for this function:

Here is the caller graph for this function:

getBatch()

getBatch

(

$namespace

)

Retrieves an array of directives to values from a given namespace

Parameters

string

$namespace

String namespace

Returns

array

Here is the call graph for this function:

Here is the caller graph for this function:

getBatchSerial()

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!

Here is the call graph for this function:

getCSSDefinition()

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|null

Here is the call graph for this function:

getDefinition()

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|null

Here is the call graph for this function:

Here is the caller graph for this function:

getHTMLDefinition()

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|null

Here is the call graph for this function:

getSerial()

getSerial

(

)

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

Returns

string

Here is the call graph for this function:

getURIDefinition()

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|null

Here is the call graph for this function:

inherit()

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

isFinalized()

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

Here is the call graph for this function:

Here is the caller graph for this function:

loadArray()

loadArray

(

$config_array

)

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

Parameters

array

$config_array

Configuration associative array

Here is the call graph for this function:

Here is the caller graph for this function:

loadArrayFromForm()

static 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

Here is the call graph for this function:

loadIni()

loadIni

(

$filename

)

Loads configuration values from an ini file

Parameters

string

$filename

Name of ini file

Here is the call graph for this function:

maybeGetRawCSSDefinition()

maybeGetRawCSSDefinition

(

)

Returns

HTMLPurifier_CSSDefinition|null

Here is the call graph for this function:

maybeGetRawDefinition()

maybeGetRawDefinition

(

$name

)

Here is the call graph for this function:

maybeGetRawHTMLDefinition()

maybeGetRawHTMLDefinition

(

)

Returns

HTMLPurifier_HTMLDefinition|null

Here is the call graph for this function:

maybeGetRawURIDefinition()

maybeGetRawURIDefinition

(

)

Returns

HTMLPurifier_URIDefinition|null

Here is the call graph for this function:

mergeArrayFromForm()

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

Here is the call graph for this function:

prepareArrayFromForm()

static 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

Here is the call graph for this function:

Here is the caller graph for this function:

serialize()

serialize

(

)

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

Returns

string

Here is the call graph for this function:

Here is the caller graph for this function:

set()

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

Sets a value to configuration.

Parameters

string	$key	key
mixed	$value	value
mixed	$a

Here is the call graph for this function:

triggerError()

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

Here is the caller graph for this function:

Field Documentation

$autoFinalize

$autoFinalize = true

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

$chatty

$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

$def

$def

Reference HTMLPurifier_ConfigSchema for value checking. @type HTMLPurifier_ConfigSchema

Note

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

$definitions

$definitions

protected

Indexed array of definitions. @type HTMLPurifier_Definition[]

$finalized

$finalized = false

protected

Whether or not config is finalized. @type bool

$parser

$parser = null

protected

Parser for variables. @type HTMLPurifier_VarParser_Flexible

$plist

$plist

protected

Property list containing configuration directives. @type array

$serial

$serial

protected

Serial for entire configuration object. @type string

$serials

$serials = array()

protected

Namespace indexed array of serials for specific namespaces.

See also

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

$version

$version = '4.14.0'

HTML Purifier's version @type string

---

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

• C:/xoops2511b2/htdocs/xoops_lib/modules/protector/library/HTMLPurifier/Config.php