Skip to content

classFixturePlan

packages/sql-fixture/src/Plan/FixturePlan.php:42

class FixturePlan
    implements Stringable

Public API: explicitly declared with @visibility public.

The parsed form of a fixture plan: which tables take part, and how their columns line up.

This type is the plan. The DBML relation string is one way to write it down and from() reads it; toString() writes it back. Building it up method by method, or declaring one as a class, produce the same value by other routes:

FixturePlan::from('order.id < order_detail.order_id');

(new FixturePlan())->withOneToMany('order.id', 'order_detail.order_id');

final class OrderWithDetails extends FixturePlan { public function __construct() { parent::__construct( Relation::oneToMany('order.id', 'order_detail.order_id'), Relation::manyToOne('order.customer_id', 'customer.id'), ); } }

A subclass names a plan without adding a kind of plan, so the builders below return a plain FixturePlan rather than the subclass: once a declared plan is altered it is no longer the plan that class stands for.

Build and print a relational fixture plandoctest

$plan = \SqlFixture\Plan\FixturePlan::from('users.id < posts.user_id');
    $plan->tables // => ['users', 'posts']
    $plan->toString() // => 'users.id < posts.user_id'

Properties§

public list<Relation> $relations

public list<RelationChoice> $choices

public list<string> $tables

public list<string> $generationOrder

Methods§

public function __construct(Relation|RelationChoice|string ...$parts)

Parameters

$parts Relation|RelationChoice|string Relations, and the names of tables that stand alone

Throws

EmptyPlanException If a table declaration is empty

EmptyTableNameException

MissingEndpointColumnsException

InvalidTableNameException

UnbalancedBracketsException

UnexpectedPlanTokenException

UnsupportedManyToManyException

CompositeArityMismatchException

Calls 8

function-call array_values line 82
new PlanContents line 83
method-call PlanValidation::rejectColumnsBoundTwice() line 87
new PlanValidation line 87
method-call ChoiceValidation::validate() line 88
new ChoiceValidation line 88
method-call PlanValidation::rejectUnboundedSelfReferences() line 89
method-call PlanValidation::sortByDependency() line 90

public static function from(string|self $plan): self

Read a plan written in the DBML relation syntax.

Parameters

$plan string|self

Returns

self

Throws

EmptyPlanException

EmptyTableNameException

MissingEndpointColumnsException

InvalidTableNameException

UnbalancedBracketsException

UnexpectedPlanTokenException

UnsupportedManyToManyException

CompositeArityMismatchException

Test cases 88

Called from 1

static-call SqlFixture\Provider\FixtureProvider::fixtures() packages/sql-fixture/src/Provider/FixtureProvider.php:113

Calls 3

new self line 108
method-call PlanParser::parse() line 111
new PlanParser line 111

public static function table(string $table): self

Start a plan from the table its fixtures are rooted at.

Parameters

$table string

Returns

self

Test cases 19

Calls 1

new self line 119

public function withRelation(Relation $relation): self

Returns with relation.

Parameters

$relation Relation

Returns

self

Called from 3

Calls 1

new self line 127

public function withChoice(RelationChoice $choice): self

Adds mutually exclusive relations selected separately for each row.

Parameters

$choice RelationChoice

Returns

self

Test cases 1

FixturePlanTest::testWithChoiceKeepsExistingSubjectsAndOrdinaryRelations calls

Calls 1

new self line 135

public function parts(): list<Relation|RelationChoice|string>

Preserves declaration order for printing and branch selection.

Returns

list<Relation|RelationChoice|string>

Test cases 1

FixturePlanTest::testSelectKeepsTheSubjectWhenABranchHasNoRelations calls

Called from 1

method-call SqlFixture\Plan\PlanPrinter::print() packages/sql-fixture/src/Plan/PlanPrinter.php:26

public function select(RelationChoice $choice, ChoiceCase $case): self

Replaces one choice with the selected relations for a generation scope.

Parameters

`$choice`	`RelationChoice`
`$case`	`ChoiceCase`

Returns

self

Test cases 2

Calls 1

new self line 161

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

Add parent.column < child.column.

Parameters

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

Returns

self

Calls 2

method-call FixturePlan::withRelation() line 172
static-call Relation::oneToMany() line 172

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

Add child.column > parent.column.

Parameters

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

Returns

self

Calls 2

method-call FixturePlan::withRelation() line 183
static-call Relation::manyToOne() line 183

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

Add parent.column - child.column.

Parameters

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

Returns

self

Calls 2

method-call FixturePlan::withRelation() line 194
static-call Relation::oneToOne() line 194

public function withTable(string $table): self

Name a table that takes part without being related to anything.

Parameters

$table string

Returns

self

Test cases 1

FixturePlanTest::testAPlanBuiltFromAKeyedSpreadCanStillBeExtended calls

Calls 1

new self line 202

public function subjectTable(): ?string

The table the fixtures are about, which is the first one named.

This is where the plan reads from, not where generation starts: written order_detail.order_id > order.id the subject is order_detail, but order has to exist first. Use generationOrder for that.

Returns

?string

Test cases 1

FixturePlanTest::testAnEmptyPlanHasNoSubject calls

public function roots(): list<string>

Tables nothing else has to be generated before.

Returns

list<string>

Calls 1

method-call FixturePlan::dependenciesOf() line 227

public function dependenciesOf(string $table): list<Relation>

Relations that must be satisfied before this table can be generated, that is, those in which it is the child.

Parameters

$table string

Returns

list<Relation>

Called from 1

method-call SqlFixture\Plan\FixturePlan::roots() packages/sql-fixture/src/Plan/FixturePlan.php:227

Calls 3

function-call array_values line 243
function-call array_filter line 243
method-call Relation::child() line 245

public function dependentsOf(string $table): list<Relation>

Relations hanging off this table, that is, those in which it is the parent.

Parameters

$table string

Returns

list<Relation>

Called from 1

method-call SqlFixture\Fixture\Generation\RelationProjection::referencedColumns() packages/sql-fixture/src/Fixture/Generation/RelationProjection.php:25

Calls 3

function-call array_values line 256
function-call array_filter line 256
method-call Relation::parent() line 258

public function toString(): string

Returns to string.

Returns

string

Test cases 2

Called from 1

method-call SqlFixture\Plan\FixturePlan::__toString() packages/sql-fixture/src/Plan/FixturePlan.php:275

Calls 2

method-call PlanPrinter::print() line 267
new PlanPrinter line 267

public function __toString(): string

Returns the canonical textual representation.

Returns

string

Calls 1

method-call FixturePlan::toString() line 275

Private surface 1§

Implementation details, listed for orientation only.

private list<Relation|RelationChoice|string> $parts

Test cases 156§

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

Dedicated tests 40

Other tests reaching this symbol 116

Relations§

Instantiated in 1

new SqlFixture\Plan\PlanParser::parse() packages/sql-fixture/src/Plan/PlanParser.php:59

Static calls 1

static-call SqlFixture\Provider\FixtureProvider::fixtures() packages/sql-fixture/src/Provider/FixtureProvider.php:113

Method calls 2

Type declarations 18