classForeignKeyDefinition

packages/ztd-query-core/src/Schema/Key/ForeignKeyDefinition.php:10

final class ForeignKeyDefinition

One foreign key: which columns point where, and what happens when the parent moves.

Properties§

public non-empty-list<string> $columns

source §

public string $referencedTable

source §

public list<string> $referencedColumns

source §

public ReferentialAction $onDelete = ReferentialAction::NoAction

source §

public ReferentialAction $onUpdate = ReferentialAction::NoAction

source §

Methods§

public function __construct(
    public non-empty-list<string> $columns,
    public string $referencedTable,
    public list<string> $referencedColumns,
    public ReferentialAction $onDelete = ReferentialAction::NoAction,
    public ReferentialAction $onUpdate = ReferentialAction::NoAction,
)

source §

Parameters

`$columns`	`non-empty-list<string>`
`$referencedTable`	`string`
`$referencedColumns`	`list<string>`
`$onDelete`	`ReferentialAction`
`$onUpdate`	`ReferentialAction`

Calls 1

class-const ReferentialAction::NoAction() line 20

Test cases 63§

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

Dedicated tests 1

ForeignKeyDefinitionTest::testCarriesCompositeReferenceAndActions calls

Other tests reaching this symbol 62

Relations§

Instantiated in 4

Type declarations 8