Référence de la classe HTMLPurifier_HTMLDefinition

Graphe d'héritage de HTMLPurifier_HTMLDefinition:

Graphe de collaboration de HTMLPurifier_HTMLDefinition:

Fonctions membres publiques
	addAttribute ($element_name, $attr_name, $def)
	addElement ($element_name, $type, $contents, $attr_collections, $attributes=array())
	addBlankElement ($element_name)
	getAnonymousModule ()
	__construct ()
	parseTinyMCEAllowedList ($list)
Fonctions membres publiques hérités de HTMLPurifier_Definition
	setup ($config)

Champs de données
	$info = array()
	$info_global_attr = array()
	$info_parent = 'div'
	$info_parent_def
	$info_block_wrapper = 'p'
	$info_tag_transform = array()
	$info_attr_transform_pre = array()
	$info_attr_transform_post = array()
	$info_content_sets = array()
	$info_injector = array()
	$doctype
	$type = 'HTML'
	$manager
Champs de données hérités de HTMLPurifier_Definition
	$setup = false
	$optimized = null
	$type

Fonctions membres protégées
	doSetup ($config)
	processModules ($config)
	setupConfigStuff ($config)

Attributs privés
	$_anonModule = null

Description détaillée

Definition of the purified HTML that describes allowed children, attributes, and many other things.

Conventions:

All member variables that are prefixed with info (including the main $info array) are used by HTML Purifier internals and should not be directly edited when customizing the HTMLDefinition. They can usually be set via configuration directives or custom modules.

On the other hand, member variables without the info prefix are used internally by the HTMLDefinition and MUST NOT be used by other HTML Purifier internals. Many of them, however, are public, and may be edited by userspace code to tweak the behavior of HTMLDefinition.

Note

This class is inspected by Printer_HTMLDefinition; please update that class if things here change.

Avertissement

Directives that change this object's structure must be in the HTML or Attr namespace!

Documentation des constructeurs et destructeur

__construct()

__construct

(

)

Performs low-cost, preliminary initialization.

Documentation des fonctions membres

addAttribute()

addAttribute	(		$element_name,
			$attr_name,
			$def
	)

Adds a custom attribute to a pre-existing element

Note

This is strictly convenience, and does not have a corresponding method in HTMLPurifier_HTMLModule

Paramètres

string	$element_name	Element name to add attribute to
string	$attr_name	Name of attribute
mixed	$def	Attribute definition, can be string or object, see HTMLPurifier_AttrTypes for details

Voici le graphe d'appel pour cette fonction :

addBlankElement()

addBlankElement

(

$element_name

)

Adds a blank element to your HTML definition, for overriding existing behavior

Paramètres

string

$element_name

Renvoie

HTMLPurifier_ElementDef

Voir également

HTMLPurifier_HTMLModule::addBlankElement() for detailed parameter and return value descriptions.

Voici le graphe d'appel pour cette fonction :

addElement()

addElement	(		$element_name,
			$type,
			$contents,
			$attr_collections,
			$attributes = array()
	)

Adds a custom element to your HTML definition

Voir également

HTMLPurifier_HTMLModule::addElement() for detailed parameter and return value descriptions.

Voici le graphe d'appel pour cette fonction :

doSetup()

doSetup (   $config )

protected

Paramètres

HTMLPurifier_Config

$config

Réimplémentée à partir de HTMLPurifier_Definition.

Voici le graphe d'appel pour cette fonction :

getAnonymousModule()

getAnonymousModule

(

)

Retrieves a reference to the anonymous module, so you can bust out advanced features without having to make your own module.

Renvoie

HTMLPurifier_HTMLModule

Voici le graphe des appelants de cette fonction :

parseTinyMCEAllowedList()

parseTinyMCEAllowedList

(

$list

)

Parses a TinyMCE-flavored Allowed Elements and Attributes list into separate lists for processing. Format is element[attr1|attr2],element2...

Avertissement

Although it's largely drawn from TinyMCE's implementation, it is different, and you'll probably have to modify your lists

Paramètres

array

$list

String list to parse

Renvoie

array

A faire:

Give this its own class, probably static interface

Voici le graphe des appelants de cette fonction :

processModules()

processModules (   $config )

protected

Extract out the information from the manager

Paramètres

HTMLPurifier_Config

$config

Voici le graphe des appelants de cette fonction :

setupConfigStuff()

setupConfigStuff (   $config )

protected

Sets up stuff based on config. We need a better way of doing this.

Paramètres

HTMLPurifier_Config

$config

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

Documentation des champs

$_anonModule

$_anonModule = null

private

$doctype

$doctype

Doctype object @type HTMLPurifier_Doctype

$info

$info = array()

Associative array of element names to HTMLPurifier_ElementDef. @type HTMLPurifier_ElementDef[]

$info_attr_transform_post

$info_attr_transform_post = array()

Indexed list of HTMLPurifier_AttrTransform to be performed after validation. @type HTMLPurifier_AttrTransform[]

$info_attr_transform_pre

$info_attr_transform_pre = array()

Indexed list of HTMLPurifier_AttrTransform to be performed before validation. @type HTMLPurifier_AttrTransform[]

$info_block_wrapper

$info_block_wrapper = 'p'

String name of element used to wrap inline elements in block context. @type string

Note

This is rarely used except for BLOCKQUOTEs in strict mode

$info_content_sets

$info_content_sets = array()

Nested lookup array of content set name (Block, Inline) to element name to whether or not it belongs in that content set. @type array

$info_global_attr

$info_global_attr = array()

Associative array of global attribute name to attribute definition. @type array

$info_injector

$info_injector = array()

Indexed list of HTMLPurifier_Injector to be used. @type HTMLPurifier_Injector[]

$info_parent

$info_parent = 'div'

String name of parent element HTML will be going into. @type string

$info_parent_def

$info_parent_def

Definition for parent element, allows parent element to be a tag that's not allowed inside the HTML fragment. @type HTMLPurifier_ElementDef

$info_tag_transform

$info_tag_transform = array()

Associative array of deprecated tag name to HTMLPurifier_TagTransform. @type array

$manager

$manager

@type HTMLPurifier_HTMLModuleManager

$type

$type = 'HTML'

@type string

---

La documentation de cette classe a été générée à partir du fichier suivant :

• XoopsCore25-2.5.11-Beta1/htdocs/xoops_lib/modules/protector/library/HTMLPurifier/HTMLDefinition.php