HTMLPurifier_Config Klassenreferenz
Öffentliche Methoden | |
| __construct ($definition, $parent=null) | |
| get ($key, $a=null) | |
| getBatch ($namespace) | |
| getBatchSerial ($namespace) | |
| getSerial () | |
| getAll () | |
| set ($key, $value, $a=null) | |
| getHTMLDefinition ($raw=false) | |
| getCSSDefinition ($raw=false) | |
| getDefinition ($type, $raw=false) | |
| 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.0.0' | |
| $autoFinalize = true | |
| $def | |
| $chatty = true | |
Geschützte Methoden | |
| triggerError ($msg, $no) | |
Geschützte Attribute | |
| $serials = array() | |
| $serial | |
| $parser | |
| $definitions | |
| $finalized = false | |
| $plist | |
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 | |||
| ) |
- Parameter:
-
$definition HTMLPurifier_ConfigSchema that defines what directives are allowed.
Definiert in Zeile 92 der Datei Config.php.
Dokumentation der Elementfunktionen
| autoFinalize | ( | ) |
Finalizes configuration only if auto finalize is on and not already finalized
Definiert in Zeile 534 der Datei Config.php.
| 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 object
- Rückgabe:
- Configured HTMLPurifier_Config object
Definiert in Zeile 108 der Datei Config.php.
| static createDefault | ( | ) | [static] |
Convenience constructor that creates a default configuration object.
- Rückgabe:
- Default HTMLPurifier_Config object.
Definiert in Zeile 137 der Datei Config.php.
| finalize | ( | ) |
Finalizes a configuration object, prohibiting further change
Definiert in Zeile 545 der Datei Config.php.
| get | ( | $ | key, | |
| $ | a = null | |||
| ) |
Retreives a value from the configuration.
- Parameter:
-
$key String key
Definiert in Zeile 147 der Datei Config.php.
| getAll | ( | ) |
Retrieves all directives, organized by namespace
- Warnung:
- This is a pretty inefficient function, avoid if you can
Definiert in Zeile 221 der Datei Config.php.
| 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:
-
$allowed List of allowed namespaces/directives
Definiert in Zeile 424 der Datei Config.php.
| getBatch | ( | $ | namespace | ) |
Retreives an array of directives to values from a given namespace
- Parameter:
-
$namespace String namespace
Definiert in Zeile 179 der Datei Config.php.
| getBatchSerial | ( | $ | namespace | ) |
Returns a md5 signature of a segment of the configuration object that uniquely identifies that particular configuration
- Zu beachten:
- Revision is handled specially and is removed from the batch before processing!
- Parameter:
-
$namespace Namespace to get serial for
Definiert in Zeile 197 der Datei Config.php.
| getCSSDefinition | ( | $ | raw = false |
) |
Retrieves object reference to the CSS definition
- Parameter:
-
$raw Return a copy that has not been setup yet. Must be called before it's been setup, otherwise won't work.
Definiert in Zeile 331 der Datei Config.php.
| getDefinition | ( | $ | type, | |
| $ | raw = false | |||
| ) |
Retrieves a definition
- Parameter:
-
$type Type of definition: HTML, CSS, etc $raw Whether or not definition should be returned raw
Definiert in Zeile 340 der Datei Config.php.
| getHTMLDefinition | ( | $ | raw = false |
) |
Retrieves object reference to the HTML definition.
- Parameter:
-
$raw Return a copy that has not been setup yet. Must be called before it's been setup, otherwise won't work.
Definiert in Zeile 322 der Datei Config.php.
| getSerial | ( | ) |
Returns a md5 signature for the entire configuration object that uniquely identifies that particular configuration
Definiert in Zeile 210 der Datei Config.php.
| 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 129 der Datei Config.php.
| isFinalized | ( | $ | error = false |
) |
Checks whether or not the configuration object is finalized.
- Parameter:
-
$error String error message, or false for no error
Definiert in Zeile 523 der Datei Config.php.
| loadArray | ( | $ | config_array | ) |
Loads configuration values from an array with the following structure: Namespace.Directive => Value
- Parameter:
-
$config_array Configuration associative array
Definiert in Zeile 402 der Datei Config.php.
| 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 $_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
Definiert in Zeile 470 der Datei Config.php.
| loadIni | ( | $ | filename | ) |
Loads configuration values from an ini file
- Parameter:
-
$filename Name of ini file
Definiert in Zeile 513 der Datei Config.php.
| mergeArrayFromForm | ( | $ | array, | |
| $ | index = false, |
|||
| $ | allowed = true, |
|||
| $ | mq_fix = true | |||
| ) |
Merges in configuration values from $_GET/$_POST to object. NOT STATIC.
- Zu beachten:
- Same parameters as loadArrayFromForm
Definiert in Zeile 480 der Datei Config.php.
| 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
Definiert in Zeile 489 der Datei Config.php.
| serialize | ( | ) |
Returns a serialized form of the configuration object that can be reconstituted.
Definiert in Zeile 571 der Datei Config.php.
| set | ( | $ | key, | |
| $ | value, | |||
| $ | a = null | |||
| ) |
Sets a value to configuration.
- Parameter:
-
$key String key $value Mixed value
Definiert in Zeile 236 der Datei Config.php.
| triggerError | ( | $ | msg, | |
| $ | no | |||
| ) | [protected] |
Produces a nicely formatted error message by supplying the stack frame information from two levels up and OUTSIDE of HTMLPurifier_Config.
Definiert in Zeile 555 der Datei Config.php.
Dokumentation der Datenelemente
| $autoFinalize = true |
Bool indicator whether or not to automatically finalize the object if a read operation is done
Definiert in Zeile 29 der Datei Config.php.
| $chatty = true |
Set to false if you do not want line and file numbers in errors (useful when unit testing)
Definiert in Zeile 81 der Datei Config.php.
| $def |
Reference HTMLPurifier_ConfigSchema for value checking
- Zu beachten:
- This is public for introspective purposes. Please don't abuse!
Definiert in Zeile 54 der Datei Config.php.
$definitions [protected] |
Indexed array of definitions
Definiert in Zeile 59 der Datei Config.php.
$finalized = false [protected] |
Bool indicator whether or not config is finalized
Definiert in Zeile 64 der Datei Config.php.
$parser [protected] |
Parser for variables
Definiert in Zeile 47 der Datei Config.php.
$plist [protected] |
Property list containing configuration directives.
Definiert in Zeile 69 der Datei Config.php.
$serial [protected] |
Serial for entire configuration object
Definiert in Zeile 42 der Datei Config.php.
$serials = array() [protected] |
Namespace indexed array of serials for specific namespaces (see getSerial() for more info).
Definiert in Zeile 37 der Datei Config.php.
| $version = '4.0.0' |
HTML Purifier's version
Definiert in Zeile 23 der Datei Config.php.
Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei:
- HTMLPurifier/Config.php
