classForeignKeyEnds

packages/ztd-query-core/src/Shadow/ForeignKeyEnds.php:17

final class ForeignKeyEnds

Answers which columns of the parent a foreign key points at.

A key may name them, or leave them out and mean the parent's primary key, so the two spellings are resolved to one answer here rather than at every place that has to follow the key.

Methods§

public function __construct(private TableDefinitionRegistry $registry)

source §

Parameters

$registry TableDefinitionRegistry Answers what a table declares

public function referencedColumns(ForeignKeyDefinition $foreignKey): list<string>

source §

Answers the parent columns a key points at.

Parameters

$foreignKey ForeignKeyDefinition Key to follow

Returns

list<string> The columns, or nothing when the parent is unknown

Test cases 3

Called from 4

Calls 1

method-call TableDefinitionRegistry::get() line 39

public function areBalanced(ForeignKeyDefinition $foreignKey): bool

source §

Reports whether a key names as many parent columns as child columns.

A key that does not cannot be followed at all: there is no pairing to read the child values against.

Parameters

$foreignKey ForeignKeyDefinition Key to test

Returns

bool True when the two ends have the same number of columns

Test cases 2

Called from 2

Calls 2

function-call count line 59
method-call ForeignKeyEnds::referencedColumns() line 59

Private surface 1§

Implementation details, listed for orientation only.

private TableDefinitionRegistry $registry

Test cases 26§

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

Dedicated tests 5

Other tests reaching this symbol 21

Relations§

Instantiated in 1

new ZtdQuery\Shadow\ReferentialIntegrityEnforcer::synchronize() packages/ztd-query-core/src/Shadow/ReferentialIntegrityEnforcer.php:55

Method calls 5

Type declarations 2