PHP Class HTMLPurifier_HTMLModuleManager, yii

ファイルを表示 Open project: yiisoft/yii Class Usage Examples

Public Properties

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.

Public Methods

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()

Method Details

__construct() public method

public __construct ( )

addModule() public method

Adds a module to the current doctype by first registering it, and then tacking it on to the active doctype

public addModule ( $module )

addPrefix() public method

Adds a class prefix that registerModule() will use to resolve a string name to a concrete class

public addPrefix ( $prefix )

getElement() public method

Retrieves a single merged element definition

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

getElements() public method

Retrieves merged element definitions.

public getElements ( ) : Array
return	Array	of HTMLPurifier_ElementDef

processModule() public method

Takes a module and adds it to the active module collection, registering it if necessary.

public processModule ( $module )

registerModule() public method

Registers a module to the recognized module list, useful for overloading pre-existing modules.

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.

setup() public method

Performs processing on modules, after being called you may use getElement() and getElements()

public setup ( HTMLPurifier_Config $config )
$config	HTMLPurifier_Config

Property Details

$attrCollections public_oe property

public $attrCollections

$attrTypes public_oe property

public $attrTypes

$contentSets public_oe property

public $contentSets

$doctype public_oe property

Instance of current doctype.

public $doctype

$doctypes public_oe property

public $doctypes

$elementLookup public_oe property

Associative array of element name to list of modules that have definitions for the element; this array is dynamically filled.

public $elementLookup

$modules public_oe property

Active instances of modules for the specified doctype are indexed, by name, in this array.

public $modules

$prefixes public_oe property

List of prefixes we should use for registering small names.

public $prefixes

$registeredModules public_oe property

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.

public $registeredModules

$trusted public_oe property

If set to true, unsafe elements and attributes will be allowed.

public $trusted

$userModules public_oe property

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 $userModules