The PhpToken class

Introduction

(PHP 8)

This class provides an alternative to token_get_all(). While the function returns tokens either as a single-character string, or an array with a token ID, token text and line number, PhpToken::tokenize() normalizes all tokens into PhpToken objects, which makes code operating on tokens more memory efficient and readable.

Class synopsis

PhpToken {
/* Properties */
public int $id ;
public string $text ;
public int $line ;
public int $pos ;
/* Methods */
final public __construct ( int $id , string $text [, int $line = -1 [, int $pos = -1 ]] )
public getTokenName ( ) : string|null
public is ( int|string|array $kind ) : bool
public isIgnorable ( ) : bool
public __toString ( ) : string
public static tokenize ( string $code [, int $flags = 0 ] ) : array
}

Properties

id

One of the T_* constants, or an ASCII codepoint representing a single-char token.

text

The textual content of the token.

line

The starting line number (1-based) of the token.

pos

The starting position (0-based) in the tokenized string.

Table of Contents

© 1997–2020 The PHP Documentation Group
Licensed under the Creative Commons Attribution License v3.0 or later.
https://www.php.net/manual/en/class.phptoken.php