classKeywords

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

final class Keywords

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

Normalizes terminals according to supplied identifier and keyword declarations.

Methods§

public function __construct(
    private list<string> $identifiers,
    private list<string> $verbatim,
    private array<string, string> $aliases,
    private ?string $fallbackRule = null,
    private list<string> $fallbackLiterals = [],
    private ?string $excludedParent = null,
)

source §

Parameters

`$identifiers`	`list<string>`	Rules that own identifiers
`$verbatim`	`list<string>`	Terminal kinds whose spelling must be preserved
`$aliases`	`array<string, string>`	Canonical spellings by terminal kind
`$fallbackRule`	`?string`
`$fallbackLiterals`	`list<string>`	Literal kinds excluded from identifier fallback
`$excludedParent`	`?string`

public function identifier(string $rule, ?Node $parent = null): bool

source §

Determines whether a rule owns an identifier in this context.

Parameters

`$rule`	`string`
`$parent`	`?Node`

Returns

bool

Calls 1

function-call in_array line 38

public function fallback(Token $token, ?Node $parent): bool

source §

Determines whether a terminal was accepted in an identifier fallback position.

Parameters

`$token`	`Token`
`$parent`	`?Node`

Returns

bool

Calls 2

function-call count line 46
function-call in_array line 47

public function text(Token $token, bool $identifier): string

source §

Canonicalizes known aliases while preserving names, literals, and directives.

Parameters

`$token`	`Token`
`$identifier`	`bool`

Returns

string

Calls 3

function-call in_array line 55
function-call preg_match line 58
function-call strtoupper line 61

Private surface 6§

Implementation details, listed for orientation only.

private list<string> $identifiers

private list<string> $verbatim

private array<string, string> $aliases

private ?string $fallbackRule = null

private list<string> $fallbackLiterals = []

private ?string $excludedParent = 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

KeywordsTest calls

Other tests reaching this symbol 16

DocumentTest calls
GroupingTest calls
ReductionsTest calls
RendererTest calls
RulesTest 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:23