HTMLPurifier_HTMLModule Klassenreferenz

HTMLPurifier_HTMLModule Klassenreferenz
Klassendiagramm für HTMLPurifier_HTMLModule:

Öffentliche Methoden

 getChildDef ($def)
 
 addElement ($element, $type, $contents, $attr_includes=array(), $attr=array())
 
 addBlankElement ($element)
 
 addElementToContentSet ($element, $type)
 
 parseContents ($contents)
 
 mergeInAttrIncludes (&$attr, $attr_includes)
 
 makeLookup ($list)
 
 setup ($config)
 

Datenfelder

 $name
 
 $elements = array()
 
 $info = array()
 
 $content_sets = array()
 
 $attr_collections = array()
 
 $info_tag_transform = array()
 
 $info_attr_transform_pre = array()
 
 $info_attr_transform_post = array()
 
 $info_injector = array()
 
 $defines_child_def = false
 
 $safe = true
 

Ausführliche Beschreibung

Represents an XHTML 1.1 module, with information on elements, tags and attributes.

Zu beachten
Even though this is technically XHTML 1.1, it is also used for regular HTML parsing. We are using modulization as a convenient way to represent the internals of HTMLDefinition, and our implementation is by no means conforming and does not directly use the normative DTDs or XML schemas.
The public variables in a module should almost directly correspond to the variables in HTMLPurifier_HTMLDefinition. However, the prefix info carries no special meaning in these objects (include it anyway if that's the correspondence though).
Noch zu erledigen:
Consider making some member functions protected

Definiert in Zeile 18 der Datei HTMLModule.php.

Dokumentation der Elementfunktionen

addBlankElement (   $element)

Convenience function that creates a totally blank, non-standalone element.

Parameter
string$elementName of element to create
Rückgabe
HTMLPurifier_ElementDef Created element

Definiert in Zeile 174 der Datei HTMLModule.php.

Wird benutzt von HTMLPurifier_HTMLModule_Tidy\populate(), HTMLPurifier_HTMLModule_Name\setup(), HTMLPurifier_HTMLModule_Target\setup(), HTMLPurifier_HTMLModule_TargetBlank\setup(), HTMLPurifier_HTMLModule_Nofollow\setup() und HTMLPurifier_HTMLModule_Legacy\setup().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

addElement (   $element,
  $type,
  $contents,
  $attr_includes = array(),
  $attr = array() 
)

Convenience function that sets up a new element

Parameter
string$elementName of element to add
string | bool$typeWhat content set should element be registered to? Set as false to skip this step.
string$contentsAllowed children in form of: "$content_model_type: $content_model"
array$attr_includesWhat attribute collections to register to element?
array$attrWhat unique attributes does the element define?
Siehe auch
HTMLPurifier_ElementDef:: for in-depth descriptions of these parameters.
Rückgabe
HTMLPurifier_ElementDef Created element definition object, so you can set advanced parameters

Definiert in Zeile 144 der Datei HTMLModule.php.

Benutzt addElementToContentSet(), HTMLPurifier_ElementDef\create(), mergeInAttrIncludes() und parseContents().

Wird benutzt von HTMLPurifier_HTMLModule_SafeEmbed\setup(), HTMLPurifier_HTMLModule_Tables\setup(), HTMLPurifier_HTMLModule_Hypertext\setup(), HTMLPurifier_HTMLModule_SafeScripting\setup(), HTMLPurifier_HTMLModule_Proprietary\setup(), HTMLPurifier_HTMLModule_Ruby\setup(), HTMLPurifier_HTMLModule_Edit\setup(), HTMLPurifier_HTMLModule_Image\setup(), HTMLPurifier_HTMLModule_SafeObject\setup(), HTMLPurifier_HTMLModule_Object\setup(), HTMLPurifier_HTMLModule_Presentation\setup(), HTMLPurifier_HTMLModule_Bdo\setup(), HTMLPurifier_HTMLModule_Iframe\setup(), HTMLPurifier_HTMLModule_Legacy\setup(), HTMLPurifier_HTMLModule_Forms\setup(), HTMLPurifier_HTMLModule_List\setup() und HTMLPurifier_HTMLModule_Text\setup().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

addElementToContentSet (   $element,
  $type 
)

Convenience function that registers an element to a content set

Parameter
string$elementElement to register
string$typeName content set (warning: case sensitive, usually upper-case first letter)

Definiert in Zeile 192 der Datei HTMLModule.php.

Wird benutzt von addElement().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

getChildDef (   $def)

Retrieves a proper HTMLPurifier_ChildDef subclass based on content_model and content_model_type member variables of the HTMLPurifier_ElementDef class. There is a similar function in HTMLPurifier_HTMLDefinition.

Parameter
HTMLPurifier_ElementDef$def
Rückgabe
HTMLPurifier_ChildDef subclass

Definiert in Zeile 123 der Datei HTMLModule.php.

makeLookup (   $list)

Convenience function that generates a lookup table with boolean true as value.

Parameter
string$listList of values to turn into a lookup
Zu beachten
You can also pass an arbitrary number of arguments in place of the regular argument
Rückgabe
array array equivalent of list

Definiert in Zeile 258 der Datei HTMLModule.php.

Wird benutzt von HTMLPurifier_HTMLModule_Forms\setup() und HTMLPurifier_HTMLModule_Text\setup().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

mergeInAttrIncludes ( $attr,
  $attr_includes 
)

Convenience function that merges a list of attribute includes into an attribute array.

Parameter
array$attrReference to attr array to modify
array$attr_includesArray of includes / string include to merge in

Definiert in Zeile 238 der Datei HTMLModule.php.

Wird benutzt von addElement().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

parseContents (   $contents)

Convenience function that transforms single-string contents into separate content model and content model type

Parameter
string$contentsAllowed children in form of: "$content_model_type: $content_model"
Rückgabe
array
Zu beachten
If contents is an object, an array of two nulls will be returned, and the callee needs to take the original $contents and use it directly.

Definiert in Zeile 212 der Datei HTMLModule.php.

Wird benutzt von addElement().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

setup (   $config)

Lazy load construction of the module after determining whether or not it's needed, and also when a finalized configuration object is available.

Parameter
HTMLPurifier_Config$config

Definiert in Zeile 279 der Datei HTMLModule.php.

Dokumentation der Datenelemente

$attr_collections = array()

Associative array of attribute collection names to attribute collection additions. More rarely used for adding attributes to the global collections. Example is the StyleAttribute module adding the style attribute to the Core. Corresponds to HTMLDefinition's attr_collections->info, since the object's data is only info, with extra behavior associated with it. array

Definiert in Zeile 62 der Datei HTMLModule.php.

$content_sets = array()

Associative array of content set names to content set additions. This is commonly used to, say, add an A element to the Inline content set. This corresponds to an internal variable $content_sets and NOT info_content_sets member variable of HTMLDefinition. array

Definiert in Zeile 51 der Datei HTMLModule.php.

$defines_child_def = false

Boolean flag that indicates whether or not getChildDef is implemented. For optimization reasons: may save a call to a function. Be sure to set it if you do implement getChildDef(), otherwise it will have no effect! bool

Definiert in Zeile 98 der Datei HTMLModule.php.

$elements = array()

Informally, a list of elements this module changes. Not used in any significant way. array

Definiert in Zeile 34 der Datei HTMLModule.php.

Wird benutzt von HTMLPurifier_HTMLModule_Name\setup() und HTMLPurifier_HTMLModule_Target\setup().

$info = array()

Associative array of element names to element definitions. Some definitions may be incomplete, to be merged in later with the full definition. array

Definiert in Zeile 42 der Datei HTMLModule.php.

$info_attr_transform_post = array()

List of HTMLPurifier_AttrTransform to be performed after validation. array

Definiert in Zeile 80 der Datei HTMLModule.php.

$info_attr_transform_pre = array()

List of HTMLPurifier_AttrTransform to be performed before validation. array

Definiert in Zeile 74 der Datei HTMLModule.php.

$info_injector = array()

List of HTMLPurifier_Injector to be performed during well-formedness fixing. An injector will only be invoked if all of it's pre-requisites are met; if an injector fails setup, there will be no error; it will simply be silently disabled. array

Definiert in Zeile 89 der Datei HTMLModule.php.

$info_tag_transform = array()

Associative array of deprecated tag name to HTMLPurifier_TagTransform. array

Definiert in Zeile 68 der Datei HTMLModule.php.

$name

Short unique string identifier of the module. string

Definiert in Zeile 27 der Datei HTMLModule.php.

Wird benutzt von HTMLPurifier_HTMLModule_Tidy\getFixType(), HTMLPurifier_HTMLModule_Tidy\populate() und HTMLPurifier_HTMLModule_Tidy\setup().

$safe = true

Boolean flag whether or not this module is safe. If it is not safe, all of its members are unsafe. Modules are safe by default (this might be slightly dangerous, but it doesn't make much sense to force HTML Purifier, which is based off of safe HTML, to explicitly say, "This is safe," even though there are modules which are "unsafe")

bool

Zu beachten
Previously, safety could be applied at an element level granularity. We've removed this ability, so in order to add "unsafe" elements or attributes, a dedicated module with this property set to false must be used.

Definiert in Zeile 113 der Datei HTMLModule.php.


Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei:




Korrekturen, Hinweise und Ergänzungen

Bitte scheuen Sie sich nicht und melden Sie, was auf dieser Seite sachlich falsch oder irreführend ist, was ergänzt werden sollte, was fehlt usw. Dazu bitte oben aus dem Menü Seite den Eintrag Support Forum wählen. Es ist eine kostenlose Anmeldung erforderlich, um Anmerkungen zu posten. Unpassende Postings, Spam usw. werden kommentarlos entfernt.