HTMLPurifier_Token_Comment Class Reference

Concrete comment token class. More...

Inheritance diagram for HTMLPurifier_Token_Comment:

Collaboration diagram for HTMLPurifier_Token_Comment:

Public Member Functions
	__construct ($data, $line=null, $col=null)
	Transparent constructor. More...
	toNode ()
	Converts a token into its corresponding node. More...
Public Member Functions inherited from HTMLPurifier_Token
	__get ($n)
	position ($l=null, $c=null)
	Sets the position of the token in the source document. More...
	rawPosition ($l, $c)
	Convenience function for DirectLex settings line/col position. More...
	toNode ()
	Converts a token into its corresponding node. More...

Data Fields
	$data
	Character data within comment. More...
	$is_whitespace = true
	@type bool More...
Data Fields inherited from HTMLPurifier_Token
	$line
	Line number node was on in source document. More...
	$col
	Column of line node was on in source document. More...
	$armor = array()
	Lookup array of processing that this token is exempt from. More...
	$skip
	Used during MakeWellFormed. More...
	$rewind
	@type More...
	$carryover
	@type More...

Detailed Description

Concrete comment token class.

Generally will be ignored.

Definition at line 6 of file Comment.php.

Constructor & Destructor Documentation

__construct()

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

Transparent constructor.

Parameters

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

Definition at line 26 of file Comment.php.

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

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

Member Function Documentation

toNode()

HTMLPurifier_Token_Comment::toNode

(

)

Converts a token into its corresponding node.

Reimplemented from HTMLPurifier_Token.

Definition at line 33 of file Comment.php.

                             {
        return new HTMLPurifier_Node_Comment($this->data, $this->line, $this->col);
    }

Field Documentation

$data

HTMLPurifier_Token_Comment::$data

Character data within comment.

@type string

Definition at line 12 of file Comment.php.

Referenced by __construct().

$is_whitespace

HTMLPurifier_Token_Comment::$is_whitespace = true

@type bool

Definition at line 17 of file Comment.php.

---

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

• Services/Html/HtmlPurifier/library/HTMLPurifier/Token/Comment.php