HTMLPurifier 4.4.0
HTMLPurifier_Config Class Reference

Configuration object that triggers customizable behavior. More...

List of all members.

Public Member Functions

 __construct ($definition, $parent=null)
 get ($key, $a=null)
 Retreives a value from the configuration.
 getBatch ($namespace)
 Retreives an array of directives to values from a given namespace.
 getBatchSerial ($namespace)
 Returns a md5 signature of a segment of the configuration object that uniquely identifies that particular configuration.
 getSerial ()
 Returns a md5 signature for the entire configuration object that uniquely identifies that particular configuration.
 getAll ()
 Retrieves all directives, organized by namespace.
 set ($key, $value, $a=null)
 Sets a value to configuration.
 getHTMLDefinition ($raw=false, $optimized=false)
 Retrieves object reference to the HTML definition.
 getCSSDefinition ($raw=false, $optimized=false)
 Retrieves object reference to the CSS definition.
 getURIDefinition ($raw=false, $optimized=false)
 Retrieves object reference to the URI definition.
 getDefinition ($type, $raw=false, $optimized=false)
 Retrieves a definition.
 maybeGetRawDefinition ($name)
 maybeGetRawHTMLDefinition ()
 maybeGetRawCSSDefinition ()
 maybeGetRawURIDefinition ()
 loadArray ($config_array)
 Loads configuration values from an array with the following structure: Namespace.Directive => Value.
 mergeArrayFromForm ($array, $index=false, $allowed=true, $mq_fix=true)
 Merges in configuration values from $_GET/$_POST to object.
 loadIni ($filename)
 Loads configuration values from an ini file.
 isFinalized ($error=false)
 Checks whether or not the configuration object is finalized.
 autoFinalize ()
 Finalizes configuration only if auto finalize is on and not already finalized.
 finalize ()
 Finalizes a configuration object, prohibiting further change.
 serialize ()
 Returns a serialized form of the configuration object that can be reconstituted.
 __construct ($definition, $parent=null)
 get ($key, $a=null)
 Retreives a value from the configuration.
 getBatch ($namespace)
 Retreives an array of directives to values from a given namespace.
 getBatchSerial ($namespace)
 Returns a md5 signature of a segment of the configuration object that uniquely identifies that particular configuration.
 getSerial ()
 Returns a md5 signature for the entire configuration object that uniquely identifies that particular configuration.
 getAll ()
 Retrieves all directives, organized by namespace.
 set ($key, $value, $a=null)
 Sets a value to configuration.
 getHTMLDefinition ($raw=false, $optimized=false)
 Retrieves object reference to the HTML definition.
 getCSSDefinition ($raw=false, $optimized=false)
 Retrieves object reference to the CSS definition.
 getURIDefinition ($raw=false, $optimized=false)
 Retrieves object reference to the URI definition.
 getDefinition ($type, $raw=false, $optimized=false)
 Retrieves a definition.
 maybeGetRawDefinition ($name)
 maybeGetRawHTMLDefinition ()
 maybeGetRawCSSDefinition ()
 maybeGetRawURIDefinition ()
 loadArray ($config_array)
 Loads configuration values from an array with the following structure: Namespace.Directive => Value.
 mergeArrayFromForm ($array, $index=false, $allowed=true, $mq_fix=true)
 Merges in configuration values from $_GET/$_POST to object.
 loadIni ($filename)
 Loads configuration values from an ini file.
 isFinalized ($error=false)
 Checks whether or not the configuration object is finalized.
 autoFinalize ()
 Finalizes configuration only if auto finalize is on and not already finalized.
 finalize ()
 Finalizes a configuration object, prohibiting further change.
 serialize ()
 Returns a serialized form of the configuration object that can be reconstituted.

Static Public Member Functions

static create ($config, $schema=null)
 Convenience constructor that creates a config object based on a mixed var.
static inherit (HTMLPurifier_Config $config)
 Creates a new config object that inherits from a previous one.
static createDefault ()
 Convenience constructor that creates a default configuration object.
static getAllowedDirectivesForForm ($allowed, $schema=null)
 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.
static loadArrayFromForm ($array, $index=false, $allowed=true, $mq_fix=true, $schema=null)
 Loads configuration values from $_GET/$_POST that were posted via ConfigForm.
static prepareArrayFromForm ($array, $index=false, $allowed=true, $mq_fix=true, $schema=null)
 Prepares an array from a form into something usable for the more strict parts of HTMLPurifier_Config.
static create ($config, $schema=null)
 Convenience constructor that creates a config object based on a mixed var.
static inherit (HTMLPurifier_Config $config)
 Creates a new config object that inherits from a previous one.
static createDefault ()
 Convenience constructor that creates a default configuration object.
static getAllowedDirectivesForForm ($allowed, $schema=null)
 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.
static loadArrayFromForm ($array, $index=false, $allowed=true, $mq_fix=true, $schema=null)
 Loads configuration values from $_GET/$_POST that were posted via ConfigForm.
static prepareArrayFromForm ($array, $index=false, $allowed=true, $mq_fix=true, $schema=null)
 Prepares an array from a form into something usable for the more strict parts of HTMLPurifier_Config.

Public Attributes

 $version = '4.4.0'
 HTML Purifier's version.
 $autoFinalize = true
 Bool indicator whether or not to automatically finalize the object if a read operation is done.
 $def
 Reference HTMLPurifier_ConfigSchema for value checking.
 $chatty = true
 Set to false if you do not want line and file numbers in errors (useful when unit testing).

Protected Member Functions

 triggerError ($msg, $no)
 Produces a nicely formatted error message by supplying the stack frame information OUTSIDE of HTMLPurifier_Config.
 triggerError ($msg, $no)
 Produces a nicely formatted error message by supplying the stack frame information OUTSIDE of HTMLPurifier_Config.

Protected Attributes

 $serials = array()
 Namespace indexed array of serials for specific namespaces (see getSerial() for more info).
 $serial
 Serial for entire configuration object.
 $parser = null
 Parser for variables.
 $definitions
 Indexed array of definitions.
 $finalized = false
 Bool indicator whether or not config is finalized.
 $plist
 Property list containing configuration directives.

Private Member Functions

 _listify ($lookup)
 Convenience function for error reporting.
 initDefinition ($type)
 _listify ($lookup)
 Convenience function for error reporting.
 initDefinition ($type)

Private Attributes

 $aliasMode
 Whether or not a set is taking place due to an alias lookup.
 $lock
 Current lock; only gets to this namespace are allowed.

Detailed Description

Configuration object that triggers customizable behavior.

Warning:
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.
Todo:
Reconsider some of the public member variables
Warning:
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.
Todo:
Reconsider some of the public member variables

Definition at line 17 of file Config.php.


Constructor & Destructor Documentation

HTMLPurifier_Config::__construct ( definition,
parent = null 
)
Parameters:
$definitionHTMLPurifier_ConfigSchema that defines what directives are allowed.

Definition at line 93 of file Config.php.

HTMLPurifier_Config::__construct ( definition,
parent = null 
)
Parameters:
$definitionHTMLPurifier_ConfigSchema that defines what directives are allowed.

Definition at line 1445 of file HTMLPurifier.standalone.php.


Member Function Documentation

HTMLPurifier_Config::_listify ( lookup) [private]

Convenience function for error reporting.

Definition at line 312 of file Config.php.

Referenced by set().

HTMLPurifier_Config::_listify ( lookup) [private]

Convenience function for error reporting.

Definition at line 1664 of file HTMLPurifier.standalone.php.

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 autoFinalize(), get(), getAll(), getBatch(), and getDefinition().

HTMLPurifier_Config::autoFinalize ( )

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

Definition at line 2010 of file HTMLPurifier.standalone.php.

References autoFinalize(), and finalize().

static HTMLPurifier_Config::create ( config,
schema = null 
) [static]

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

Parameters:
mixed$configVariable 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_ConfigSchemaSchema object
Returns:
Configured HTMLPurifier_Config object

Definition at line 109 of file Config.php.

References $config, and createDefault().

Referenced by HTMLPurifier::__construct(), loadArrayFromForm(), phorum_htmlpurifier_get_config(), and HTMLPurifier::purify().

static HTMLPurifier_Config::create ( config,
schema = null 
) [static]

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

Parameters:
mixed$configVariable 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_ConfigSchemaSchema object
Returns:
Configured HTMLPurifier_Config object

Definition at line 1461 of file HTMLPurifier.standalone.php.

References $config, and createDefault().

static HTMLPurifier_Config::createDefault ( ) [static]

Convenience constructor that creates a default configuration object.

Returns:
Default HTMLPurifier_Config object.

Definition at line 1490 of file HTMLPurifier.standalone.php.

References $config, and HTMLPurifier_ConfigSchema::instance().

static HTMLPurifier_Config::createDefault ( ) [static]

Convenience constructor that creates a default configuration object.

Returns:
Default HTMLPurifier_Config object.

Definition at line 138 of file Config.php.

References $config, and HTMLPurifier_ConfigSchema::instance().

Referenced by create(), HTMLPurifier_URISchemeRegistry::getScheme(), kses(), and phorum_htmlpurifier_get_config().

HTMLPurifier_Config::finalize ( )

Finalizes a configuration object, prohibiting further change.

Definition at line 2021 of file HTMLPurifier.standalone.php.

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.

Parameters:
$keyString key

Definition at line 1500 of file HTMLPurifier.standalone.php.

References autoFinalize(), and triggerError().

HTMLPurifier_Config::get ( key,
a = null 
)

Retreives a value from the configuration.

Parameters:
$keyString key

Definition at line 148 of file Config.php.

References autoFinalize(), and triggerError().

HTMLPurifier_Config::getAll ( )

Retrieves all directives, organized by namespace.

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

Definition at line 222 of file Config.php.

References autoFinalize().

Referenced by getBatch(), and getSerial().

HTMLPurifier_Config::getAll ( )

Retrieves all directives, organized by namespace.

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

Definition at line 1574 of file HTMLPurifier.standalone.php.

References autoFinalize().

static HTMLPurifier_Config::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.

Parameters:
$allowedList of allowed namespaces/directives

Definition at line 548 of file Config.php.

References $def, and HTMLPurifier_ConfigSchema::instance().

Referenced by prepareArrayFromForm(), and HTMLPurifier_Printer_ConfigForm::render().

static HTMLPurifier_Config::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.

Parameters:
$allowedList of allowed namespaces/directives

Definition at line 1900 of file HTMLPurifier.standalone.php.

References $def, and HTMLPurifier_ConfigSchema::instance().

HTMLPurifier_Config::getBatch ( namespace)

Retreives an array of directives to values from a given namespace.

Parameters:
$namespaceString namespace

Definition at line 1532 of file HTMLPurifier.standalone.php.

References autoFinalize(), getAll(), and triggerError().

HTMLPurifier_Config::getBatch ( namespace)

Retreives an array of directives to values from a given namespace.

Parameters:
$namespaceString 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.

Note:
Revision is handled specially and is removed from the batch before processing!
Parameters:
$namespaceNamespace to get serial for

Definition at line 1550 of file HTMLPurifier.standalone.php.

References getBatch(), and serialize().

HTMLPurifier_Config::getBatchSerial ( namespace)

Returns a md5 signature of a segment of the configuration object that uniquely identifies that particular configuration.

Note:
Revision is handled specially and is removed from the batch before processing!
Parameters:
$namespaceNamespace to get serial for

Definition at line 198 of file Config.php.

References getBatch(), and serialize().

HTMLPurifier_Config::getCSSDefinition ( raw = false,
optimized = false 
)

Retrieves object reference to the CSS definition.

Parameters:
$rawReturn a copy that has not been setup yet. Must be called before it's been setup, otherwise won't work.
$optimizedIf 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 1696 of file HTMLPurifier.standalone.php.

References getDefinition().

HTMLPurifier_Config::getCSSDefinition ( raw = false,
optimized = false 
)

Retrieves object reference to the CSS definition.

Parameters:
$rawReturn a copy that has not been setup yet. Must be called before it's been setup, otherwise won't work.
$optimizedIf 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().

HTMLPurifier_Config::getDefinition ( type,
raw = false,
optimized = false 
)

Retrieves a definition.

Parameters:
$typeType of definition: HTML, CSS, etc
$rawWhether or not definition should be returned raw
$optimizedOnly 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 1728 of file HTMLPurifier.standalone.php.

References $def, $lock, autoFinalize(), initDefinition(), HTMLPurifier_DefinitionCacheFactory::instance(), and triggerError().

HTMLPurifier_Config::getDefinition ( type,
raw = false,
optimized = false 
)

Retrieves a definition.

Parameters:
$typeType of definition: HTML, CSS, etc
$rawWhether or not definition should be returned raw
$optimizedOnly 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, autoFinalize(), initDefinition(), HTMLPurifier_DefinitionCacheFactory::instance(), and triggerError().

Referenced by getCSSDefinition(), getHTMLDefinition(), getURIDefinition(), maybeGetRawCSSDefinition(), maybeGetRawDefinition(), maybeGetRawHTMLDefinition(), maybeGetRawURIDefinition(), and serialize().

HTMLPurifier_Config::getHTMLDefinition ( raw = false,
optimized = false 
)

Retrieves object reference to the HTML definition.

Parameters:
$rawReturn a copy that has not been setup yet. Must be called before it's been setup, otherwise won't work.
$optimizedIf 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 1681 of file HTMLPurifier.standalone.php.

References getDefinition().

HTMLPurifier_Config::getHTMLDefinition ( raw = false,
optimized = false 
)

Retrieves object reference to the HTML definition.

Parameters:
$rawReturn a copy that has not been setup yet. Must be called before it's been setup, otherwise won't work.
$optimizedIf 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 1563 of file HTMLPurifier.standalone.php.

References getAll(), and serialize().

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 getAll(), and serialize().

HTMLPurifier_Config::getURIDefinition ( raw = false,
optimized = false 
)

Retrieves object reference to the URI definition.

Parameters:
$rawReturn a copy that has not been setup yet. Must be called before it's been setup, otherwise won't work.
$optimizedIf 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 1711 of file HTMLPurifier.standalone.php.

References getDefinition().

HTMLPurifier_Config::getURIDefinition ( raw = false,
optimized = false 
)

Retrieves object reference to the URI definition.

Parameters:
$rawReturn a copy that has not been setup yet. Must be called before it's been setup, otherwise won't work.
$optimizedIf 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 HTMLPurifier_Config::inherit ( HTMLPurifier_Config config) [static]

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

Parameters:
HTMLPurifier_Config$configConfiguration object to inherit from.
Returns:
HTMLPurifier_Config object with $config as its parent.

Definition at line 130 of file Config.php.

static HTMLPurifier_Config::inherit ( HTMLPurifier_Config config) [static]

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

Parameters:
HTMLPurifier_Config$configConfiguration object to inherit from.
Returns:
HTMLPurifier_Config object with $config as its parent.

Definition at line 1482 of file HTMLPurifier.standalone.php.

HTMLPurifier_Config::initDefinition ( type) [private]

Definition at line 1842 of file HTMLPurifier.standalone.php.

References $def.

HTMLPurifier_Config::initDefinition ( type) [private]

Definition at line 490 of file Config.php.

References $def.

Referenced by getDefinition().

HTMLPurifier_Config::isFinalized ( error = false)

Checks whether or not the configuration object is finalized.

Parameters:
$errorString error message, or false for no error

Definition at line 1999 of file HTMLPurifier.standalone.php.

References triggerError().

HTMLPurifier_Config::isFinalized ( error = false)

Checks whether or not the configuration object is finalized.

Parameters:
$errorString error message, or false for no error

Definition at line 647 of file Config.php.

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

Parameters:
$config_arrayConfiguration associative array

Definition at line 1878 of file HTMLPurifier.standalone.php.

References isFinalized().

HTMLPurifier_Config::loadArray ( config_array)

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

Parameters:
$config_arrayConfiguration associative array

Definition at line 526 of file Config.php.

References isFinalized().

Referenced by loadIni(), and mergeArrayFromForm().

static HTMLPurifier_Config::loadArrayFromForm ( array,
index = false,
allowed = true,
mq_fix = true,
schema = null 
) [static]

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

Parameters:
$array$_GET or $_POST array to import
$indexIndex/name that the config variables are in
$allowedList of allowed namespaces/directives
$mq_fixBoolean whether or not to enable magic quotes fix
$schemaInstance of HTMLPurifier_ConfigSchema to use, if not global copy

Definition at line 594 of file Config.php.

References $config, create(), and prepareArrayFromForm().

static HTMLPurifier_Config::loadArrayFromForm ( array,
index = false,
allowed = true,
mq_fix = true,
schema = null 
) [static]

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

Parameters:
$array$_GET or $_POST array to import
$indexIndex/name that the config variables are in
$allowedList of allowed namespaces/directives
$mq_fixBoolean whether or not to enable magic quotes fix
$schemaInstance of HTMLPurifier_ConfigSchema to use, if not global copy

Definition at line 1946 of file HTMLPurifier.standalone.php.

References $config, create(), and prepareArrayFromForm().

HTMLPurifier_Config::loadIni ( filename)

Loads configuration values from an ini file.

Parameters:
$filenameName of ini file

Definition at line 1989 of file HTMLPurifier.standalone.php.

References isFinalized(), and loadArray().

HTMLPurifier_Config::loadIni ( filename)

Loads configuration values from an ini file.

Parameters:
$filenameName 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::maybeGetRawCSSDefinition ( )

Definition at line 1865 of file HTMLPurifier.standalone.php.

References getDefinition().

HTMLPurifier_Config::maybeGetRawDefinition ( name)

Definition at line 505 of file Config.php.

References getDefinition().

HTMLPurifier_Config::maybeGetRawDefinition ( name)

Definition at line 1857 of file HTMLPurifier.standalone.php.

References getDefinition().

HTMLPurifier_Config::maybeGetRawHTMLDefinition ( )

Definition at line 1861 of file HTMLPurifier.standalone.php.

References getDefinition().

HTMLPurifier_Config::maybeGetRawHTMLDefinition ( )

Definition at line 509 of file Config.php.

References getDefinition().

HTMLPurifier_Config::maybeGetRawURIDefinition ( )

Definition at line 1869 of file HTMLPurifier.standalone.php.

References getDefinition().

HTMLPurifier_Config::maybeGetRawURIDefinition ( )

Definition at line 517 of file Config.php.

References getDefinition().

HTMLPurifier_Config::mergeArrayFromForm ( array,
index = false,
allowed = true,
mq_fix = true 
)

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

NOT STATIC.

Note:
Same parameters as loadArrayFromForm

Definition at line 604 of file Config.php.

References loadArray(), and prepareArrayFromForm().

HTMLPurifier_Config::mergeArrayFromForm ( array,
index = false,
allowed = true,
mq_fix = true 
)

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

NOT STATIC.

Note:
Same parameters as loadArrayFromForm

Definition at line 1956 of file HTMLPurifier.standalone.php.

References loadArray(), and prepareArrayFromForm().

static HTMLPurifier_Config::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.

Definition at line 1965 of file HTMLPurifier.standalone.php.

References getAllowedDirectivesForForm().

static HTMLPurifier_Config::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.

Definition at line 613 of file Config.php.

References getAllowedDirectivesForForm().

Referenced by loadArrayFromForm(), and mergeArrayFromForm().

HTMLPurifier_Config::serialize ( )

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

Definition at line 2052 of file HTMLPurifier.standalone.php.

References getDefinition(), and serialize().

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(), getSerial(), and serialize().

HTMLPurifier_Config::set ( key,
value,
a = null 
)

Sets a value to configuration.

Parameters:
$keyString key
$valueMixed value

Definition at line 237 of file Config.php.

References $def, _listify(), HTMLPurifier_VarParser::getTypeName(), isFinalized(), and triggerError().

HTMLPurifier_Config::set ( key,
value,
a = null 
)

Sets a value to configuration.

Parameters:
$keyString key
$valueMixed value

Definition at line 1589 of file HTMLPurifier.standalone.php.

References $def, _listify(), HTMLPurifier_VarParser::getTypeName(), isFinalized(), and triggerError().

HTMLPurifier_Config::triggerError ( msg,
no 
) [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().

HTMLPurifier_Config::triggerError ( msg,
no 
) [protected]

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

Definition at line 2030 of file HTMLPurifier.standalone.php.


Member Data Documentation

HTMLPurifier_Config::$aliasMode [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.

Note:
This is public for introspective purposes. Please don't abuse!

Definition at line 54 of file Config.php.

Referenced by getAllowedDirectivesForForm(), getDefinition(), initDefinition(), and set().

HTMLPurifier_Config::$definitions [protected]

Indexed array of definitions.

Definition at line 59 of file Config.php.

HTMLPurifier_Config::$finalized = false [protected]

Bool indicator whether or not config is finalized.

Definition at line 64 of file Config.php.

HTMLPurifier_Config::$lock [private]

Current lock; only gets to this namespace are allowed.

Definition at line 87 of file Config.php.

Referenced by getDefinition().

HTMLPurifier_Config::$parser = null [protected]

Parser for variables.

Definition at line 47 of file Config.php.

HTMLPurifier_Config::$plist [protected]

Property list containing configuration directives.

Definition at line 69 of file Config.php.

HTMLPurifier_Config::$serial [protected]

Serial for entire configuration object.

Definition at line 42 of file Config.php.

HTMLPurifier_Config::$serials = array() [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.


The documentation for this class was generated from the following files: