ILIAS  Release_5_0_x_branch Revision 61816
 All Data Structures Namespaces Files Functions Variables Groups Pages
HTMLPurifier_Node_Comment Class Reference

Concrete comment node class. More...

+ Inheritance diagram for HTMLPurifier_Node_Comment:
+ Collaboration 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.

Data Fields

 $data
 Character data within comment.
 $is_whitespace = true
 bool
- Data Fields inherited from HTMLPurifier_Node
 $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

Concrete comment node class.

Definition at line 6 of file Comment.php.

Constructor & Destructor Documentation

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

Transparent constructor.

Parameters
string$dataString comment data.
int$line
int$col

Definition at line 26 of file Comment.php.

References HTMLPurifier_Node\$col, $data, and HTMLPurifier_Node\$line.

{
$this->data = $data;
$this->line = $line;
$this->col = $col;
}

Member Function Documentation

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. array

Reimplemented from HTMLPurifier_Node.

Definition at line 33 of file Comment.php.

{
return array(new HTMLPurifier_Token_Comment($this->data, $this->line, $this->col), null);
}

Field Documentation

HTMLPurifier_Node_Comment::$data

Character data within comment.

string

Definition at line 12 of file Comment.php.

Referenced by __construct().

HTMLPurifier_Node_Comment::$is_whitespace = true

bool

Definition at line 17 of file Comment.php.


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