Öffentliche Methoden
	__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 ()

Öffentliche, statische Methoden
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)

Datenfelder
	$version = '4.6.0'

	$autoFinalize = true

	$def

	$chatty = true

Geschützte Methoden
	triggerError ($msg, $no)

Geschützte Attribute
	$serials = array()

	$serial

	$parser = null

	$definitions

	$finalized = false

	$plist

Private Methoden
	_listify ($lookup)

	initDefinition ($type)

Private Attribute
	$aliasMode

	$lock

Ausführliche Beschreibung

Configuration object that triggers customizable behavior.

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

Zu beachten: 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.

Noch zu erledigen:: Reconsider some of the public member variables

Definiert in Zeile 17 der Datei Config.php.

Beschreibung der Konstruktoren und Destruktoren

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

Constructor

Parameter

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

Definiert in Zeile 106 der Datei Config.php.

Dokumentation der Elementfunktionen

_listify ( $lookup)

private

Convenience function for error reporting

Parameter

array $lookup

Rückgabe: string

Definiert in Zeile 390 der Datei Config.php.

Wird benutzt von set().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

autoFinalize ( )

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

Definiert in Zeile 850 der Datei Config.php.

Benutzt finalize().

Wird benutzt von get(), getAll(), getBatch() und getDefinition().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

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

static

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

Parameter

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

Rückgabe: HTMLPurifier_Config Configured object

Definiert in Zeile 123 der Datei Config.php.

Benutzt createDefault().

Wird benutzt von HTMLPurifier\__construct(), loadArrayFromForm() und HTMLPurifier\purify().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

static createDefault ( )

static

Convenience constructor that creates a default configuration object.

Rückgabe: HTMLPurifier_Config default object.

Definiert in Zeile 154 der Datei Config.php.

Benutzt HTMLPurifier_ConfigSchema\instance().

Wird benutzt von create(), HTMLPurifier_URISchemeRegistry\getScheme() und kses().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

finalize ( )

Finalizes a configuration object, prohibiting further change

Definiert in Zeile 862 der Datei Config.php.

Wird benutzt von autoFinalize().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

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

Retrieves a value from the configuration.

Parameter

string	$key	String key
mixed	$a

Rückgabe: mixed

Definiert in Zeile 169 der Datei Config.php.

Benutzt autoFinalize() und triggerError().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

getAll ( )

Retrieves all directives, organized by namespace

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

Definiert in Zeile 276 der Datei Config.php.

Benutzt autoFinalize().

Wird benutzt von getBatch() und getSerial().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

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.

Parameter

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

Rückgabe: array

Definiert in Zeile 699 der Datei Config.php.

Benutzt $def und HTMLPurifier_ConfigSchema\instance().

Wird benutzt von prepareArrayFromForm() und HTMLPurifier_Printer_ConfigForm\render().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

getBatch ( $namespace)

Retrieves an array of directives to values from a given namespace

Parameter

string $namespace String namespace

Rückgabe: array

Definiert in Zeile 220 der Datei Config.php.

Benutzt autoFinalize(), getAll() und triggerError().

Wird benutzt von getBatchSerial().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

getBatchSerial ( $namespace)

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

Parameter

string $namespace Namespace to get serial for

Rückgabe: string

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

Definiert in Zeile 247 der Datei Config.php.

Benutzt getBatch() und serialize().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

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

Retrieves object reference to the CSS definition

Parameter

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.

Rückgabe: HTMLPurifier_CSSDefinition

Definiert in Zeile 432 der Datei Config.php.

Benutzt getDefinition().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

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

Retrieves a definition

Parameter

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

Ausnahmebehandlung

HTMLPurifier_Exception

Rückgabe: HTMLPurifier_Definition

Definiert in Zeile 473 der Datei Config.php.

Benutzt $def, $lock, autoFinalize(), initDefinition(), HTMLPurifier_DefinitionCacheFactory\instance() und triggerError().

Wird benutzt von getCSSDefinition(), getHTMLDefinition(), getURIDefinition(), maybeGetRawCSSDefinition(), maybeGetRawDefinition(), maybeGetRawHTMLDefinition(), maybeGetRawURIDefinition() und serialize().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

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

Retrieves object reference to the HTML definition.

Parameter

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.

Rückgabe: HTMLPurifier_HTMLDefinition

Definiert in Zeile 413 der Datei Config.php.

Benutzt getDefinition().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

getSerial ( )

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

Rückgabe: string

Definiert in Zeile 263 der Datei Config.php.

Benutzt $serial, getAll() und serialize().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

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

Retrieves object reference to the URI definition

Parameter

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.

Rückgabe: HTMLPurifier_URIDefinition

Definiert in Zeile 451 der Datei Config.php.

Benutzt getDefinition().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

static inherit ( HTMLPurifier_Config $config)

static

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

Parameter

HTMLPurifier_Config $config Configuration object to inherit from.

Rückgabe: HTMLPurifier_Config object with $config as its parent.

Definiert in Zeile 145 der Datei Config.php.

initDefinition ( $type)

private

Initialise definition

Parameter

string $type What type of definition to create

Rückgabe: HTMLPurifier_CSSDefinition|HTMLPurifier_HTMLDefinition|HTMLPurifier_URIDefinition

Ausnahmebehandlung

HTMLPurifier_Exception

Definiert in Zeile 626 der Datei Config.php.

Benutzt $def.

Wird benutzt von getDefinition().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

isFinalized ( $error = false)

Checks whether or not the configuration object is finalized.

Parameter

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

Rückgabe: bool

Definiert in Zeile 838 der Datei Config.php.

Benutzt $finalized und triggerError().

Wird benutzt von loadArray(), loadIni() und set().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

loadArray ( $config_array)

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

Parameter

array $config_array Configuration associative array

Definiert in Zeile 670 der Datei Config.php.

Benutzt isFinalized() und set().

Wird benutzt von loadIni() und mergeArrayFromForm().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

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

static

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

Parameter

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

Rückgabe: mixed

Definiert in Zeile 759 der Datei Config.php.

Benutzt create() und prepareArrayFromForm().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

loadIni ( $filename)

Loads configuration values from an ini file

Parameter

string $filename Name of ini file

Definiert in Zeile 822 der Datei Config.php.

Benutzt isFinalized() und loadArray().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

maybeGetRawCSSDefinition ( )

Definiert in Zeile 654 der Datei Config.php.

Benutzt getDefinition().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

maybeGetRawDefinition ( $name)

Definiert in Zeile 644 der Datei Config.php.

Benutzt getDefinition().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

maybeGetRawHTMLDefinition ( )

Definiert in Zeile 649 der Datei Config.php.

Benutzt getDefinition().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

maybeGetRawURIDefinition ( )

Definiert in Zeile 659 der Datei Config.php.

Benutzt getDefinition().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

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

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

Parameter

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

Definiert in Zeile 774 der Datei Config.php.

Benutzt loadArray() und prepareArrayFromForm().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

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

Parameter

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