classRules

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

final class Rules

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

Recognizes optional syntax by its grammar owner rather than neighboring words.

Methods§

public function __construct(
    private array<string, list<list<string>>> $defaults,
    private list<string> $joins,
    private array<string, string> $distinctParents,
    private ?string $selectOptions = null,
    private ?string $strictJoin = null,
)

source §

Parameters

`$defaults`	`array<string, list<list<string>>>`	Optional spellings by grammar rule
`$joins`	`list<string>`	Grammar rules that own join modifiers
`$distinctParents`	`array<string, string>`	Distinct quantifiers eligible under a parent
`$selectOptions`	`?string`
`$strictJoin`	`?string`

public function apply(Node $node, list<Token> $tokens, ?Node $parent): list<Token>

source §

Removes defaults only from the rules in which omission has the same meaning.

Parameters

`$node`	`Node`
`$tokens`	`list<Token>`
`$parent`	`?Node`

Returns

list<Token>

Calls 8

function-call array_map line 39
function-call strtoupper line 39
method-call Rules::default() line 40
function-call in_array line 43
function-call array_values line 44
function-call array_filter line 44
function-call preg_match line 47
function-call implode line 47

public function default(string $rule, list<string> $words, ?Node $parent): bool

source §

Parameters

`$rule`	`string`
`$words`	`list<string>`
`$parent`	`?Node`

Returns

bool

Called from 1

method-call SqlFormatter\Core\Compact\Rules::apply() packages/sql-formatter/src/Core/Compact/Rules.php:40

Calls 1

function-call in_array line 59

Private surface 5§

Implementation details, listed for orientation only.

private array<string, list<list<string>>> $defaults

private list<string> $joins

private array<string, string> $distinctParents

private ?string $selectOptions = null

private ?string $strictJoin = null

Test cases 17§

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

Dedicated tests 1

RulesTest calls

Other tests reaching this symbol 16

DocumentTest calls
GroupingTest calls
KeywordsTest calls
ReductionsTest calls
RendererTest calls
SettingsTest::testInjectedSeparatorPrecedesLexerProbing calls
ShapeTest calls
SpacingTest calls
TriviaTest calls
VisitorTest calls
DialectTest::testCompactRulesCanProvideAnIndependentGrammar calls
FormatterTest calls
FormatterTest calls
DialectTest calls
DialectTest calls
DialectTest calls

Relations§

Instantiated in 3

Type declarations 1

type SqlFormatter\Core\Compact\Settings packages/sql-formatter/src/Core/Compact/Settings.php:24