classHeaderParser

packages/ztd-query-mysql/src/Sql/Cte/HeaderParser.php:17

final class HeaderParser

Restricted visibility: declared "@visibility ZtdQuery\Platform\MySql". Code outside that scope must not name this declaration.

Header Parser.

Methods§

public function __construct(private SqlLexerProfile $lexerProfile)

source §

Configure the dependencies used by this operation.

Parameters

$lexerProfile SqlLexerProfile

public function parseHeader(string $sql): array{names: list<string>, statementOffset: int|null}

source §

Parameters

$sql string

Returns

array{names: list<string>, statementOffset: int|null}

Test cases 1

HeaderParserTest::testParseHeaderExtractsNamesAndStatementOffset calls

Called from 4

Calls 6

method-call HeaderParser::topLevelTokens() line 30
method-call HeaderParser::identifierName() line 42
method-call HeaderParser::findAsIndex() line 48
function-call count line 49
method-call HeaderParser::isSymbol() line 60
function-call strtolower line 63

public function findAsIndex(list<SqlToken> $tokens, int $start): ?int

source §

Parameters

`$tokens`	`list<SqlToken>`
`$start`	`int`

Returns

?int

Test cases 1

HeaderParserTest::testFindAsIndexSkipsColumnListsAndStopsAtWords calls

Called from 1

method-call ZtdQuery\Platform\MySql\Sql\Cte\HeaderParser::parseHeader() packages/ztd-query-mysql/src/Sql/Cte/HeaderParser.php:48

Calls 1

class-const SqlTokenKind::Word() line 86

public function identifierName(SqlToken $token): ?string

source §

Identifier Name for the supplied MySQL input.

Parameters

$token SqlToken

Returns

?string

Test cases 1

HeaderParserTest::testIdentifierNameUnquotesNamesAndRejectsSymbols calls

Called from 2

Calls 5

class-const SqlTokenKind::Word() line 99
class-const SqlTokenKind::QuotedIdentifier() line 102
function-call strlen line 102
function-call substr line 107
function-call str_replace line 109

public function isSymbol(?SqlToken $token, string $symbol): bool

source §

Test a potentially absent delimiter token.

Parameters

`$token`	`?SqlToken`
`$symbol`	`string`

Returns

bool

Test cases 1

HeaderParserTest::testIsSymbolRequiresTheRequestedDelimiter calls

Called from 2

Calls 1

class-const SqlTokenKind::Symbol() line 116

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

source §

Parameters

$sql string

Returns

list<SqlToken>

Test cases 1

HeaderParserTest::testTopLevelTokensExcludeNestedBodies calls

Called from 1

method-call ZtdQuery\Platform\MySql\Sql\Cte\HeaderParser::parseHeader() packages/ztd-query-mysql/src/Sql/Cte/HeaderParser.php:30

Calls 1

static-call SqlTokenStream::tokenize() line 124

public function contents(
    string $sql,
    int $statementOffset,
): array{leading: string, recursive: bool, body: string}

source §

Split a validated WITH header into its original prefix and CTE definitions.

Parameters

`$sql`	`string`
`$statementOffset`	`int`

Returns

array{leading: string, recursive: bool, body: string}

Test cases 1

HeaderParserTest::testContentsPreservesRecursiveHeaders calls

Called from 2

Calls 3

static-call SqlTokenStream::tokenize() line 139
function-call substr line 145
function-call trim line 147

Private surface 1§

Implementation details, listed for orientation only.

private SqlLexerProfile $lexerProfile

Test cases 20§

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

Dedicated tests 6

Other tests reaching this symbol 14

Relations§

Instantiated in 6

Method calls 7