classToken

packages/sql-parser/src/Lexer/Token.php:25

final class Token

Public API: explicitly declared with @visibility public.

One terminal as the lexer read it from the SQL text.

A token carries the whitespace and comments written before it, so a run of tokens spells the text it was read from, byte for byte. The end marker and other tokens a lexer synthesises have no text and stand at the offset where the lexer produced them, which is how the trivia before them still has an owner.

Reading a token's positiondoctest

$token = new \SqlParser\Lexer\Token(7, 'SELECT_SYM', 'SELECT', 0);
    $token->end() // => 6

Writing a token back as it was writtendoctest

$token = new \SqlParser\Lexer\Token(7, 'NUM', '1', 9, '   ');
    $token->toString() // => '   1'

Properties§

public int $symbol

source §

public string $name

source §

public string $text

source §

public int $offset

source §

public string $leading = ''

source §

Methods§

public function __construct(
    public int $symbol,
    public string $name,
    public string $text,
    public int $offset,
    public string $leading = '',
)

source §

Parameters

`$symbol`	`int`	Terminal number in the grammar's symbol table
`$name`	`string`	Terminal name as the grammar spells it
`$text`	`string`	Text as written in the SQL
`$offset`	`int`	Byte offset of the first character
`$leading`	`string`	Whitespace and comments written before the token