classFormatter

packages/sql-formatter/src/Core/Formatter.php:18

final class Formatter

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

Formats and verifies SQL using injected parsing and formatting contracts.

Methods§

public function __construct(
    private SqlParser $parser,
    private Dialect $dialect,
    private FormatOptions $options = new \SqlFormatter\Core\FormatOptions(),
)

source §

Reuses a configured parser and an immutable layout preset across calls.

Parameters

`$parser`	`SqlParser`
`$dialect`	`Dialect`
`$options`	`FormatOptions`

Calls 1

new FormatOptions line 26

public function format(string $sql): string

source §

Parameters

$sql string

Returns

string

Throws

SourceException When the input is not accepted by the selected grammar

FormattingException When output verification detects changed syntax

Test cases 3

Called from 1

method-call SqlFormatter\Facade\Formatter::format() packages/sql-formatter/src/Facade/Formatter.php:44

Calls 11

method-call SqlParser::parse() line 36
class-const Style::Compact() line 37
method-call Renderer::render() line 38
new Renderer line 38
method-call Dialect::compactRules() line 38
method-call Renderer::render() line 40
new Renderer line 40
static-call Document::from() line 40
method-call Dialect::syntaxRules() line 40
new FormattingException line 44
static-call Fingerprint::of() line 46

Private surface 3§

Implementation details, listed for orientation only.

private SqlParser $parser

private Dialect $dialect

private FormatOptions $options = new \SqlFormatter\Core\FormatOptions()

Test cases 37§

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

Dedicated tests 2

Other tests reaching this symbol 35

DocumentTest calls
GroupingTest calls
KeywordsTest calls
ReductionsTest calls
RendererTest calls
RulesTest calls
SettingsTest calls
ShapeTest calls
SpacingTest calls
TriviaTest calls
VisitorTest calls
DialectTest::testCompactRulesCanProvideAnIndependentGrammar calls
DialectTest::testSyntaxRulesCanProvideAnIndependentGrammar calls
FormatOptionsTest calls
FormattingExceptionTest calls
BlockTest calls
ElementsTest calls
HeadersTest calls
PolicyTest calls
RendererTest calls
SpacingTest calls
WriterTest calls
StyleTest calls
AnalyzerTest calls
BracketsTest calls
DocumentTest calls
ExpressionsTest calls
FingerprintTest calls
HeadersTest calls
ListsTest calls
MarkersTest calls
RulesTest calls
DialectTest calls
DialectTest calls
DialectTest calls

Relations§

Instantiated in 4

Method calls 1

method-call SqlFormatter\Facade\Formatter::format() packages/sql-formatter/src/Facade/Formatter.php:44

Type declarations 4