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<string> $tables

public list<string> $generationOrder

Methods§

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

Parameters

$parts Relation|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

method-call TableName::assertTableName() line 87
new TableName line 87
function-call array_values line 90
function-call array_unique line 92
method-call PlanValidation::rejectColumnsBoundTwice() line 94
new PlanValidation line 94
method-call PlanValidation::rejectUnboundedSelfReferences() line 95
method-call PlanValidation::sortByDependency() line 96

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 66

Called from 1

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

Calls 3

new self line 114
method-call PlanParser::parse() line 117
new PlanParser line 117

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 18

Calls 1

new self line 125

public function withRelation(Relation $relation): self

Returns with relation.

Parameters

$relation Relation

Returns

self

Called from 3

Calls 1

new self line 133

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 144
static-call Relation::oneToMany() line 144

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 155
static-call Relation::manyToOne() line 155

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 166
static-call Relation::oneToOne() line 166

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 174

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 199

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 2

Calls 3

function-call array_values line 215
function-call array_filter line 215
method-call Relation::child() line 217

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 2

Calls 3

function-call array_values line 228
function-call array_filter line 228
method-call Relation::parent() line 230

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:247

Calls 2

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

public function __toString(): string

Returns the canonical textual representation.

Returns

string

Calls 1

method-call FixturePlan::toString() line 247

Private surface 1§

Implementation details, listed for orientation only.

private list<Relation|string> $parts

Test cases 110§

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

Dedicated tests 36

Other tests reaching this symbol 74

Relations§

Instantiated in 1

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

Static calls 1

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

Method calls 3

Type declarations 14