< HTMLPurifier_ChildDef > Protocol Reference

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

List of all members.

Public Member Functions

 validateChildren ($tokens_of_children, $config, $context)
 Validates nodes according to definition and returns modification.
 validateChildren ($tokens_of_children, $config, $context)
 Validates nodes according to definition and returns modification.

Public Attributes

 $type
 Type of child definition, usually right-most part of class name lowercase.
 $allow_empty
 Bool that 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 tokens against it.

Definition at line 6 of file ChildDef.php.


Member Function Documentation

HTMLPurifier_ChildDef-p::validateChildren ( tokens_of_children,
config,
context 
) [abstract]

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

HTMLPurifier_ChildDef-p::validateChildren ( tokens_of_children,
config,
context 
) [abstract]

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


Member Data Documentation

HTMLPurifier_ChildDef-p::$type

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

Used occasionally in terms of context.

Definition at line 12 of file ChildDef.php.

HTMLPurifier_ChildDef-p::$allow_empty

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 20 of file ChildDef.php.

HTMLPurifier_ChildDef-p::$elements = array()

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

Definition at line 25 of file ChildDef.php.


The documentation for this protocol was generated from the following files:
Generated on Thu Jun 19 18:47:29 2008 for HTMLPurifier by  doxygen 1.5.3