XOOPS 2.5.6
Final
|
Public Member Functions | |
__construct ($definition, $parent=null) | |
autoFinalize () | |
finalize () | |
get ($key, $a=null) | |
getAll () | |
getBatch ($namespace) | |
getBatchSerial ($namespace) | |
getCSSDefinition ($raw=false, $optimized=false) | |
getDefinition ($type, $raw=false, $optimized=false) | |
getHTMLDefinition ($raw=false, $optimized=false) | |
getSerial () | |
getURIDefinition ($raw=false, $optimized=false) | |
isFinalized ($error=false) | |
loadArray ($config_array) | |
loadIni ($filename) | |
maybeGetRawCSSDefinition () | |
maybeGetRawDefinition ($name) | |
maybeGetRawHTMLDefinition () | |
maybeGetRawURIDefinition () | |
mergeArrayFromForm ($array, $index=false, $allowed=true, $mq_fix=true) | |
serialize () | |
set ($key, $value, $a=null) | |
Static Public Member Functions | |
static | create ($config, $schema=null) |
static | createDefault () |
static | getAllowedDirectivesForForm ($allowed, $schema=null) |
static | inherit (HTMLPurifier_Config $config) |
static | loadArrayFromForm ($array, $index=false, $allowed=true, $mq_fix=true, $schema=null) |
static | prepareArrayFromForm ($array, $index=false, $allowed=true, $mq_fix=true, $schema=null) |
Public Attributes | |
$autoFinalize = true | |
$chatty = true | |
$def | |
$version = '4.4.0' | |
Protected Member Functions | |
triggerError ($msg, $no) | |
Protected Attributes | |
$definitions | |
$finalized = false | |
$parser = null | |
$plist | |
$serial | |
$serials = array() | |
Private Member Functions | |
_listify ($lookup) | |
initDefinition ($type) | |
Private Attributes | |
$aliasMode | |
$lock | |
Configuration object that triggers customizable behavior.
Definition at line 17 of file Config.php.
HTMLPurifier_Config::__construct | ( | $definition, | |
$parent = null |
|||
) |
$definition | HTMLPurifier_ConfigSchema that defines what directives are allowed. |
Definition at line 93 of file Config.php.
|
private |
Convenience function for error reporting
Definition at line 312 of file Config.php.
Referenced by set().
HTMLPurifier_Config::autoFinalize | ( | ) |
Finalizes configuration only if auto finalize is on and not already finalized
Definition at line 658 of file Config.php.
References finalize().
Referenced by get(), getAll(), getBatch(), and getDefinition().
|
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 object |
Definition at line 109 of file Config.php.
References $config, $ret, and createDefault().
Referenced by HTMLPurifier\__construct(), loadArrayFromForm(), and HTMLPurifier\purify().
|
static |
Convenience constructor that creates a default configuration object.
Definition at line 138 of file Config.php.
References $config, and HTMLPurifier_ConfigSchema\instance().
Referenced by create(), protector_postcommon_post_htmlpurify4everyone\execute(), protector_postcommon_post_htmlpurify4guest\execute(), HTMLPurifier_URISchemeRegistry\getScheme(), and kses().
HTMLPurifier_Config::finalize | ( | ) |
Finalizes a configuration object, prohibiting further change
Definition at line 669 of file Config.php.
Referenced by autoFinalize().
HTMLPurifier_Config::get | ( | $key, | |
$a = null |
|||
) |
Retreives a value from the configuration.
$key | String key |
Definition at line 148 of file Config.php.
References autoFinalize(), and triggerError().
HTMLPurifier_Config::getAll | ( | ) |
Retrieves all directives, organized by namespace
Definition at line 222 of file Config.php.
References $ret, and autoFinalize().
Referenced by getBatch(), and getSerial().
|
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.
$allowed | List of allowed namespaces/directives |
Definition at line 548 of file Config.php.
References $allowed, $def, $ret, and HTMLPurifier_ConfigSchema\instance().
Referenced by prepareArrayFromForm(), and HTMLPurifier_Printer_ConfigForm\render().
HTMLPurifier_Config::getBatch | ( | $namespace | ) |
Retreives an array of directives to values from a given namespace
$namespace | String namespace |
Definition at line 180 of file Config.php.
References autoFinalize(), getAll(), and triggerError().
Referenced by getBatchSerial().
HTMLPurifier_Config::getBatchSerial | ( | $namespace | ) |
Returns a md5 signature of a segment of the configuration object that uniquely identifies that particular configuration
$namespace | Namespace to get serial for |
Definition at line 198 of file Config.php.
References getBatch(), and serialize().
Retrieves object reference to the CSS definition
$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.
References getDefinition().
Retrieves a definition
$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.
References $def, $lock, $msg, $type, autoFinalize(), initDefinition(), HTMLPurifier_DefinitionCacheFactory\instance(), and triggerError().
Referenced by getCSSDefinition(), getHTMLDefinition(), getURIDefinition(), maybeGetRawCSSDefinition(), maybeGetRawDefinition(), maybeGetRawHTMLDefinition(), maybeGetRawURIDefinition(), and serialize().
Retrieves object reference to the HTML definition.
$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.
References getDefinition().
HTMLPurifier_Config::getSerial | ( | ) |
Returns a md5 signature for the entire configuration object that uniquely identifies that particular configuration
Definition at line 211 of file Config.php.
References $serial, getAll(), and serialize().
Retrieves object reference to the URI definition
$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.
References getDefinition().
|
static |
Creates a new config object that inherits from a previous one.
HTMLPurifier_Config | $config | Configuration object to inherit from. |
Definition at line 130 of file Config.php.
|
private |
Definition at line 490 of file Config.php.
Referenced by getDefinition().
HTMLPurifier_Config::isFinalized | ( | $error = false | ) |
Checks whether or not the configuration object is finalized.
$error | String error message, or false for no error |
Definition at line 647 of file Config.php.
References $error, $finalized, and triggerError().
Referenced by loadArray(), loadIni(), and set().
HTMLPurifier_Config::loadArray | ( | $config_array | ) |
Loads configuration values from an array with the following structure: Namespace.Directive => Value
$config_array | Configuration associative array |
Definition at line 526 of file Config.php.
References isFinalized().
Referenced by loadIni(), and mergeArrayFromForm().
|
static |
Loads configuration values from $_GET/$_POST that were posted via ConfigForm
$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.
References $allowed, $config, $index, $ret, create(), and prepareArrayFromForm().
HTMLPurifier_Config::loadIni | ( | $filename | ) |
Loads configuration values from an ini file
$filename | Name of ini file |
Definition at line 637 of file Config.php.
References isFinalized(), and loadArray().
HTMLPurifier_Config::maybeGetRawCSSDefinition | ( | ) |
Definition at line 513 of file Config.php.
References getDefinition().
HTMLPurifier_Config::maybeGetRawDefinition | ( | $name | ) |
Definition at line 505 of file Config.php.
References getDefinition().
HTMLPurifier_Config::maybeGetRawHTMLDefinition | ( | ) |
Definition at line 509 of file Config.php.
References getDefinition().
HTMLPurifier_Config::maybeGetRawURIDefinition | ( | ) |
Definition at line 517 of file Config.php.
References getDefinition().
Merges in configuration values from $_GET/$_POST to object. NOT STATIC.
Definition at line 604 of file Config.php.
References $allowed, $index, $ret, loadArray(), and prepareArrayFromForm().
|
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.
References $allowed, $index, $ret, and getAllowedDirectivesForForm().
Referenced by loadArrayFromForm(), and mergeArrayFromForm().
HTMLPurifier_Config::serialize | ( | ) |
Returns a serialized form of the configuration object that can be reconstituted.
Definition at line 700 of file Config.php.
References getDefinition().
Referenced by getBatchSerial(), and getSerial().
HTMLPurifier_Config::set | ( | $key, | |
$value, | |||
$a = null |
|||
) |
Sets a value to configuration.
$key | String key |
$value | Mixed value |
Definition at line 237 of file Config.php.
References $def, $type, _listify(), HTMLPurifier_VarParser\getTypeName(), isFinalized(), and triggerError().
|
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.
Referenced by get(), getBatch(), getDefinition(), isFinalized(), and set().
|
private |
Whether or not a set is taking place due to an alias lookup.
Definition at line 75 of file Config.php.
HTMLPurifier_Config::$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.
HTMLPurifier_Config::$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.
HTMLPurifier_Config::$def |
Reference HTMLPurifier_ConfigSchema for value checking
Definition at line 54 of file Config.php.
Referenced by getAllowedDirectivesForForm(), getDefinition(), initDefinition(), and set().
|
protected |
Indexed array of definitions
Definition at line 59 of file Config.php.
|
protected |
Bool indicator whether or not config is finalized
Definition at line 64 of file Config.php.
Referenced by isFinalized().
|
private |
Current lock; only gets to this namespace are allowed.
Definition at line 87 of file Config.php.
Referenced by getDefinition().
|
protected |
Parser for variables
Definition at line 47 of file Config.php.
|
protected |
Property list containing configuration directives.
Definition at line 69 of file Config.php.
|
protected |
Serial for entire configuration object
Definition at line 42 of file Config.php.
Referenced by getSerial().
|
protected |
Namespace indexed array of serials for specific namespaces (see getSerial() for more info).
Definition at line 37 of file Config.php.
HTMLPurifier_Config::$version = '4.4.0' |
HTML Purifier's version
Definition at line 23 of file Config.php.