$name
$name
Short unique string identifier of the module.
XHTML 1.1 Hypertext Module, defines hypertext links. Core Module.
$attr_collections
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.
$safe
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")
getChildDef(\HTMLPurifier_ElementDef $def) : \HTMLPurifier_ChildDef
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 |
subclass
addElement(string $element, string|bool $type, string|\HTMLPurifier_ChildDef $contents, array|string $attr_includes = array(), array $attr = array()) : \HTMLPurifier_ElementDef
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|\HTMLPurifier_ChildDef | $contents | Allowed children in form of: "$content_model_type: $content_model" |
| array|string | $attr_includes | What attribute collections to register to element? |
| array | $attr | What unique attributes does the element define? |
Created element definition object, so you can set advanced parameters
addElementToContentSet(string $element, string $type) : mixed
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) |
mergeInAttrIncludes(array $attr, array $attr_includes) : mixed
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 |