classTextPattern

packages/sql-catalog/src/Core/Text/TextPattern.php:16

final class TextPattern

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

A string the analyzer knows in part: resolved runs of text with gaps between them.

A pattern with no gaps is an exact string. One with gaps describes the shape of every string the expression can produce, which is what the catalog reports when a query is assembled from values that are not statically known.

Properties§

public list<TextSegment> $segments

source §

Methods§

public static function empty(): self

source §

The empty pattern, which concatenation leaves unchanged.

Returns

self

Test cases 4

Called from 1

static-call SqlCatalog\Core\Text\TextGeneralization::mergeAll() packages/sql-catalog/src/Core/Text/TextGeneralization.php:100

Calls 1

new self line 30

public static function fromText(string $text): self

source §

A pattern that resolves to exactly the given characters.

Parameters

$text string

Returns

self

Test cases 262

Called from 1

static-call SqlCatalog\Core\Evaluation\LiteralTerm::toPattern() packages/sql-catalog/src/Core/Evaluation/LiteralTerm.php:33

Calls 2

new self line 38
new LiteralText line 38

public static function fromHole(TextHole $hole): self

source §

A pattern consisting of one unresolved gap.

Parameters

$hole TextHole

Returns

self

Test cases 69

Called from 4

Calls 1

new self line 46

public static function fromSegments(list<TextSegment> $segments): self

source §

A pattern built from arbitrary segments, coalescing adjacent literals.

Parameters

$segments list<TextSegment>

Returns

self

Test cases 23

Called from 4

Calls 3

function-call count line 58
new LiteralText line 63
new self line 69

public function concat(self $other): self

source §

The pattern produced by writing this one and then the other.

Parameters

$other self

Returns

self

Calls 2

static-call TextPattern::fromSegments() line 77
function-call array_merge line 77

public function isExact(): bool

source §

Whether every character of the string is known.

Returns

bool

Called from 2

Calls 1

method-call TextPattern::holes() line 85

public function text(): ?string

source §

The exact string, or null when the pattern still has gaps.

Returns

?string

Test cases 1

DomainTest::testConcatBuildsEveryCombination calls

Called from 3

public function holes(): list<TextHole>

source §

The gaps, in source order.

Returns

list<TextHole>

Called from 3

public function display(): string

source §

The pattern rendered for humans, with every gap shown as {$}.

Returns

string

Test cases 8

Called from 1

method-call SqlCatalog\Core\Catalog\CatalogEntry::sql() packages/sql-catalog/src/Core/Catalog/CatalogEntry.php:72

Calls 1

method-call TextPattern::render() line 126

public function render(string $holeText): string

source §

The pattern rendered with a caller-chosen stand-in for every gap.

Reading placeholders out of partially resolved SQL needs a stand-in that lexes as an ordinary word, so that a gap inside a quoted string does not end the string it sits in.

Parameters

$holeText string

Returns

string

Called from 4

public function signature(): string

source §

A canonical string that distinguishes patterns differing only in their gaps.

Returns

string

Called from 3

Calls 3

class-const LiteralText::class() line 154
class-const TextHole::class() line 155
function-call implode line 160

public function equals(self $other): bool

source §

Whether the two patterns describe the same string shape.

Parameters

$other self

Returns

bool

Called from 1

method-call SqlCatalog\Core\Text\TextGeneralization::merge() packages/sql-catalog/src/Core/Text/TextGeneralization.php:33

Calls 2

method-call TextPattern::signature() line 168
method-call self::signature() line 168

public function isEmpty(): bool

source §

Whether the pattern contributes no characters at all.

Returns

bool

Private surface 1§

Implementation details, listed for orientation only.

private function __construct(public list<TextSegment> $segments)

Test cases 339§

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

Dedicated tests 15

Other tests reaching this symbol 324

Relations§

Static calls 9

Method calls 14

Type declarations 26