Ö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 | |
Represents an XHTML 1.1 module, with information on elements, tags and attributes.
Definiert in Zeile 18 der Datei HTMLModule.php.
addBlankElement | ( | $element) |
Convenience function that creates a totally blank, non-standalone element.
string | $element | Name of element to create |
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().
addElement | ( | $element, | |
$type, | |||
$contents, | |||
$attr_includes = array() , |
|||
$attr = array() |
|||
) |
Convenience function that sets up a new element
string | $element | Name of element to add |
string | bool | $type | What content set should element be registered to? Set as false to skip this step. |
string | $contents | Allowed children in form of: "$content_model_type: $content_model" |
array | $attr_includes | What attribute collections to register to element? |
array | $attr | What unique attributes does the element define? |
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().
addElementToContentSet | ( | $element, | |
$type | |||
) |
Convenience function that registers an element to a content set
string | $element | Element to register |
string | $type | Name content set (warning: case sensitive, usually upper-case first letter) |
Definiert in Zeile 192 der Datei HTMLModule.php.
Wird benutzt von addElement().
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.
HTMLPurifier_ElementDef | $def |
Definiert in Zeile 123 der Datei HTMLModule.php.
makeLookup | ( | $list) |
Convenience function that generates a lookup table with boolean true as value.
string | $list | List of values to turn into a lookup |
Definiert in Zeile 258 der Datei HTMLModule.php.
Wird benutzt von HTMLPurifier_HTMLModule_Forms\setup() und HTMLPurifier_HTMLModule_Text\setup().
mergeInAttrIncludes | ( | & | $attr, |
$attr_includes | |||
) |
Convenience function that merges a list of attribute includes into an attribute array.
array | $attr | Reference to attr array to modify |
array | $attr_includes | Array of includes / string include to merge in |
Definiert in Zeile 238 der Datei HTMLModule.php.
Wird benutzt von addElement().
parseContents | ( | $contents) |
Convenience function that transforms single-string contents into separate content model and content model type
string | $contents | Allowed children in form of: "$content_model_type: $content_model" |
Definiert in Zeile 212 der Datei HTMLModule.php.
Wird benutzt von addElement().
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.
HTMLPurifier_Config | $config |
Definiert in Zeile 279 der Datei HTMLModule.php.
$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
Definiert in Zeile 113 der Datei HTMLModule.php.