Methods summary
public
|
|
public
|
#
registerModule( $module $module, $overload $overload = false )
Registers a module to the recognized module list, useful for overloading
pre-existing modules.
Registers a module to the recognized module list, useful for overloading
pre-existing modules.
Parameters
- $module
$module Mixed: string module name, with or without HTMLPurifier_HTMLModule prefix, or
instance of subclass of HTMLPurifier_HTMLModule.
- $overload
$overload Boolean whether or not to overload previous modules. If this is not set, and you
do overload a module, HTML Purifier will complain with a warning.
Note
This function will not call autoload, you must instantiate (and thus invoke)
autoload outside the method.
If a string is passed as a module name, different variants will be tested in
this order: - Check for HTMLPurifier_HTMLModule_$name - Check all prefixes with
$name in order they were added - Check for literal object name - Throw fatal
error If your object name collides with an internal class, specify your module
manually. All modules must have been included externally: registerModule will
not perform inclusions for you!
|
public
|
#
addModule( $module )
Adds a module to the current doctype by first registering it, and then
tacking it on to the active doctype
Adds a module to the current doctype by first registering it, and then
tacking it on to the active doctype
|
public
|
#
addPrefix( $prefix )
Adds a class prefix that registerModule() will use to resolve a string name
to a concrete class
Adds a class prefix that registerModule() will use to resolve a string name
to a concrete class
|
public
|
#
setup( $config $config )
Performs processing on modules, after being called you may use getElement()
and getElements()
Performs processing on modules, after being called you may use getElement()
and getElements()
Parameters
- $config
$config Instance of HTMLPurifier_Config
|
public
|
#
processModule( $module )
Takes a module and adds it to the active module collection, registering it if
necessary.
Takes a module and adds it to the active module collection, registering it if
necessary.
|
public
Array
|
#
getElements( )
Retrieves merged element definitions.
Retrieves merged element definitions.
Returns
Array of HTMLPurifier_ElementDef
|
public
Merged
|
#
getElement( $name $name, $trusted $trusted = null )
Retrieves a single merged element definition
Retrieves a single merged element definition
Parameters
- $name
$name Name of element
- $trusted
$trusted Boolean trusted overriding parameter: set to true if you want the full version
of an element
Returns
Merged HTMLPurifier_ElementDef
Note
You may notice that modules are getting iterated over twice (once in
getElements() and once here). This is because
|
Properties summary
public
|
$doctypes
|
|
#
Instance of HTMLPurifier_DoctypeRegistry
Instance of HTMLPurifier_DoctypeRegistry
|
public
|
$doctype
|
|
#
Instance of current doctype
Instance of current doctype
|
public
|
$attrTypes
|
|
#
Instance of HTMLPurifier_AttrTypes
Instance of HTMLPurifier_AttrTypes
|
public
array
|
$modules
|
array() |
#
Active instances of modules for the specified doctype are indexed, by name,
in this array.
Active instances of modules for the specified doctype are indexed, by name,
in this array.
|
public
array
|
$registeredModules
|
array() |
#
Array of recognized HTMLPurifier_Module instances, indexed by module's class
name. This array is usually lazy loaded, but a user can overload a module by
pre-emptively registering it.
Array of recognized HTMLPurifier_Module instances, indexed by module's class
name. This array is usually lazy loaded, but a user can overload a module by
pre-emptively registering it.
|
public
array
|
$userModules
|
array() |
#
List of extra modules that were added by the user using addModule(). These
get unconditionally merged into the current doctype, whatever it may be.
List of extra modules that were added by the user using addModule(). These
get unconditionally merged into the current doctype, whatever it may be.
|
public
array
|
$elementLookup
|
array() |
#
Associative array of element name to list of modules that have definitions
for the element; this array is dynamically filled.
Associative array of element name to list of modules that have definitions
for the element; this array is dynamically filled.
|
public
array
|
$prefixes
|
array('HTMLPurifier_HTMLModule_') |
#
List of prefixes we should use for registering small names
List of prefixes we should use for registering small names
|
public
|
$contentSets
|
|
|
public
|
$attrCollections
|
|
|
public
boolean
|
$trusted
|
false |
#
If set to true, unsafe elements and attributes will be allowed
If set to true, unsafe elements and attributes will be allowed
|