classRelation

packages/sql-fixture/src/Plan/Relation.php:18

final class Relation

One relation as written, with the roles the operator implies.

The sides are kept in the order they were written so that a plan prints back the way it was given. Which end is the parent comes from the operator, not from the order, so a.id < b.a_id and b.a_id > a.id describe the same shape.

A ? next to an end marks that end optional, as it does in DBML: the referencing column may be null, so the row on the other end need not exist.

Properties§

public ColumnRef $left

source §

public RelationKind $kind

source §

public ColumnRef $right

source §

public bool $leftOptional = false

source §

public bool $rightOptional = false

source §

Methods§

public function __construct(
    public ColumnRef $left,
    public RelationKind $kind,
    public ColumnRef $right,
    public bool $leftOptional = false,
    public bool $rightOptional = false,
)

source §

Initializes the collaborators and declared state for this object.

Parameters

`$left`	`ColumnRef`
`$kind`	`RelationKind`
`$right`	`ColumnRef`
`$leftOptional`	`bool`
`$rightOptional`	`bool`

Throws

CompositeArityMismatchException

Calls 2

function-call count line 31
new CompositeArityMismatchException line 32

public static function oneToMany(
    string|ColumnRef $parent,
    string|ColumnRef $child,
    bool $childOptional = false,
): self

source §

parent.column < child.column: one parent row, several child rows.

Parameters

`$parent`	`string\|ColumnRef`
`$child`	`string\|ColumnRef`
`$childOptional`	`bool`

Returns

self

Test cases 27

Called from 1

static-call SqlFixture\Plan\FixturePlan::withOneToMany() packages/sql-fixture/src/Plan/FixturePlan.php:144

Calls 3

new self line 44
static-call ColumnRef::from() line 45
class-const RelationKind::OneToMany() line 46

public static function manyToOne(
    string|ColumnRef $child,
    string|ColumnRef $parent,
    bool $parentOptional = false,
): self

source §

child.column > parent.column: the same shape written from the child.

Parameters

`$child`	`string\|ColumnRef`
`$parent`	`string\|ColumnRef`
`$parentOptional`	`bool`

Returns

self

Test cases 7

Called from 1

static-call SqlFixture\Plan\FixturePlan::withManyToOne() packages/sql-fixture/src/Plan/FixturePlan.php:155

Calls 3

new self line 61
static-call ColumnRef::from() line 62
class-const RelationKind::ManyToOne() line 63

public static function oneToOne(
    string|ColumnRef $parent,
    string|ColumnRef $child,
    bool $childOptional = false,
): self

source §

parent.column - child.column: one row on each side.

Parameters

`$parent`	`string\|ColumnRef`
`$child`	`string\|ColumnRef`
`$childOptional`	`bool`

Returns

self

Test cases 7

Called from 1

static-call SqlFixture\Plan\FixturePlan::withOneToOne() packages/sql-fixture/src/Plan/FixturePlan.php:166

Calls 3

new self line 78
static-call ColumnRef::from() line 79
class-const RelationKind::OneToOne() line 80

public function minimumChildRows(): int

source §

The fewest child rows to generate when none are given.

A relation written without ? says the child must be there, so an unspecified child is still generated. Marking it optional is what makes "none at all" a possible outcome.

Returns

int

Called from 1

method-call SqlFixture\Fixture\Generation\RelationCounts::resolveCount() packages/sql-fixture/src/Fixture/Generation/RelationCounts.php:36

Calls 1

method-call Relation::childIsOptional() line 96

public function maximumChildRows(): ?int

source §

The most child rows the relation allows, or null where it is unbounded.

Returns

?int

Called from 1

method-call SqlFixture\Fixture\Generation\RelationCounts::resolveCount() packages/sql-fixture/src/Fixture/Generation/RelationCounts.php:37

Calls 1

method-call Relation::childIsCollection() line 104

public function parent(): ColumnRef

source §

The end holding a single row, generated before the other.

Returns

ColumnRef

Test cases 2

Called from 5

Calls 2

method-call RelationKind::parentSide() line 112
class-const RelationSide::Left() line 112

public function child(): ColumnRef

source §

The end referencing the parent, which may hold several rows.

Returns

ColumnRef

Test cases 3

Called from 3

Calls 2

method-call RelationKind::childSide() line 120
class-const RelationSide::Left() line 120

public function parentIsOptional(): bool

source §

Whether the parent row may be absent, leaving the reference null.

Returns

bool

Test cases 3

Called from 1

method-call SqlFixture\Fixture\Generation\RowMaterializer::toParent() packages/sql-fixture/src/Fixture/Generation/RowMaterializer.php:133

Calls 2

method-call RelationKind::parentSide() line 128
class-const RelationSide::Left() line 128

public function childIsOptional(): bool

source §

Whether the child end was marked optional.

This says nothing the data does not already say, since the number of child rows comes from the values supplied for that table.

Returns

bool

Test cases 3

Called from 1

method-call SqlFixture\Plan\Relation::minimumChildRows() packages/sql-fixture/src/Plan/Relation.php:96

Calls 2

method-call RelationKind::childSide() line 139
class-const RelationSide::Left() line 139

public function childIsCollection(): bool

source §

Reports whether the relation permits multiple child rows.

Returns

bool

Test cases 1

RelationTest::testChildIsCollectionOnlyOneToOneHoldsASingleChildRow calls

Called from 2

Calls 1

method-call RelationKind::childIsCollection() line 147

public function columnMap(): array<string, string>

source §

Map each child column onto the parent column it references.

Returns

array<string, string> Child column => parent column

Test cases 3

Called from 2

Calls 2

method-call Relation::child() line 157
method-call Relation::parent() line 158

public function tables(): list<string>

source §

Returns

list<string> The tables this relation touches, left end first

Test cases 2

Test cases 70§

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

Dedicated tests 29

Other tests reaching this symbol 41

Relations§

Instantiated in 1

new SqlFixture\Plan\Parsing\RelationReader::buildRelations() packages/sql-fixture/src/Plan/Parsing/RelationReader.php:146

Static calls 3

Method calls 12

Type checks 1

instanceof SqlFixture\Plan\FixturePlan::__construct() packages/sql-fixture/src/Plan/FixturePlan.php:81

Type declarations 16