htmlpurifier  4.15.0
About: HTML Purifier is an HTML filtering solution. It tries to remove all malicious code (XSS) and to make sure the HTML is standards compliant.
  Fossies Dox: htmlpurifier-4.15.0.tar.gz  ("unofficial" and yet experimental doxygen-generated source code documentation)  

Loading...
Searching...
No Matches
HTMLPurifier_Config Class Reference

Configuration object that triggers customizable behavior. More...

Public Member Functions

 __construct ($definition, $parent=null)
 Constructor.
 
 get ($key, $a=null)
 Retrieves a value from the configuration.
 
 getBatch ($namespace)
 Retrieves an array of directives to values from a given namespace.
 
 getBatchSerial ($namespace)
 Returns a SHA-1 signature of a segment of the configuration object that uniquely identifies that particular configuration.
 
 getSerial ()
 Returns a SHA-1 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.
 

Public Attributes

 $version = '4.15.0'
 HTML Purifier's version @type string.
 
 $autoFinalize = true
 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.
 

Protected Member Functions

 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.
 
 $serial
 Serial for entire configuration object.
 
 $parser = null
 Parser for variables.
 
 $definitions
 Indexed array of definitions.
 
 $finalized = false
 Whether or not config is finalized.
 
 $plist
 Property list containing configuration directives.
 

Private Member Functions

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

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

Definition at line 17 of file Config.php.

Constructor & Destructor Documentation

◆ __construct()

HTMLPurifier_Config::__construct (   $definition,
  $parent = null 
)

Constructor.

Parameters
HTMLPurifier_ConfigSchema$definitionConfigSchema that defines what directives are allowed.
HTMLPurifier_PropertyList$parent

Definition at line 106 of file Config.php.

Member Function Documentation

◆ _listify()

HTMLPurifier_Config::_listify (   $lookup)
private

Convenience function for error reporting.

Parameters
array$lookup
Returns
string

Definition at line 390 of file Config.php.

Referenced by set().

◆ autoFinalize()

HTMLPurifier_Config::autoFinalize ( )

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

Definition at line 859 of file Config.php.

References autoFinalize(), and finalize().

Referenced by autoFinalize(), get(), getAll(), getBatch(), and getDefinition().

◆ create()

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_ConfigSchema$schemaSchema object
Returns
HTMLPurifier_Config Configured object

Definition at line 123 of file Config.php.

References $config, $schema, and createDefault().

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

◆ createDefault()

static HTMLPurifier_Config::createDefault ( )
static

Convenience constructor that creates a default configuration object.

Returns
HTMLPurifier_Config default object.

Definition at line 154 of file Config.php.

References $config, and HTMLPurifier_ConfigSchema\instance().

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

◆ finalize()

HTMLPurifier_Config::finalize ( )

Finalizes a configuration object, prohibiting further change.

Definition at line 871 of file Config.php.

Referenced by autoFinalize().

◆ get()

HTMLPurifier_Config::get (   $key,
  $a = null 
)

Retrieves a value from the configuration.

Parameters
string$keyString key
mixed$a
Returns
mixed

Definition at line 169 of file Config.php.

References autoFinalize(), and triggerError().

◆ getAll()

HTMLPurifier_Config::getAll ( )

Retrieves all directives, organized by namespace.

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

Definition at line 276 of file Config.php.

References autoFinalize().

Referenced by getBatch(), and getSerial().

◆ getAllowedDirectivesForForm()

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
array$allowedList of allowed namespaces/directives
HTMLPurifier_ConfigSchema$schemaSchema to use, if not global copy
Returns
array

Definition at line 708 of file Config.php.

References $allowed, $def, $schema, and HTMLPurifier_ConfigSchema\instance().

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

◆ getBatch()

HTMLPurifier_Config::getBatch (   $namespace)

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

Parameters
string$namespaceString namespace
Returns
array

Definition at line 220 of file Config.php.

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

Referenced by getBatchSerial().

◆ getBatchSerial()

HTMLPurifier_Config::getBatchSerial (   $namespace)

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

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

Definition at line 247 of file Config.php.

References getBatch(), and serialize().

◆ getCSSDefinition()

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

Retrieves object reference to the CSS definition.

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

Definition at line 432 of file Config.php.

References getDefinition().

◆ getDefinition()

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

Retrieves a definition.

Parameters
string$typeType of definition: HTML, CSS, etc
bool$rawWhether or not definition should be returned raw
bool$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."
Exceptions
HTMLPurifier_Exception
Returns
HTMLPurifier_Definition|null

Definition at line 473 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().

◆ getHTMLDefinition()

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

Retrieves object reference to the HTML definition.

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

Definition at line 413 of file Config.php.

References getDefinition().

◆ getSerial()

HTMLPurifier_Config::getSerial ( )

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

Returns
string

Definition at line 263 of file Config.php.

References $serial, getAll(), and serialize().

◆ getURIDefinition()

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

Retrieves object reference to the URI definition.

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

Definition at line 451 of file Config.php.

References getDefinition().

◆ inherit()

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 145 of file Config.php.

References $config.

◆ initDefinition()

HTMLPurifier_Config::initDefinition (   $type)
private

Initialise definition.

Parameters
string$typeWhat type of definition to create
Returns
HTMLPurifier_CSSDefinition|HTMLPurifier_HTMLDefinition|HTMLPurifier_URIDefinition
Exceptions
HTMLPurifier_Exception

Definition at line 626 of file Config.php.

References $def.

Referenced by getDefinition().

◆ isFinalized()

HTMLPurifier_Config::isFinalized (   $error = false)

Checks whether or not the configuration object is finalized.

Parameters
string | bool$errorString error message, or false for no error
Returns
bool

Definition at line 847 of file Config.php.

References $finalized, and triggerError().

Referenced by loadArray(), loadIni(), and set().

◆ loadArray()

HTMLPurifier_Config::loadArray (   $config_array)

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

Parameters
array$config_arrayConfiguration associative array

Definition at line 679 of file Config.php.

References isFinalized().

Referenced by loadIni(), and mergeArrayFromForm().

◆ loadArrayFromForm()

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$array$_GET or $_POST array to import
string | bool$indexIndex/name that the config variables are in
array | bool$allowedList of allowed namespaces/directives
bool$mq_fixBoolean whether or not to enable magic quotes fix
HTMLPurifier_ConfigSchema$schemaSchema to use, if not global copy
Returns
mixed

Definition at line 768 of file Config.php.

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

◆ loadIni()

HTMLPurifier_Config::loadIni (   $filename)

Loads configuration values from an ini file.

Parameters
string$filenameName of ini file

Definition at line 831 of file Config.php.

References isFinalized(), and loadArray().

◆ maybeGetRawCSSDefinition()

HTMLPurifier_Config::maybeGetRawCSSDefinition ( )
Returns
HTMLPurifier_CSSDefinition|null

Definition at line 660 of file Config.php.

References getDefinition().

◆ maybeGetRawDefinition()

HTMLPurifier_Config::maybeGetRawDefinition (   $name)

Definition at line 644 of file Config.php.

References getDefinition().

◆ maybeGetRawHTMLDefinition()

HTMLPurifier_Config::maybeGetRawHTMLDefinition ( )
Returns
HTMLPurifier_HTMLDefinition|null

Definition at line 652 of file Config.php.

References getDefinition().

◆ maybeGetRawURIDefinition()

HTMLPurifier_Config::maybeGetRawURIDefinition ( )
Returns
HTMLPurifier_URIDefinition|null

Definition at line 668 of file Config.php.

References getDefinition().

◆ mergeArrayFromForm()

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

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

NOT STATIC.

Parameters
array$array$_GET or $_POST array to import
string | bool$indexIndex/name that the config variables are in
array | bool$allowedList of allowed namespaces/directives
bool$mq_fixBoolean whether or not to enable magic quotes fix

Definition at line 783 of file Config.php.

References $allowed, loadArray(), and prepareArrayFromForm().

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

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

Definition at line 801 of file Config.php.

References $allowed, $schema, and getAllowedDirectivesForForm().

Referenced by loadArrayFromForm(), and mergeArrayFromForm().

◆ serialize()

HTMLPurifier_Config::serialize ( )

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

Returns
string

Definition at line 910 of file Config.php.

References getDefinition(), and serialize().

Referenced by getBatchSerial(), getSerial(), and serialize().

◆ set()

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

Sets a value to configuration.

Parameters
string$keykey
mixed$valuevalue
mixed$a

Definition at line 296 of file Config.php.

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

◆ triggerError()

HTMLPurifier_Config::triggerError (   $msg,
  $no 
)
protected

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

Parameters
string$msgAn error message
int$noAn error number

Definition at line 884 of file Config.php.

References $i.

Referenced by get(), getBatch(), getDefinition(), isFinalized(), and set().

Member Data Documentation

◆ $aliasMode

HTMLPurifier_Config::$aliasMode
private

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

@type bool

Definition at line 84 of file Config.php.

◆ $autoFinalize

HTMLPurifier_Config::$autoFinalize = true

Whether or not to automatically finalize the object if a read operation is done.

@type bool

Definition at line 31 of file Config.php.

◆ $chatty

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. @type bool

Definition at line 92 of file Config.php.

◆ $def

HTMLPurifier_Config::$def

Reference HTMLPurifier_ConfigSchema for value checking.

@type HTMLPurifier_ConfigSchema

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

Definition at line 60 of file Config.php.

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

◆ $definitions

HTMLPurifier_Config::$definitions
protected

Indexed array of definitions.

@type HTMLPurifier_Definition[]

Definition at line 66 of file Config.php.

◆ $finalized

HTMLPurifier_Config::$finalized = false
protected

Whether or not config is finalized.

@type bool

Definition at line 72 of file Config.php.

Referenced by isFinalized().

◆ $lock

HTMLPurifier_Config::$lock
private

Current lock; only gets to this namespace are allowed.

@type string

Definition at line 98 of file Config.php.

Referenced by getDefinition().

◆ $parser

HTMLPurifier_Config::$parser = null
protected

Parser for variables.

@type HTMLPurifier_VarParser_Flexible

Definition at line 52 of file Config.php.

◆ $plist

HTMLPurifier_Config::$plist
protected

Property list containing configuration directives.

@type array

Definition at line 78 of file Config.php.

◆ $serial

HTMLPurifier_Config::$serial
protected

Serial for entire configuration object.

@type string

Definition at line 46 of file Config.php.

Referenced by getSerial().

◆ $serials

HTMLPurifier_Config::$serials = array()
protected

Namespace indexed array of serials for specific namespaces.

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

Definition at line 40 of file Config.php.

◆ $version

HTMLPurifier_Config::$version = '4.15.0'

HTML Purifier's version @type string.

Definition at line 24 of file Config.php.


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