Skip to content

classDocument

packages/sql-formatter/src/Core/Syntax/Document.php:15

final class Document

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

Tokens and grammar-derived layout marks, indexed in source order.

Properties§

public list<Token> $tokens = []

public array<int, int> $clauses = []

public array<int, true> $commas = []

public array<int, true> $logical = []

public array<int, true> $unary = []

public array<int, int> $pairs = []

public array<int, true> $blocks = []

public array<int, int> $casePairs = []

public array<int, true> $caseBranches = []

public string $trailing

Methods§

public function __construct(public string $trailing)

Retains trivia following the root node.

Parameters

$trailing string

public static function from(Node $tree, Rules $rules): self

Collects tokens and determines grammar and nesting boundaries.

Parameters

`$tree`	`Node`
`$rules`	`Rules`

Returns

self

Test cases 10

Called from 1

static-call SqlFormatter\Core\Formatter::format() packages/sql-formatter/src/Core/Formatter.php:40

Calls 4

Test cases 21§

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

Dedicated tests 1

DocumentTest::testFromDistinguishesFunctionAndProjectionCommas calls

Other tests reaching this symbol 20

SettingsTest calls
FormatterTest calls
BlockTest::testRenderFormatsNestedBlocks calls
ElementsTest::testWriteFormatsCaseBranches calls
HeadersTest::testLengthIncludesInterwordSpaces calls
HeadersTest::testWidthExcludesNestedQueryHeaders calls
HeadersTest::testWriteAlignsRiverHeader calls
RendererTest::testRenderExpandedPreservesSpelling calls
AnalyzerTest::testVisitKeepsTokensInSourceOrder calls
BracketsTest::testMarkPairsNestedParentheses calls
ExpressionsTest::testMarkDistinguishesRangeAndBooleanConjunctions calls
ExpressionsTest::testMarkRecordsCaseAndUnarySign calls
HeadersTest::testMarkDoesNotTreatIdentifierAsClause calls
HeadersTest::testMarkRecognizesLongestHeader calls
ListsTest::testMarkKeepsFunctionArgumentCommasInline calls
MarkersTest::testApplyPreservesBetweenConjunction calls
FormatterTest calls
DialectTest calls
DialectTest calls
DialectTest calls

Relations§

Static calls 1

static-call SqlFormatter\Core\Formatter::format() packages/sql-formatter/src/Core/Formatter.php:40

Type declarations 10