\HTMLPurifier_Node_Comment

Concrete comment node class.

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.

Summary

Methods
Properties
Constants
toTokenPair()
__construct()
$line
$col
$armor
$dead
$data
$is_whitespace
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Properties

$line

$line : 

Line number of the start token in the source document

Type

$col

$col : 

Column number of the start token in the source document. Null if unknown.

Type

$armor

$armor : 

Lookup array of processing that this token is exempt from.

Currently, valid values are "ValidateAttributes".

Type

$dead

$dead : 

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.

Type

$data

$data : 

Character data within comment.

Type

$is_whitespace

$is_whitespace : 

Type

Methods

toTokenPair()

toTokenPair() 

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

__construct()

__construct(string  $data, integer  $line = null, integer  $col = null) 

Transparent constructor.

Parameters

string $data

String comment data.

integer $line
integer $col