HTMLPurifier_ChildDef Class Reference

Inheritance diagram for HTMLPurifier_ChildDef:

Public Member Functions
	getAllowedElements ($config)
	validateChildren ($children, $config, $context)

Data Fields
	$type
	$allow_empty
	$elements = array()

Detailed Description

Defines allowed child nodes and validates nodes against it.

Member Function Documentation

getAllowedElements()

getAllowedElements

(

$config

)

Get lookup of tag names that should not close this element automatically. All other elements will do so.

Parameters

HTMLPurifier_Config

$config

HTMLPurifier_Config object

Returns

array

Reimplemented in HTMLPurifier_ChildDef_StrictBlockquote.

validateChildren()

validateChildren (   $children,   $config,   $context  )

abstract

Validates nodes according to definition and returns modification.

Parameters

HTMLPurifier_Node[]	$children	Array of HTMLPurifier_Node
HTMLPurifier_Config	$config	HTMLPurifier_Config object
HTMLPurifier_Context	$context	HTMLPurifier_Context object

Returns

bool|array true to leave nodes as is, false to remove parent node, array of replacement children

Reimplemented in HTMLPurifier_ChildDef_Chameleon, HTMLPurifier_ChildDef_Custom, HTMLPurifier_ChildDef_Empty, HTMLPurifier_ChildDef_List, HTMLPurifier_ChildDef_Optional, HTMLPurifier_ChildDef_Required, HTMLPurifier_ChildDef_StrictBlockquote, and HTMLPurifier_ChildDef_Table.

Field Documentation

$allow_empty

$allow_empty

Indicates whether or not an empty array of children is okay.

This is necessary for redundant checking when changes affecting a child node may cause a parent node to now be disallowed. @type bool

$elements

$elements = array()

Lookup array of all elements that this definition could possibly allow. @type array

$type

$type

Type of child definition, usually right-most part of class name lowercase. Used occasionally in terms of context. @type string

---

The documentation for this class was generated from the following file:

• C:/xoops2511b2/htdocs/xoops_lib/modules/protector/library/HTMLPurifier/ChildDef.php