Defines allowed child nodes and validates nodes against it. More...

Inheritance diagram for HTMLPurifier_ChildDef:

Collaboration diagram for HTMLPurifier_ChildDef:

Public Member Functions
	getAllowedElements ($config)
	Get lookup of tag names that should not close this element automatically.
	validateChildren ($children, $config, $context)
	Validates nodes according to definition and returns modification.

Data Fields
	$type
	Type of child definition, usually right-most part of class name lowercase.
	$allow_empty
	Indicates whether or not an empty array of children is okay.
	$elements = array()
	Lookup array of all elements that this definition could possibly allow.

Detailed Description

Defines allowed child nodes and validates nodes against it.

Definition at line 6 of file ChildDef.php.

Member Function Documentation

HTMLPurifier_ChildDef::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

Definition at line 36 of file ChildDef.php.

References $elements.

    {
        return $this->elements;
    }

HTMLPurifier_ChildDef::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

HTMLPurifier_ChildDef::$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. bool

Definition at line 22 of file ChildDef.php.

HTMLPurifier_ChildDef::$elements = array()

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

array

Definition at line 28 of file ChildDef.php.

HTMLPurifier_ChildDef::$type

Type of child definition, usually right-most part of class name lowercase.

Used occasionally in terms of context. string

Definition at line 13 of file ChildDef.php.

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