classBuiltinCallModel

packages/sql-catalog/src/Core/Analysis/BuiltinCallModel.php:28

final class BuiltinCallModel

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

What the PHP functions that shape query text do to the values they are given.

Queries are assembled with a small, stable set of string functions. Modelling those keeps a statement resolved that would otherwise become a gap the moment it passed through sprintf() or implode().

Methods§

public function register(Registry $registry): void

source §

Registers every built-in interpretation through the same API as custom models.

Parameters

$registry Registry

Test cases 1

BuiltinCallModelTest::testRegisterInstallsModelsIntoAnEmptyRegistry calls

Called from 1

method-call SqlCatalog\Core\Analysis\FunctionModel\Registry::withBuiltins() packages/sql-catalog/src/Core/Analysis/FunctionModel/Registry.php:39

Calls 15

method-call Registry::register() line 48
method-call BuiltinCallModel::sprintf() line 48
function-call array_slice line 48
static-call Domain::unknown() line 48
method-call BuiltinCallModel::vsprintf() line 49
method-call BuiltinCallModel::implode() line 50
method-call BuiltinCallModel::fill() line 51
method-call BuiltinCallModel::repeat() line 53
method-call BuiltinCallModel::replace() line 54
method-call BuiltinCallModel::transform() line 57
static-call Domain::opaque() line 60
static-call TypeShape::of() line 60
class-const Origin::Call() line 60
function-call array_keys line 62
class-const BuiltinCallModel::STRING_RESULTS() line 62

public function supports(string $name): bool

source §

Whether the standard registry models the function.

Parameters

$name string

Returns

bool

Test cases 2

Calls 1

static-call Registry::withBuiltins() line 72

public function evaluate(string $name, list<Domain> $arguments): Domain

source §

The standard registry's interpretation of the given arguments.

Parameters

`$name`	`string`
`$arguments`	`list<Domain>`

Returns

Domain

Test cases 8

Calls 4

static-call Registry::withBuiltins() line 82
static-call Domain::opaque() line 83
static-call TypeShape::of() line 83
class-const Origin::Call() line 83

public function normalize(string $name): string

source §

The case-insensitive fully qualified name.

Parameters

$name string

Returns

string

Test cases 1

BuiltinCallModelTest::testNormalize calls

Calls 2

method-call Registry::normalize() line 91
new Registry line 91

public function sprintf(list<Domain> $arguments, Domain $format): Domain

source §

The result of sprintf(), resolved as far as the format and the arguments allow.

A format the analyzer knows only in part — "SELECT * FROM $table WHERE id IN (%s)" — still has conversions in the parts it knows, so those are filled in and the gaps are carried through, rather than the whole result becoming one gap because one piece of the format was not fixed.

Parameters

`$arguments`	`list<Domain>`
`$format`	`Domain`

Returns

Domain

Test cases 5

Called from 2

Calls 5

method-call BuiltinCallModel::formatPattern() line 109
static-call Domain::opaque() line 110
static-call TypeShape::of() line 110
method-call BuiltinCallModel::originOf() line 110
class-const Origin::Call() line 110

public function formatPattern(TextPattern $format, list<Domain> $arguments): Domain

source §

A known or partly known format with its conversions filled in by the arguments.

Parameters

`$format`	`TextPattern`
`$arguments`	`list<Domain>`

Returns

Domain

Test cases 4

Called from 1

method-call SqlCatalog\Core\Analysis\BuiltinCallModel::sprintf() packages/sql-catalog/src/Core/Analysis/BuiltinCallModel.php:109

Calls 9

static-call Domain::literal() line 124
static-call Domain::of() line 128
static-call Domain::asTerm() line 128
static-call TextPattern::fromSegments() line 128
method-call BuiltinCallModel::splitFormat() line 131
function-call str_starts_with line 132
static-call Domain::opaque() line 137
static-call TypeShape::unknown() line 137
class-const Origin::Call() line 137

public function originOf(Domain $domain, Origin $fallback): Origin

source §

Where the unresolved part of a value comes from, or the fallback when nothing in it says.

Parameters

`$domain`	`Domain`
`$fallback`	`Origin`

Returns

Origin

Test cases 2

Called from 2

public function vsprintf(list<Domain> $arguments): Domain

source §

The result of vsprintf(), which takes its arguments as one array.

Parameters

$arguments list<Domain>

Returns

Domain

Test cases 2

Called from 1

method-call SqlCatalog\Core\Analysis\BuiltinCallModel::register() packages/sql-catalog/src/Core/Analysis/BuiltinCallModel.php:49

Calls 5

static-call Domain::unknown() line 167
static-call Domain::opaque() line 169
static-call TypeShape::of() line 169
class-const Origin::Call() line 169
method-call BuiltinCallModel::sprintf() line 172

public function splitFormat(string $format): list<string>

source §

A format string split into literal runs and conversion specifications.

Parameters

$format string

Returns

list<string>

Test cases 2

Called from 1

method-call SqlCatalog\Core\Analysis\BuiltinCallModel::formatPattern() packages/sql-catalog/src/Core/Analysis/BuiltinCallModel.php:131

Calls 3

function-call preg_split line 182
function-call array_values line 187
function-call array_filter line 187

public function implode(list<Domain> $arguments): Domain

source §

The result of implode(), resolved when the array is known element by element.

Parameters

$arguments list<Domain>

Returns

Domain

Test cases 6

Called from 2

Calls 8

function-call count line 197
static-call Domain::literal() line 197
method-call BuiltinCallModel::arrayArgument() line 198
static-call Domain::unknown() line 200
static-call Domain::opaque() line 202
static-call TypeShape::of() line 202
method-call BuiltinCallModel::originOf() line 202
class-const Origin::Call() line 202

public function arrayArgument(list<Domain> $arguments): ?ArrayTerm

source §

The array argument of an implode call, whichever position it is written in.

Parameters

$arguments list<Domain>

Returns

?ArrayTerm

Test cases 1

BuiltinCallModelTest::testArrayArgumentFindsTheArrayInAnyPosition calls

Called from 1

method-call SqlCatalog\Core\Analysis\BuiltinCallModel::implode() packages/sql-catalog/src/Core/Analysis/BuiltinCallModel.php:198

public function fill(list<Domain> $arguments): ?Domain

source §

A representative placeholder array, independent of its runtime length.

Parameters

$arguments list<Domain>

Returns

?Domain

Test cases 2

Called from 1

method-call SqlCatalog\Core\Analysis\BuiltinCallModel::register() packages/sql-catalog/src/Core/Analysis/BuiltinCallModel.php:51

Calls 4

public function repeat(list<Domain> $arguments): Domain

source §

The result of str_repeat(), resolved when both arguments are known.

Parameters

$arguments list<Domain>

Returns

Domain

Test cases 3

Called from 1

method-call SqlCatalog\Core\Analysis\BuiltinCallModel::register() packages/sql-catalog/src/Core/Analysis/BuiltinCallModel.php:53

Calls 7

static-call Domain::unknown() line 254
function-call is_int line 256
static-call Domain::opaque() line 257
static-call TypeShape::of() line 257
class-const Origin::Call() line 257
static-call Domain::literal() line 260
function-call str_repeat line 260

public function transform(string $function, list<Domain> $arguments): Domain

source §

The result of a one-argument string transformation.

Parameters

`$function`	`string`
`$arguments`	`list<Domain>`

Returns

Domain

Test cases 2

Called from 1

method-call SqlCatalog\Core\Analysis\BuiltinCallModel::register() packages/sql-catalog/src/Core/Analysis/BuiltinCallModel.php:57

Calls 12

static-call Domain::unknown() line 270
static-call Domain::opaque() line 272
static-call TypeShape::of() line 272
class-const Origin::Call() line 272
static-call Domain::literal() line 276
function-call strtolower line 277
function-call strtoupper line 278
function-call ucfirst line 279
function-call lcfirst line 280
function-call ltrim line 281
function-call rtrim line 282
function-call trim line 283

public function replace(list<Domain> $arguments): Domain

source §

The result of str_replace(), resolved when every argument is a known string.

Parameters

$arguments list<Domain>

Returns

Domain

Test cases 2

Called from 1

method-call SqlCatalog\Core\Analysis\BuiltinCallModel::register() packages/sql-catalog/src/Core/Analysis/BuiltinCallModel.php:54

Calls 6

static-call Domain::unknown() line 294
static-call Domain::opaque() line 298
static-call TypeShape::of() line 298
class-const Origin::Call() line 298
static-call Domain::literal() line 301
function-call str_replace line 301

Private surface 1§

Implementation details, listed for orientation only.

private const STRING_RESULTS = ['json_encode' => true, 'addslashes' => true, 'htmlspecialchars' => true, 'str_…

Test cases 69§

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

Dedicated tests 43

Other tests reaching this symbol 26

Relations§

Instantiated in 1

new SqlCatalog\Core\Analysis\FunctionModel\Registry::withBuiltins() packages/sql-catalog/src/Core/Analysis/FunctionModel/Registry.php:39

Method calls 1

method-call SqlCatalog\Core\Analysis\FunctionModel\Registry::withBuiltins() packages/sql-catalog/src/Core/Analysis/FunctionModel/Registry.php:39