Inheritance diagram for HTMLPurifier_ChildDef_Optional:

Collaboration diagram for HTMLPurifier_ChildDef_Optional:

Public Member Functions
	validateChildren ($tokens_of_children, $config, $context)
Data Fields
	$allow_empty = true
	$type = 'optional'

Detailed Description

Definition that allows a set of elements, and allows no children.

Note:: This is a hack to reuse code from HTMLPurifier_ChildDef_Required, really, one shouldn't inherit from the other. Only altered behavior is to overload a returned false with an array. Thus, it will never return false.

Definition at line 10 of file Optional.php.

Member Function Documentation

Validates nodes according to definition and returns modification.

Parameters:

$tokens_of_children	Array of HTMLPurifier_Token
$config	HTMLPurifier_Config object
$context	HTMLPurifier_Context object

Returns:: bool true to leave nodes as is; bool false to remove parent node; array of replacement child tokens

Definition at line 14 of file Optional.php.

$allow_empty = true

Bool that 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.

Definition at line 12 of file Optional.php.

$type = 'optional'

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

Definition at line 13 of file Optional.php.

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