HTMLPurifier_Token Class Reference

Abstract base token class that all others inherit from. More...

Inheritance diagram for HTMLPurifier_Token:

Collaboration diagram for HTMLPurifier_Token:

Public Member Functions
	__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
	$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

Abstract base token class that all others inherit from.

Definition at line 6 of file Token.php.

Member Function Documentation

__get()

HTMLPurifier_Token::__get

(

$n

)

Parameters

string

$n

Returns

null|string

Definition at line 48 of file Token.php.

    {
        if ($n === 'type') {
            trigger_error('Deprecated type property called; use instanceof', E_USER_NOTICE);
            switch (get_class($this)) {
                case 'HTMLPurifier_Token_Start':
                    return 'start';
                case 'HTMLPurifier_Token_Empty':
                    return 'empty';
                case 'HTMLPurifier_Token_End':
                    return 'end';
                case 'HTMLPurifier_Token_Text':
                    return 'text';
                case 'HTMLPurifier_Token_Comment':
                    return 'comment';
                default:
                    return null;
            }
        }
    }

References $n.

position()

HTMLPurifier_Token::position	(		$l = null,
			$c = null
	)

Sets the position of the token in the source document.

Parameters

int	$l
int	$c

Definition at line 74 of file Token.php.

    {
        $this->line = $l;
        $this->col = $c;
    }

References $l.

rawPosition()

HTMLPurifier_Token::rawPosition	(		$l,
			$c
	)

Convenience function for DirectLex settings line/col position.

Parameters

int	$l
int	$c

Definition at line 85 of file Token.php.

    {
        if ($c === -1) {
            $l++;
        }
        $this->line = $l;
        $this->col = $c;
    }

References $l.

toNode()

HTMLPurifier_Token::toNode ( )

abstract

Converts a token into its corresponding node.

Reimplemented in HTMLPurifier_Token_Comment, HTMLPurifier_Token_Empty, HTMLPurifier_Token_End, HTMLPurifier_Token_Tag, and HTMLPurifier_Token_Text.

Field Documentation

$armor

HTMLPurifier_Token::$armor = array()

Lookup array of processing that this token is exempt from.

Currently, valid values are "ValidateAttributes" and "MakeWellFormed_TagClosedError" @type array

Definition at line 26 of file Token.php.

Referenced by HTMLPurifier_Token_Tag\__construct().

$carryover

HTMLPurifier_Token::$carryover

@type

Definition at line 42 of file Token.php.

$col

HTMLPurifier_Token::$col

Column of line node was on in source document.

Null if unknown. @type int

Definition at line 18 of file Token.php.

Referenced by HTMLPurifier_Token_Comment\__construct(), HTMLPurifier_Token_Text\__construct(), and HTMLPurifier_Token_Tag\__construct().

$line

HTMLPurifier_Token::$line

Line number node was on in source document.

Null if unknown. @type int

Definition at line 12 of file Token.php.

Referenced by HTMLPurifier_Token_Comment\__construct(), HTMLPurifier_Token_Text\__construct(), and HTMLPurifier_Token_Tag\__construct().

$rewind

HTMLPurifier_Token::$rewind

@type

Definition at line 37 of file Token.php.

$skip

HTMLPurifier_Token::$skip

Used during MakeWellFormed.

@type

Definition at line 32 of file Token.php.

---

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

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