classSqlLexer

packages/sql-catalog/src/Core/Sql/SqlLexer.php:16

final class SqlLexer

Restricted visibility: declared "@visibility root". Code outside that scope must not name this declaration.

Splits SQL into tokens without committing to one dialect's grammar.

Only enough structure is recognised to tell keywords, string bodies, comments and bind parameters apart, which is what reading a statement's kind, its tables and its placeholders needs. Anything unrecognised becomes a symbol.

Methods§

public function tokenize(string $sql): list<SqlToken>

source §

The tokens of a statement, in order.

Parameters

$sql string

Returns

list<SqlToken>

Test cases 7

Called from 3

Calls 6

function-call strlen line 28
function-call ctype_space line 34
function-call max line 39
new SqlToken line 40
class-const SqlTokenKind::Symbol() line 40
method-call SqlLexer::readToken() line 45

public function readToken(string $sql, int $offset, int $depth): SqlToken

source §

The token starting at the given offset.

Parameters

`$sql`	`string`
`$offset`	`int`
`$depth`	`int`

Returns

SqlToken

Test cases 1

SqlLexerTest::testReadToken calls

Called from 1

method-call SqlCatalog\Core\Sql\SqlLexer::tokenize() packages/sql-catalog/src/Core/Sql/SqlLexer.php:45

Calls 12

method-call SqlLexer::readComment() line 58
new SqlToken line 60
class-const SqlTokenKind::Comment() line 60
method-call SqlLexer::readQuoted() line 63
class-const SqlTokenKind::Text() line 65
class-const SqlTokenKind::Identifier() line 65
class-const SqlTokenKind::Symbol() line 71
method-call SqlLexer::readParameter() line 74
class-const SqlTokenKind::Parameter() line 76
function-call preg_match line 79
class-const SqlTokenKind::Number() line 80
class-const SqlTokenKind::Word() line 83

public function readComment(string $sql, int $offset): ?string

source §

The comment starting at the offset, or null when none starts there.

Parameters

`$sql`	`string`
`$offset`	`int`

Returns

?string

Test cases 1

SqlLexerTest::testReadCommentRecognisesEveryCommentSyntax calls

Called from 1

method-call SqlCatalog\Core\Sql\SqlLexer::readToken() packages/sql-catalog/src/Core/Sql/SqlLexer.php:58

Calls 1

function-call preg_match line 94

public function readQuoted(string $sql, int $offset): ?string

source §

The quoted run starting at the offset, or null when none starts there.

Parameters

`$sql`	`string`
`$offset`	`int`

Returns

?string

Test cases 2

Called from 1

method-call SqlCatalog\Core\Sql\SqlLexer::readToken() packages/sql-catalog/src/Core/Sql/SqlLexer.php:63

Calls 3

class-const SqlLexer::QUOTES() line 110
function-call strlen line 115
function-call substr line 126

public function readParameter(string $sql, int $offset): ?string

source §

The bind parameter starting at the offset, or null when none starts there.

Parameters

`$sql`	`string`
`$offset`	`int`

Returns

?string

Test cases 1

SqlLexerTest::testReadParameterRecognisesEveryParameterSyntax calls

Called from 1

method-call SqlCatalog\Core\Sql\SqlLexer::readToken() packages/sql-catalog/src/Core/Sql/SqlLexer.php:74

Calls 1

function-call preg_match line 142

Private surface 1§

Implementation details, listed for orientation only.

private const QUOTES = ["'" => "'", '"' => '"', '`' => '`', '[' => ']']

Test cases 20§

Test cases that cover or call this symbol, from the coverage report and from the analyzed test sources.

Dedicated tests 9

Other tests reaching this symbol 11

CatalogCommandTest calls
EntryFactoryTest calls
ExpressionEvaluatorTest calls
PlaceholderScannerTest calls
StatementKindReaderTest::testReadAfterCommonTableIgnoresNestedKeywords calls
TableReaderTest::testReadNameIsNullWhenNothingNamesATable calls
TableReaderTest::testReadNameStopsAtATrailingSeparator calls
CallModelTest calls
AnalyzerTest calls
JsonReporterTest calls
TextReporterTest calls

Relations§

Instantiated in 3

Method calls 3

Type declarations 6