classHeaders

packages/sql-formatter/src/Core/Layout/Headers.php:14

final class Headers

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

Measures and emits headers without looking inside nested query blocks.

Methods§

public function __construct(private Document $document)

source §

Reads annotations from the concrete syntax tree.

Parameters

$document Document

public function width(int $start, int $end): int

source §

Finds the widest header at this parenthesis level.

Parameters

`$start`	`int`
`$end`	`int`

Returns

int

Test cases 1

HeadersTest::testWidthExcludesNestedQueryHeaders calls

Called from 1

method-call SqlFormatter\Core\Layout\Block::render() packages/sql-formatter/src/Core/Layout/Block.php:30

Calls 2

function-call max line 37
method-call Headers::length() line 37

public function length(int $start, int $end): int

source §

Measures a header with one space between its words.

Parameters

`$start`	`int`
`$end`	`int`

Returns

int

Test cases 1

HeadersTest::testLengthIncludesInterwordSpaces calls

Called from 3

Calls 1

function-call strlen line 50

public function write(Writer $writer, int $start, int $end, Policy $policy): void

source §

Emits a complete multiword header, keeping interleaved comments.

Parameters

`$writer`	`Writer`
`$start`	`int`
`$end`	`int`
`$policy`	`Policy`

Test cases 1

HeadersTest::testWriteAlignsRiverHeader calls

Called from 1

method-call SqlFormatter\Core\Layout\Block::render() packages/sql-formatter/src/Core/Layout/Block.php:37

Calls 3

method-call Writer::token() line 61
method-call Policy::beforeHeader() line 61
method-call Headers::length() line 61

Private surface 1§

Implementation details, listed for orientation only.

private Document $document

Test cases 12§

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

Dedicated tests 3

Other tests reaching this symbol 9

Relations§

Instantiated in 1

new SqlFormatter\Core\Layout\Block::render() packages/sql-formatter/src/Core/Layout/Block.php:29

Method calls 3