classShadowStore

Simulationpackages/ztd-query-core/src/Shadow/ShadowStore.php:28
class ShadowStore
Public API: explicitly declared with @visibility public.

Holds in-memory shadow rows for tables.

Type Aliases§

Row = import from TableDefinition
Snapshot and restore fixture rowsdoctest
$store = new \ZtdQuery\Shadow\ShadowStore();
    $store->set('users', [['id' => 1, 'name' => 'Alice']]);
    $snapshot = $store->snapshot();
    $store->update('users', [['id' => 1, 'name' => 'Bob']], ['id']);
    $store->get('users') // => [['id' => 1, 'name' => 'Bob']]
    $store->restore($snapshot);
    $store->get('users') // => [['id' => 1, 'name' => 'Alice']]

Methods§

public function __construct(private RowMatch $match = new \ZtdQuery\Shadow\Row\RowMatch())
100%source§

Parameters

$matchRowMatchDecides when a stored row is the row a caller means
Test cases 19
Calls 1
public function set(string $tableName, array<int, Row> $rows): void
100%source§

Replaces every shadow row of a table.

The caller's row keys and values are retained unchanged.

Parameters

$tableNamestring
$rowsarray<int, Row>Rows the table now has, in order
Test cases 178
Called from 7
Calls 1
public function get(string $tableName): array<int, Row>
100%source§

Get all shadow rows for a table.

Parameters

$tableNamestring

Returns

array<int, Row>
Test cases 139
Called from 12
Calls 1
public function state(string $tableName): ShadowTableState
100%source§

Return the typed presence state for a shadow table.

Parameters

$tableNamestring

Returns

ShadowTableState
Test cases 2
Calls 4
public function getAll(): array<string, array<int, Row>>
100%source§

Get all stored shadow tables.

Returns

array<string, array<int, Row>>
Test cases 3
Called from 1
public function clear(): void
100%source§

Remove all shadow data.

Test cases 1
public function snapshot(): self
100%source§

Snapshot.

Returns

self
Test cases 35
Called from 2
public function remove(string $tableName): void
100%source§

Remove both rows and explicit table context from the store.

Parameters

$tableNamestring
Test cases 1
Called from 1
public function insert(string $tableName, array<int, Row> $rows): void
100%source§

Append rows to a table shadow set.

Parameters

$tableNamestring
$rowsarray<int, Row>
Test cases 12
Called from 2
Calls 3
public function delete(
    string $tableName,
    array<int, Row> $deletedRows,
    array<int, string> $primaryKeys = [],
): void
100%source§

Delete rows from the shadow set.

Parameters

$tableNamestring
$deletedRowsarray<int, Row>
$primaryKeysarray<int, string>
Test cases 4
Called from 2
Calls 2
public function update(
    string $tableName,
    array<int, Row> $updatedRows,
    array<int, string> $primaryKeys,
): void
92%source§

Update rows matched by primary keys.

Parameters

$tableNamestring
$updatedRowsarray<int, Row>
$primaryKeysarray<int, string>

Throws

MissingPrimaryKeyException When the table declares no key to identify a row by
Test cases 5
Calls 3
public function updateIdentified(
    string $tableName,
    list<array{row: Row, identity: Row}> $updates,
    array<int, string> $primaryKeys,
): void
83%source§

Parameters

$tableNamestring
$updateslist<array{row: Row, identity: Row}>
$primaryKeysarray<int, string>

Throws

MissingPrimaryKeyException When the table declares no key to identify a row by
Test cases 1
Called from 2
Calls 3

Private surface 3§

Implementation details, listed for orientation only.

private RowMatch $match = new \ZtdQuery\Shadow\Row\RowMatch()
private array<string, RowSet> $fixtures = []
private array<string, string> $initializedTables = []

Test cases 242§

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

Dedicated tests 19
Other tests reaching this symbol 223

Relations§

Method calls 32
Type declarations 31