XOOPS API 2.5.11 Beta1
UI v0.5
Réalisé par monxoops.fr
|
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 | |
Configuration object that triggers customizable behavior.
__construct | ( | $definition, | |
$parent = null |
|||
) |
Constructor
HTMLPurifier_ConfigSchema | $definition | ConfigSchema that defines what directives are allowed. |
HTMLPurifier_PropertyList | $parent |
|
private |
Convenience function for error reporting
array | $lookup |
autoFinalize | ( | ) |
Finalizes configuration only if auto finalize is on and not already finalized
|
static |
Convenience constructor that creates a config object based on a mixed var
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 |
|
static |
Convenience constructor that creates a default configuration object.
finalize | ( | ) |
Finalizes a configuration object, prohibiting further change
get | ( | $key, | |
$a = null |
|||
) |
Retrieves a value from the configuration.
string | $key | String key |
mixed | $a |
getAll | ( | ) |
Retrieves all directives, organized by namespace
|
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.
array | $allowed | List of allowed namespaces/directives |
HTMLPurifier_ConfigSchema | $schema | Schema to use, if not global copy |
getBatch | ( | $namespace | ) |
Retrieves an array of directives to values from a given namespace
string | $namespace | String namespace |
getBatchSerial | ( | $namespace | ) |
Returns a SHA-1 signature of a segment of the configuration object that uniquely identifies that particular configuration
string | $namespace | Namespace to get serial for |
Retrieves object reference to the CSS definition
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. |
Retrieves a definition
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." |
HTMLPurifier_Exception |
Retrieves object reference to the HTML definition.
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. |
getSerial | ( | ) |
Returns a SHA-1 signature for the entire configuration object that uniquely identifies that particular configuration
Retrieves object reference to the URI definition
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. |
|
static |
Creates a new config object that inherits from a previous one.
HTMLPurifier_Config | $config | Configuration object to inherit from. |
|
private |
Initialise definition
string | $type | What type of definition to create |
HTMLPurifier_Exception |
isFinalized | ( | $error = false | ) |
Checks whether or not the configuration object is finalized.
string | bool | $error | String error message, or false for no error |
loadArray | ( | $config_array | ) |
Loads configuration values from an array with the following structure: Namespace.Directive => Value
array | $config_array | Configuration associative array |
|
static |
Loads configuration values from $_GET/$_POST that were posted via ConfigForm
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 |
loadIni | ( | $filename | ) |
Loads configuration values from an ini file
string | $filename | Name of ini file |
maybeGetRawCSSDefinition | ( | ) |
maybeGetRawDefinition | ( | $name | ) |
maybeGetRawHTMLDefinition | ( | ) |
maybeGetRawURIDefinition | ( | ) |
Merges in configuration values from $_GET/$_POST to object. NOT STATIC.
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 |
|
static |
Prepares an array from a form into something usable for the more strict parts of HTMLPurifier_Config
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 |
serialize | ( | ) |
Returns a serialized form of the configuration object that can be reconstituted.
set | ( | $key, | |
$value, | |||
$a = null |
|||
) |
Sets a value to configuration.
string | $key | key |
mixed | $value | value |
mixed | $a |
|
protected |
Produces a nicely formatted error message by supplying the stack frame information OUTSIDE of HTMLPurifier_Config.
string | $msg | An error message |
int | $no | An error number |
|
private |
Whether or not a set is taking place due to an alias lookup. @type bool
$autoFinalize = true |
Whether or not to automatically finalize the object if a read operation is done. @type bool
$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 |
Reference HTMLPurifier_ConfigSchema for value checking. @type HTMLPurifier_ConfigSchema
|
protected |
Indexed array of definitions. @type HTMLPurifier_Definition[]
|
protected |
Whether or not config is finalized. @type bool
|
private |
Current lock; only gets to this namespace are allowed. @type string
|
protected |
Parser for variables. @type HTMLPurifier_VarParser_Flexible
|
protected |
Property list containing configuration directives. @type array
|
protected |
Serial for entire configuration object. @type string
|
protected |
Namespace indexed array of serials for specific namespaces.
$version = '4.12.0' |
HTML Purifier's version @type string