HTMLPurifier_Node_Comment Class Reference

Inheritance diagram for HTMLPurifier_Node_Comment:

Public Member Functions
	__construct ($data, $line=null, $col=null)
	Transparent constructor.
	toTokenPair ()
	Returns a pair of start and end tokens, where the end token is null if it is not necessary.

Public Attributes
	$armor = array()
	Lookup array of processing that this token is exempt from.
	$col
	Column number of the start token in the source document.
	$data
	Character data within comment.
	$dead = false
	When true, this node should be ignored as non-existent.
	$is_whitespace = true
	@type bool
	$line
	Line number of the start token in the source document @type int.

Constructor & Destructor Documentation

__construct()

HTMLPurifier_Node_Comment::__construct	(		$data,
			$line = null,
			$col = null )

Transparent constructor.

Parameters

string	$data	String comment data.
int	$line
int	$col

Member Function Documentation

toTokenPair()

HTMLPurifier_Node_Comment::toTokenPair

(

)

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

Does not include children. @type array

Reimplemented from HTMLPurifier_Node.

Member Data Documentation

$armor

HTMLPurifier_Node::$armor = array()

inherited

Lookup array of processing that this token is exempt from.

Currently, valid values are "ValidateAttributes". @type array

$col

HTMLPurifier_Node::$col

inherited

Column number of the start token in the source document.

Null if unknown. @type int

$data

HTMLPurifier_Node_Comment::$data

Character data within comment.

@type string

$dead

HTMLPurifier_Node::$dead = false

inherited

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.

---

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

• lib/htmlpurifier/HTMLPurifier/Node/Comment.php