The PhpToken class

(PHP 8)

Introduction

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

classPhpTokenimplementsStringable {

publicint$id;

publicstring$text;

publicint$line;

publicint$pos;

finalpublic__construct(
    int$id,
    string$text,
    int$line = -1,
    int$pos = -1
)

publicgetTokenName(): ?string

publicis(int|string|array$kind): bool

publicisIgnorable(): bool

public__toString(): string

publicstatictokenize(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 (the number of bytes).

PhpToken::__construct — Returns a new PhpToken object
PhpToken::getTokenName — Returns the name of the token.
PhpToken::is — Tells whether the token is of given kind.
PhpToken::isIgnorable — Tells whether the token would be ignored by the PHP parser.
PhpToken::__toString — Returns the textual content of the token.
PhpToken::tokenize — Splits given source into PHP tokens, represented by PhpToken objects.

The PhpToken class

Introduction

Class synopsis

Properties

Table of Contents