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.3.0'
	$autoFinalize = true
	$def
	$chatty = true
Protected Member Functions
	triggerError ($msg, $no)
Protected Attributes
	$serials = array()
	$serial
	$parser
	$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

Definition at line 17 of file Config.php.

Constructor & Destructor Documentation

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

Parameters:

$definition HTMLPurifier_ConfigSchema that defines what directives are allowed.

Definition at line 93 of file Config.php.

Member Function Documentation

autoFinalize ( )

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

Definition at line 658 of file Config.php.

Here is the call graph for this function:

Here is the caller graph for this function:

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 object

Returns:: Configured HTMLPurifier_Config object

Definition at line 109 of file Config.php.

Here is the call graph for this function:

Here is the caller graph for this function:

static createDefault ( ) [static]

Convenience constructor that creates a default configuration object.

Returns:: Default HTMLPurifier_Config object.

Definition at line 138 of file Config.php.

Here is the caller graph for this function:

finalize ( )

Finalizes a configuration object, prohibiting further change

Definition at line 669 of file Config.php.

Here is the caller graph for this function:

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

Retreives a value from the configuration.

Parameters:

$key	String key

Definition at line 148 of file Config.php.

Here is the call graph for this function:

getAll ( )

Retrieves all directives, organized by namespace

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

Definition at line 222 of file Config.php.

Here is the call graph for this function:

Here is the caller graph for this function:

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:

$allowed List of allowed namespaces/directives

Definition at line 548 of file Config.php.

Here is the caller graph for this function:

getBatch ( $ namespace )

Retreives an array of directives to values from a given namespace

Parameters:

$namespace String namespace

Definition at line 180 of file Config.php.

Here is the call graph for this function:

Here is the caller graph for this function:

getBatchSerial ( $ namespace )

Returns a md5 signature of a segment of the configuration object that uniquely identifies that particular configuration

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

Parameters:

$namespace Namespace to get serial for

Definition at line 198 of file Config.php.

Here is the call graph for this function:

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

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.

Definition at line 344 of file Config.php.

Here is the call graph for this function:

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

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

Definition at line 376 of file Config.php.

Here is the call graph for this function:

Here is the caller graph for this function:

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

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.

Definition at line 329 of file Config.php.

Here is the call graph for this function:

getSerial ( )

Returns a md5 signature for the entire configuration object that uniquely identifies that particular configuration

Definition at line 211 of file Config.php.

Here is the call graph for this function:

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

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.

Definition at line 359 of file Config.php.

Here is the call graph for this function:

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.

Definition at line 130 of file Config.php.

isFinalized ( $ error = false )

Checks whether or not the configuration object is finalized.

Parameters:

$error String error message, or false for no error

Definition at line 647 of file Config.php.

Here is the call graph for this function:

Here is the caller graph for this function:

loadArray ( $ config_array )

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

Parameters:

$config_array Configuration associative array

Definition at line 526 of file Config.php.

Here is the call graph for this function:

Here is the caller graph for this function:

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	$_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	Instance of HTMLPurifier_ConfigSchema to use, if not global copy

Definition at line 594 of file Config.php.

Here is the call graph for this function:

loadIni ( $ filename )

Loads configuration values from an ini file

Parameters:

$filename Name of ini file

Definition at line 637 of file Config.php.

Here is the call graph for this function:

maybeGetRawCSSDefinition ( )

Definition at line 513 of file Config.php.

Here is the call graph for this function:

maybeGetRawDefinition ( $ name )

Definition at line 505 of file Config.php.

Here is the call graph for this function:

maybeGetRawHTMLDefinition ( )

Definition at line 509 of file Config.php.

Here is the call graph for this function:

maybeGetRawURIDefinition ( )

Definition at line 517 of file Config.php.

Here is the call graph for this function:

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

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

Note:: Same parameters as loadArrayFromForm

Definition at line 604 of file Config.php.

Here is the call graph for this function:

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

Definition at line 613 of file Config.php.

Here is the call graph for this function:

Here is the caller graph for this function:

serialize ( )

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

Definition at line 700 of file Config.php.

Here is the call graph for this function:

Here is the caller graph for this function:

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

Sets a value to configuration.

Parameters:

$key	String key
$value	Mixed value

Definition at line 237 of file Config.php.

Here is the call graph for this function:

triggerError	(	$	msg,
		$	no
	)		`[protected]`

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

Definition at line 678 of file Config.php.

Here is the caller graph for this function:

Field Documentation

$autoFinalize = true

Bool indicator whether or not to automatically finalize the object if a read operation is done

Definition at line 29 of file Config.php.

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

Definition at line 82 of file Config.php.

$def

Reference HTMLPurifier_ConfigSchema for value checking

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

Definition at line 54 of file Config.php.

$definitions [protected]

Indexed array of definitions

Definition at line 59 of file Config.php.

$finalized = false [protected]

Bool indicator whether or not config is finalized

Definition at line 64 of file Config.php.

$parser [protected]

Parser for variables

Definition at line 47 of file Config.php.

$plist [protected]

Property list containing configuration directives.

Definition at line 69 of file Config.php.

$serial [protected]

Serial for entire configuration object

Definition at line 42 of file Config.php.

$serials = array() [protected]

Namespace indexed array of serials for specific namespaces (see getSerial() for more info).

Definition at line 37 of file Config.php.

$version = '4.3.0'

HTML Purifier's version

Definition at line 23 of file Config.php.

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

C:/xampp/htdocs/moodle/lib/htmlpurifier/HTMLPurifier/Config.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation