HTMLPurifier_Token_Text Class Reference

Concrete text token class. More...

Inheritance diagram for HTMLPurifier_Token_Text:

Collaboration diagram for HTMLPurifier_Token_Text:

Public Member Functions
	__construct ($data, $line=null, $col=null)
	Constructor, accepts data and determines if it is whitespace.
	toNode ()
	Converts a token into its corresponding node.
Public Member Functions inherited from HTMLPurifier_Token
	__get ($n)
	position ($l=null, $c=null)
	Sets the position of the token in the source document.
	rawPosition ($l, $c)
	Convenience function for DirectLex settings line/col position.

Data Fields
	$name = '#PCDATA'
	string
	$data
	string
	$is_whitespace
	bool
Data Fields inherited from HTMLPurifier_Token
	$line
	Line number node was on in source document.
	$col
	Column of line node was on in source document.
	$armor = array()
	Lookup array of processing that this token is exempt from.
	$skip
	Used during MakeWellFormed.
	$rewind
	$carryover

Detailed Description

Concrete text token class.

Text tokens comprise of regular parsed character data (PCDATA) and raw character data (from the CDATA sections). Internally, their data is parsed with all entities expanded. Surprisingly, the text token does have a "tag name" called #PCDATA, which is how the DTD represents it in permissible child nodes.

Definition at line 12 of file Text.php.

Constructor & Destructor Documentation

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

Constructor, accepts data and determines if it is whitespace.

Parameters

string	$data	String parsed character data.
int	$line
int	$col

Definition at line 40 of file Text.php.

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

    {
        $this->data = $data;
        $this->is_whitespace = ctype_space($data);
        $this->line = $line;
        $this->col = $col;
    }

Member Function Documentation

HTMLPurifier_Token_Text::toNode

(

)

Converts a token into its corresponding node.

Reimplemented from HTMLPurifier_Token.

Definition at line 48 of file Text.php.

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

Field Documentation

HTMLPurifier_Token_Text::$data

string

Parsed character data of text.

Definition at line 25 of file Text.php.

Referenced by __construct().

HTMLPurifier_Token_Text::$is_whitespace

bool

Bool indicating if node is whitespace.

Definition at line 32 of file Text.php.

HTMLPurifier_Token_Text::$name = '#PCDATA'

string

PCDATA tag name compatible with DTD.

Definition at line 18 of file Text.php.

---

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

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