classPolicy

packages/sql-formatter/src/Core/Layout/Policy.php:15

final class Policy

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

Whitespace and alignment decisions for one nested block.

Properties§

public FormatOptions $options

source §

public int $base

source §

public int $width

source §

Methods§

public function __construct(public FormatOptions $options, public int $base, public int $width)

source §

Uses a width calculated from the headers in this block only.

Parameters

`$options`	`FormatOptions`
`$base`	`int`
`$width`	`int`

public function line(int $indent): string

source §

Starts a line at a column, or separates compact tokens.

Parameters

$indent int

Returns

string

Test cases 1

PolicyTest::testLineUsesRequestedColumn calls

Called from 7

Calls 1

function-call str_repeat line 29

public function beforeHeader(int $length): string

source §

Aligns the beginning of a header within this block.

Parameters

$length int

Returns

string

Test cases 1

PolicyTest::testBeforeHeaderAndBodyPlacement calls

Called from 2

Calls 3

method-call Policy::line() line 37
class-const Style::River() line 37
function-call max line 37

public function afterHeader(int $length): string

source §

Places the body below or beside its header.

Parameters

$length int

Returns

string

Test cases 2

Called from 2

Calls 8

class-const Style::Expanded() line 46
method-call Policy::line() line 46
method-call Policy::bodyIndent() line 46
class-const Style::Tabular() line 47
function-call str_repeat line 47
function-call max line 47
class-const Style::Compact() line 48
class-const Style::River() line 48

public function bodyIndent(): int

source §

Answers the column where list items continue.

Returns

int

Test cases 2

Called from 2

Calls 1

class-const Style::Expanded() line 57

Test cases 14§

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

Dedicated tests 4

Other tests reaching this symbol 10

SettingsTest calls
FormatterTest calls
BlockTest calls
ElementsTest calls
HeadersTest::testWriteAlignsRiverHeader calls
RendererTest calls
FormatterTest calls
DialectTest calls
DialectTest calls
DialectTest calls

Relations§

Instantiated in 1

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

Method calls 10

Type declarations 2