classVisitor

packages/sql-formatter/src/Core/Compact/Visitor.php:15

final class Visitor

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

Applies canonical spellings and optional grammar rules to a lossless syntax tree.

Methods§

public function __construct(
    private array<int, Token> $cleaned,
    private array<int, true> $protected,
    private array<int, true> $verbatim,
    private Settings $settings,
)

source §

Parameters

`$cleaned`	`array<int, Token>`	Tokens with ordinary trivia removed
`$protected`	`array<int, true>`	Tokens carrying directives or executable SQL
`$verbatim`	`array<int, true>`	Tokens inside executable comments
`$settings`	`Settings`

public function tokens(
    Node|Token $node,
    bool $identifier = false,
    ?Node $parent = null,
): list<Token>

source §

Parameters

`$node`	`Node\|Token`
`$identifier`	`bool`
`$parent`	`?Node`

Returns

list<Token>

Test cases 1

VisitorTest::testTokensPreservesIdentifierRolesAndExecutableBodies calls

Called from 2

Calls 3

new Token line 37
function-call array_push line 42
method-call Visitor::tokens() line 42

Private surface 4§

Implementation details, listed for orientation only.

private array<int, Token> $cleaned

private array<int, true> $protected

private array<int, true> $verbatim

private Settings $settings

Test cases 16§

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

Dedicated tests 1

VisitorTest::testTokensPreservesIdentifierRolesAndExecutableBodies calls

Other tests reaching this symbol 15

Relations§

Instantiated in 1

new SqlFormatter\Core\Compact\Document::__construct() packages/sql-formatter/src/Core/Compact/Document.php:55

Method calls 1

method-call SqlFormatter\Core\Compact\Document::__construct() packages/sql-formatter/src/Core/Compact/Document.php:55