classSinkSpec

packages/sql-catalog/src/Core/Extension/SinkSpec.php:18

final class SinkSpec

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

One call an extension recognises as reaching the database.

The parameter indexes say where the statement text and the bound values sit in the argument list, which is all the analyzer needs in order to treat a framework's own API the same way it treats a raw driver call.

Properties§

public ?int $sqlParameter

source §

SQL argument position, or the fixed SQL output position for a modelled sink.

public ?int $valuesParameter

source §

Bindings argument position, or the fixed bindings output position for a modelled sink.

public string $id

source §

public SinkCallKind $callKind

source §

public string|null $receiverType

source §

public string $name

source §

public SinkRole $role

source §

public int|null $valuesFrom = null

source §

public int|null $nameParameter = null

source §

public int|null $valueParameter = null

source §

public StatementKind|null $kind = null

source §

public string|null $handleType = null

source §

public string|null $model = null

source §

Methods§

public function __construct(
    public string $id,
    public SinkCallKind $callKind,
    public string|null $receiverType,
    public string $name,
    public SinkRole $role,
    int|null $sqlParameter = null,
    int|null $valuesParameter = null,
    public int|null $valuesFrom = null,
    public int|null $nameParameter = null,
    public int|null $valueParameter = null,
    public StatementKind|null $kind = null,
    public string|null $handleType = null,
    public string|null $model = null,
)

source §

Parameters

`$id`	`string`	The identifier reported on matched call sites
`$callKind`	`SinkCallKind`	How the call is written
`$receiverType`	`string\|null`	The class the call is made on, or null for a free function
`$name`	`string`	The method or function name
`$role`	`SinkRole`	What the call does with the statement
`$sqlParameter`	`int\|null`	Where the statement text sits in the argument list
`$valuesParameter`	`int\|null`	Where an array of bound values sits
`$valuesFrom`	`int\|null`	Where variadic bound values start
`$nameParameter`	`int\|null`	Where the name of a single bound parameter sits
`$valueParameter`	`int\|null`	Where the value of a single bound parameter sits
`$kind`	`StatementKind\|null`	The statement kind the call implies, when it implies one
`$handleType`	`string\|null`	The class a preparing call returns, so later binds find the statement
`$model`	`string\|null`	The registered statement model for a modelled execution call

Calls 1

class-const SinkRole::Modelled() line 60

public function matchesName(string $name): bool

source §

Whether the call is written with the given name, ignoring case.

Parameters

$name string

Returns

bool

Test cases 1

SinkSpecTest::testMatchesNameIgnoresCaseAndLeadingBackslashes calls

Calls 2

function-call strtolower line 69
function-call ltrim line 69

Test cases 53§

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

Dedicated tests 3

Other tests reaching this symbol 50

Relations§

Instantiated in 28

Type declarations 9