HTMLPurifier_Node Class Reference

Abstract base node class that all others inherit from. More...

Inheritance diagram for HTMLPurifier_Node:

Collaboration diagram for HTMLPurifier_Node:

Public Member Functions
	toTokenPair ()
	Returns a pair of start and end tokens, where the end token is null if it is not necessary.

Data Fields
	$line
	Line number of the start token in the source document int.
	$col
	Column number of the start token in the source document.
	$armor = array()
	Lookup array of processing that this token is exempt from.
	$dead = false
	When true, this node should be ignored as non-existent.

Detailed Description

Abstract base node class that all others inherit from.

Why do we not use the DOM extension? (1) It is not always available, (2) it has funny constraints on the data it can represent, whereas we want a maximally flexible representation, and (3) its interface is a bit cumbersome.

Definition at line 11 of file Node.php.

Member Function Documentation

HTMLPurifier_Node::toTokenPair ( )

abstract

Returns a pair of start and end tokens, where the end token is null if it is not necessary.

Does not include children. array

Reimplemented in HTMLPurifier_Node_Text, HTMLPurifier_Node_Element, and HTMLPurifier_Node_Comment.

Field Documentation

HTMLPurifier_Node::$armor = array()

Lookup array of processing that this token is exempt from.

Currently, valid values are "ValidateAttributes". array

Definition at line 30 of file Node.php.

Referenced by HTMLPurifier_Node_Element\__construct().

HTMLPurifier_Node::$col

Column number of the start token in the source document.

Null if unknown. int

Definition at line 23 of file Node.php.

Referenced by HTMLPurifier_Node_Comment\__construct(), HTMLPurifier_Node_Element\__construct(), and HTMLPurifier_Node_Text\__construct().

HTMLPurifier_Node::$dead = false

When true, this node should be ignored as non-existent.

Who is responsible for ignoring dead nodes? FixNesting is responsible for removing them before passing on to child validators.

Definition at line 39 of file Node.php.

HTMLPurifier_Node::$line

Line number of the start token in the source document int.

Definition at line 17 of file Node.php.

Referenced by HTMLPurifier_Node_Comment\__construct(), HTMLPurifier_Node_Element\__construct(), and HTMLPurifier_Node_Text\__construct().

---

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

• Services/Html/HtmlPurifier/library/HTMLPurifier/Node.php