classShadowStore

packages/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())

source §

Parameters

$match RowMatch Decides when a stored row is the row a caller means

Calls 1

new RowMatch line 33

public function set(string $tableName, array<int, Row> $rows): void

source §

Replaces every shadow row of a table.

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

Parameters

`$tableName`	`string`
`$rows`	`array<int, Row>`	Rows the table now has, in order

Test cases 382

Called from 12

Calls 1

new RowSet line 60

public function get(string $tableName): array<int, Row>

source §

Get all shadow rows for a table.

Parameters

$tableName string

Returns

array<int, Row>

Test cases 248

Called from 19

Calls 1

new RowSet line 71

public function has(string $tableName): bool

source §

Whether the store contains a shadow entry for a table, including an intentionally empty table.

Parameters

$tableName string

Returns

bool

Test cases 5

Called from 4

Calls 1

function-call array_key_exists line 80

public function state(string $tableName): ShadowTableState

source §

Return the typed presence state for a shadow table.

Parameters

$tableName string

Returns

ShadowTableState

Test cases 11

Called from 8

Calls 4

method-call ShadowStore::has() line 88
class-const ShadowTableState::Missing() line 89
class-const ShadowTableState::Initialized() line 93
class-const ShadowTableState::Materialized() line 96

public function getAll(): array<string, array<int, Row>>

source §

Get all stored shadow tables.

Returns

array<string, array<int, Row>>

Test cases 17

Called from 7

public function clear(): void

source §

Remove all shadow data.

Test cases 3

RewriteTarget::__invoke calls
RobustnessTarget::__invoke calls
ShadowStoreTest::testClearRemovesAllData calls

public function snapshot(): self

source §

Snapshot.

Returns

self

Test cases 37

Called from 2

public function restore(self $snapshot): void

source §

Restore.

Parameters

$snapshot self

Test cases 4

Called from 2

public function ensure(string $tableName): void

source §

Ensure a table key exists in the store.

Parameters

$tableName string

Test cases 59

Called from 9

Calls 2

function-call array_key_exists line 149
new RowSet line 150

public function remove(string $tableName): void

source §

Remove both rows and explicit table context from the store.

Parameters

$tableName string

Test cases 1

ShadowStoreTest::testRemoveClearsRowsAndInitialization calls

Called from 2

public function insert(string $tableName, array<int, Row> $rows): void

source §

Append rows to a table shadow set.

Parameters

`$tableName`	`string`
`$rows`	`array<int, Row>`

Test cases 35

Called from 2

Calls 3

method-call ShadowStore::get() line 170
new RowSet line 171
function-call array_merge line 171

public function delete(
    string $tableName,
    array<int, Row> $deletedRows,
    array<int, string> $primaryKeys = [],
): void

source §

Delete rows from the shadow set.

Parameters

`$tableName`	`string`
`$deletedRows`	`array<int, Row>`
`$primaryKeys`	`array<int, string>`

Test cases 4

Called from 2

Calls 2

method-call RowMatch::identifies() line 192
new RowSet line 203

public function update(
    string $tableName,
    array<int, Row> $updatedRows,
    array<int, string> $primaryKeys,
): void

source §

Update rows matched by primary keys.

Parameters

`$tableName`	`string`
`$updatedRows`	`array<int, Row>`
`$primaryKeys`	`array<int, string>`

Throws

MissingPrimaryKeyException When the table declares no key to identify a row by

Test cases 5

Calls 3

new MissingPrimaryKeyException line 221
method-call RowMatch::identifies() line 228
new RowSet line 235

public function updateIdentified(
    string $tableName,
    list<array{row: Row, identity: Row}> $updates,
    array<int, string> $primaryKeys,
): void

source §

Parameters

`$tableName`	`string`
`$updates`	`list<array{row: Row, identity: Row}>`
`$primaryKeys`	`array<int, string>`

Throws

MissingPrimaryKeyException When the table declares no key to identify a row by

Test cases 1

ShadowStoreTest::testUpdateIdentifiedWritesTheRowTheOldKeyPointsAt calls

Called from 2

Calls 3

new MissingPrimaryKeyException line 250
method-call RowMatch::identifies() line 256
new RowSet line 263

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 1354§

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 1335

Relations§

Instantiated in 3

Method calls 69

Type declarations 65