API - XOOPS 2.5.11 Beta 2
By monxoops.fr
|
Public Member Functions | |
addAttribute ($element_name, $attr_name, $def) | |
addElement ($element_name, $type, $contents, $attr_collections, $attributes=array()) | |
addBlankElement ($element_name) | |
getAnonymousModule () | |
__construct () | |
parseTinyMCEAllowedList ($list) | |
Public Member Functions inherited from HTMLPurifier_Definition | |
setup ($config) | |
Data Fields | |
$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 | |
Data Fields inherited from HTMLPurifier_Definition | |
$setup = false | |
$optimized = null | |
$type | |
Protected Member Functions | |
doSetup ($config) | |
processModules ($config) | |
setupConfigStuff ($config) | |
doSetup ($config) | |
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.
__construct | ( | ) |
Performs low-cost, preliminary initialization.
addAttribute | ( | $element_name, | |
$attr_name, | |||
$def | |||
) |
Adds a custom attribute to a pre-existing element
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 |
addBlankElement | ( | $element_name | ) |
Adds a blank element to your HTML definition, for overriding existing behavior
string | $element_name |
addElement | ( | $element_name, | |
$type, | |||
$contents, | |||
$attr_collections, | |||
$attributes = array() |
|||
) |
Adds a custom element to your HTML definition
|
protected |
HTMLPurifier_Config | $config |
Reimplemented from HTMLPurifier_Definition.
getAnonymousModule | ( | ) |
Retrieves a reference to the anonymous module, so you can bust out advanced features without having to make your own module.
parseTinyMCEAllowedList | ( | $list | ) |
Parses a TinyMCE-flavored Allowed Elements and Attributes list into separate lists for processing. Format is element[attr1|attr2],element2...
array | $list | String list to parse |
|
protected |
Extract out the information from the manager
HTMLPurifier_Config | $config |
|
protected |
Sets up stuff based on config. We need a better way of doing this.
HTMLPurifier_Config | $config |
$doctype |
Doctype object @type HTMLPurifier_Doctype
$info = array() |
Associative array of element names to HTMLPurifier_ElementDef. @type HTMLPurifier_ElementDef[]
$info_attr_transform_post = array() |
Indexed list of HTMLPurifier_AttrTransform to be performed after validation. @type HTMLPurifier_AttrTransform[]
$info_attr_transform_pre = array() |
Indexed list of HTMLPurifier_AttrTransform to be performed before validation. @type HTMLPurifier_AttrTransform[]
$info_block_wrapper = 'p' |
String name of element used to wrap inline elements in block context. @type string
$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 = array() |
Associative array of global attribute name to attribute definition. @type array
$info_injector = array() |
Indexed list of HTMLPurifier_Injector to be used. @type HTMLPurifier_Injector[]
$info_parent = 'div' |
String name of parent element HTML will be going into. @type string
$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 = array() |
Associative array of deprecated tag name to HTMLPurifier_TagTransform. @type array
$manager |
$type = 'HTML' |
@type string