Référence de la classe HTMLPurifier_Config

Fonctions membres publiques
	__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 ()

Fonctions membres publiques statiques
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)

Champs de données
	$version = '4.12.0'
	$autoFinalize = true
	$def
	$chatty = true

Fonctions membres protégées
	triggerError ($msg, $no)

Attributs protégés
	$serials = array()
	$serial
	$parser = null
	$definitions
	$finalized = false
	$plist

Fonctions membres privées
	_listify ($lookup)
	initDefinition ($type)

Attributs privés
	$aliasMode
	$lock

Description détaillée

Configuration object that triggers customizable behavior.

Avertissement

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.

A faire:

Reconsider some of the public member variables

Documentation des constructeurs et destructeur

__construct()

__construct	(		$definition,
			$parent = null
	)

Constructor

Paramètres

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

Documentation des fonctions membres

_listify()

_listify (   $lookup )

private

Convenience function for error reporting

Paramètres

array

$lookup

Renvoie

string

Voici le graphe des appelants de cette fonction :

autoFinalize()

autoFinalize

(

)

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

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

create()

static create (   $config,   $schema = null  )

static

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

Paramètres

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

Renvoie

HTMLPurifier_Config Configured object

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

createDefault()

static createDefault ( )

static

Convenience constructor that creates a default configuration object.

Renvoie

HTMLPurifier_Config default object.

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

finalize()

finalize

(

)

Finalizes a configuration object, prohibiting further change

Voici le graphe des appelants de cette fonction :

get()

get	(		$key,
			$a = null
	)

Retrieves a value from the configuration.

Paramètres

string	$key	String key
mixed	$a

Renvoie

mixed

Voici le graphe d'appel pour cette fonction :

getAll()

getAll

(

)

Retrieves all directives, organized by namespace

Avertissement

This is a pretty inefficient function, avoid if you can

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

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.

Paramètres

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

Renvoie

array

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

getBatch()

getBatch

(

$namespace

)

Retrieves an array of directives to values from a given namespace

Paramètres

string

$namespace

String namespace

Renvoie

array

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

getBatchSerial()

getBatchSerial

(

$namespace

)

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

Paramètres

string

$namespace

Namespace to get serial for

Renvoie

string

Note

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

Voici le graphe d'appel pour cette fonction :

getCSSDefinition()

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

Retrieves object reference to the CSS definition

Paramètres

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.

Renvoie

HTMLPurifier_CSSDefinition

Voici le graphe d'appel pour cette fonction :

getDefinition()

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

Retrieves a definition

Paramètres

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

Renvoie

HTMLPurifier_Definition

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

getHTMLDefinition()

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

Retrieves object reference to the HTML definition.

Paramètres

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.

Renvoie

HTMLPurifier_HTMLDefinition

Voici le graphe d'appel pour cette fonction :

getSerial()

getSerial

(

)

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

Renvoie

string

Voici le graphe d'appel pour cette fonction :

getURIDefinition()

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

Retrieves object reference to the URI definition

Paramètres

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.

Renvoie

HTMLPurifier_URIDefinition

Voici le graphe d'appel pour cette fonction :

inherit()

static inherit ( HTMLPurifier_Config  $config )

static

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

Paramètres

HTMLPurifier_Config

$config

Configuration object to inherit from.

Renvoie

HTMLPurifier_Config object with $config as its parent.

initDefinition()

initDefinition (   $type )

private

Initialise definition

Paramètres

string

$type

What type of definition to create

Renvoie

HTMLPurifier_CSSDefinition|HTMLPurifier_HTMLDefinition|HTMLPurifier_URIDefinition

Exceptions

HTMLPurifier_Exception

Voici le graphe des appelants de cette fonction :

isFinalized()

isFinalized

(

$error = false

)

Checks whether or not the configuration object is finalized.

Paramètres

string | bool

$error

String error message, or false for no error

Renvoie

bool

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

loadArray()

loadArray

(

$config_array

)

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

Paramètres

array

$config_array

Configuration associative array

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

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

Paramètres

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

Renvoie

mixed

Voici le graphe d'appel pour cette fonction :

loadIni()

loadIni

(

$filename

)

Loads configuration values from an ini file

Paramètres

string

$filename

Name of ini file

Voici le graphe d'appel pour cette fonction :

maybeGetRawCSSDefinition()

maybeGetRawCSSDefinition

(

)

Renvoie

HTMLPurifier_CSSDefinition

Voici le graphe d'appel pour cette fonction :

maybeGetRawDefinition()

maybeGetRawDefinition

(

$name

)

Voici le graphe d'appel pour cette fonction :

maybeGetRawHTMLDefinition()

maybeGetRawHTMLDefinition

(

)

Renvoie

HTMLPurifier_HTMLDefinition

Voici le graphe d'appel pour cette fonction :

maybeGetRawURIDefinition()

maybeGetRawURIDefinition

(

)

Renvoie

HTMLPurifier_URIDefinition

Voici le graphe d'appel pour cette fonction :

mergeArrayFromForm()

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

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

Paramètres

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

Voici le graphe d'appel pour cette fonction :

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

Paramètres

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

Renvoie

array

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

serialize()

serialize

(

)

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

Renvoie

string

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

set()

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

Sets a value to configuration.

Paramètres

string	$key	key
mixed	$value	value
mixed	$a

Voici le graphe d'appel pour cette fonction :

triggerError()

triggerError (   $msg,   $no  )

protected

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

Paramètres

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

Voici le graphe des appelants de cette fonction :

Documentation des champs

$aliasMode

$aliasMode

private

Whether or not a set is taking place due to an alias lookup. @type bool

$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

$lock

$lock

private

Current lock; only gets to this namespace are allowed. @type string

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

Voir également

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

$version

$version = '4.12.0'

HTML Purifier's version @type string

---

La documentation de cette classe a été générée à partir du fichier suivant :

• XoopsCore25-2.5.11-Beta1/htdocs/xoops_lib/modules/protector/library/HTMLPurifier/Config.php