mirror of
https://github.com/ezyang/htmlpurifier.git
synced 2024-11-08 23:08:42 +00:00
ca1453401f
git-svn-id: http://htmlpurifier.org/svnroot/htmlpurifier/trunk@319 48356398-32a2-884e-a903-53898d9a118a
48 lines
2.4 KiB
Plaintext
48 lines
2.4 KiB
Plaintext
|
|
Configuration
|
|
|
|
Configuration is documented on a per-use case: if a class uses a certain
|
|
value from the configuration object, it has to define its name and what the
|
|
value is used for. This means decentralized configuration declarations that
|
|
are nevertheless error checking and a centralized configuration object.
|
|
|
|
Directives are divided into namespaces, indicating the major portion of
|
|
functionality they cover (although there may be overlaps. Please consult
|
|
the documentation in ConfigDef for more information on these namespaces.
|
|
|
|
Since configuration is dependent on context, most of the internal classes
|
|
require a configuration object to be passed as a parameter. However, a few
|
|
make this optional: they will supply a default configuration object if none
|
|
are passed. These classes are: HTMLPurifier::*, Generator::generateFromTokens
|
|
and Lexer::tokenizeHTML. However, whenever a valid configuration object
|
|
is defined, that object should be used.
|
|
|
|
-- the following is projected changes to the configuration system --
|
|
|
|
In relation to HTMLDefinition and CSSDefinition, there are going to be some
|
|
major structural changes to enable the easy configuration of these objects.
|
|
Due to the intricacy of these objects, it's not feasible to ask an average
|
|
user to twiddle around with an element and its 20 other dependencies. However,
|
|
these objects are the only possible point where change could occur in the
|
|
context of configuration.
|
|
|
|
The solution is to introduce a special class of directives that influence the
|
|
*construction* of the Definition object. A standard call pattern would look
|
|
like:
|
|
|
|
1. Client calls Config->getHTMLDefinition()
|
|
2. Config calls HTMLDefinition->createNew(this)
|
|
3. HTMLDefinition constructs itself with base configuration
|
|
4. HTMLDefinition calls Config->get('HTMLDefinition')
|
|
5. Config returns array of directives that later construction
|
|
6. HTMLDefinition performs operations and changes specified by directives
|
|
7. HTMLPurifier returns constructed definition
|
|
8. Config caches definition so it doesn't have to be generated again
|
|
9. Config returns definition
|
|
|
|
You could also override Config's copy of the definition with your own
|
|
custom copy, which OVERRIDES all directives. Only the base, vanilla copy
|
|
is the Singleton, the object actually interfaced with is a operated-upon
|
|
clone of that object. Also, if an update to the directives would update
|
|
the definition, you'd have to force reconstruction.
|