Property | Type | Description | |
---|---|---|---|
$attrCollections | |||
$attrTypes | |||
$contentSets | |||
$doctype | Instance of current doctype. | ||
$doctypes | |||
$elementLookup | Associative array of element name to list of modules that have definitions for the element; this array is dynamically filled. | ||
$modules | Active instances of modules for the specified doctype are indexed, by name, in this array. | ||
$prefixes | List of prefixes we should use for registering small names. | ||
$registeredModules | Array of recognized HTMLPurifier_HTMLModule 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. | ||
$trusted | If set to true, unsafe elements and attributes will be allowed. | ||
$userModules | List of extra modules that were added by the user using addModule(). These get unconditionally merged into the current doctype, whatever it may be. |
Method | Description | |
---|---|---|
__construct ( ) | ||
addModule ( $module ) | Adds a module to the current doctype by first registering it, and then tacking it on to the active doctype | |
addPrefix ( $prefix ) | Adds a class prefix that registerModule() will use to resolve a string name to a concrete class | |
getElement ( string $name, boolean $trusted = null ) : HTMLPurifier_ElementDef | Retrieves a single merged element definition | |
getElements ( ) : Array | Retrieves merged element definitions. | |
processModule ( $module ) | Takes a module and adds it to the active module collection, registering it if necessary. | |
registerModule ( $module, $overload = false ) | Registers a module to the recognized module list, useful for overloading pre-existing modules. | |
setup ( HTMLPurifier_Config $config ) | Performs processing on modules, after being called you may use getElement() and getElements() |
public addModule ( $module ) |
public addPrefix ( $prefix ) |
public getElement ( string $name, boolean $trusted = null ) : HTMLPurifier_ElementDef | ||
$name | string | Name of element |
$trusted | boolean | Boolean trusted overriding parameter: set to true if you want the full version of an element |
return | HTMLPurifier_ElementDef | Merged HTMLPurifier_ElementDef |
public getElements ( ) : Array | ||
return | Array | of HTMLPurifier_ElementDef |
public processModule ( $module ) |
public registerModule ( $module, $overload = false ) | ||
$module | Mixed: string module name, with or without HTMLPurifier_HTMLModule prefix, or instance of subclass of HTMLPurifier_HTMLModule. | |
$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. |
public setup ( HTMLPurifier_Config $config ) | ||
$config | HTMLPurifier_Config |
public $elementLookup |
public $modules |
public $prefixes |
public $registeredModules |
public $trusted |