Skip to content

classGenerationPlans

packages/sql-faker/src/MySql/Generation/GenerationPlans.php:21

final class GenerationPlans

Restricted visibility: declared "@visibility root". Code outside that scope must not name this declaration.

Names the generation plans this dialect's provider is built from.

A plan is how a caller says which SQL it wants, and the ones a provider offers are a fixed vocabulary rather than something each caller assembles. Naming them here keeps that vocabulary in one place and lets the provider read as a list of what it can generate.

Methods§

public static function withoutEmptyRows(non-empty-string|null $startRule = null): GenerationPlan<true>

Directs a walk that never leaves a VALUES list with nothing in it.

Parameters

$startRule non-empty-string|null Rule the walk begins at, or null for the grammar entry point

Returns

GenerationPlan<true> Plan whose row lists always carry a row

Test cases 1

GenerationPlansTest::testWithoutEmptyRowsConstrainsEveryOptionalValuesOccurrence calls

Called from 1

static-call SqlFaker\MySql\MySqlProvider::sqlWithoutEmptyRows() packages/sql-faker/src/MySql/MySqlProvider.php:143

Calls 3

static-call GenerationPlan::all() line 33
static-call GenerationPlan::fromRule() line 34
static-call ProductionPattern::nonEmpty() line 37

public static function quotedIdentifier(int $minLength, int $maxLength): GenerationPlan<true>

Parameters

`$minLength`	`int`
`$maxLength`	`int`

Returns

GenerationPlan<true>

Test cases 1

GenerationPlansTest::testQuotedIdentifierPlansThatLexeme calls

Called from 1

static-call SqlFaker\MySql\MySqlProvider::quotedIdentifier() packages/sql-faker/src/MySql/MySqlProvider.php:355

Calls 2

static-call GenerationPlan::lexical() line 46
function-call compact line 46

public static function stringLiteral(int $minLength, int $maxLength): GenerationPlan<true>

Parameters

`$minLength`	`int`
`$maxLength`	`int`

Returns

GenerationPlan<true>

Test cases 1

GenerationPlansTest::testStringLiteralPlansThatLexeme calls

Called from 1

static-call SqlFaker\MySql\MySqlProvider::stringLiteral() packages/sql-faker/src/MySql/MySqlProvider.php:371

Calls 2

static-call GenerationPlan::lexical() line 54
function-call compact line 54

public static function nationalStringLiteral(
    int $minLength,
    int $maxLength,
): GenerationPlan<true>

Parameters

`$minLength`	`int`
`$maxLength`	`int`

Returns

GenerationPlan<true>

Test cases 1

GenerationPlansTest::testNationalStringLiteralPlansThatLexeme calls

Called from 1

static-call SqlFaker\MySql\MySqlProvider::nationalStringLiteral() packages/sql-faker/src/MySql/MySqlProvider.php:387

Calls 2

static-call GenerationPlan::lexical() line 62
function-call compact line 62

public static function dollarQuotedString(int $minLength, int $maxLength): GenerationPlan<true>

Parameters

`$minLength`	`int`
`$maxLength`	`int`

Returns

GenerationPlan<true>

Test cases 1

GenerationPlansTest::testDollarQuotedStringPlansThatLexeme calls

Called from 1

static-call SqlFaker\MySql\MySqlProvider::dollarQuotedString() packages/sql-faker/src/MySql/MySqlProvider.php:403

Calls 2

static-call GenerationPlan::lexical() line 70
function-call compact line 70

public static function integerLiteral(int $min, int $max): GenerationPlan<true>

Parameters

`$min`	`int`
`$max`	`int`

Returns

GenerationPlan<true>

Test cases 1

GenerationPlansTest::testIntegerLiteralPlansThatLexeme calls

Called from 1

static-call SqlFaker\MySql\MySqlProvider::integerLiteral() packages/sql-faker/src/MySql/MySqlProvider.php:417

Calls 2

static-call GenerationPlan::lexical() line 78
function-call compact line 78

public static function longIntegerLiteral(int $min, int $max): GenerationPlan<true>

Parameters

`$min`	`int`
`$max`	`int`

Returns

GenerationPlan<true>

Test cases 1

GenerationPlansTest::testLongIntegerLiteralPlansThatLexeme calls

Called from 1

static-call SqlFaker\MySql\MySqlProvider::longIntegerLiteral() packages/sql-faker/src/MySql/MySqlProvider.php:431

Calls 2

static-call GenerationPlan::lexical() line 86
function-call compact line 86

public static function unsignedBigIntLiteral(
    int $minLength,
    int $maxLength,
): GenerationPlan<true>

Parameters

`$minLength`	`int`
`$maxLength`	`int`

Returns

GenerationPlan<true>

Test cases 1

GenerationPlansTest::testUnsignedBigIntLiteralPlansThatLexeme calls

Called from 1

static-call SqlFaker\MySql\MySqlProvider::unsignedBigIntLiteral() packages/sql-faker/src/MySql/MySqlProvider.php:448

Calls 2

static-call GenerationPlan::lexical() line 94
function-call compact line 94

public static function decimalLiteral(int $precision, int $scale): GenerationPlan<true>

Parameters

`$precision`	`int`
`$scale`	`int`

Returns

GenerationPlan<true>

Test cases 1

GenerationPlansTest::testDecimalLiteralPlansThatLexeme calls

Called from 1

static-call SqlFaker\MySql\MySqlProvider::decimalLiteral() packages/sql-faker/src/MySql/MySqlProvider.php:464

Calls 2

static-call GenerationPlan::lexical() line 102
function-call compact line 102

public static function floatLiteral(
    int $precision,
    int $scale,
    int $minExponent,
    int $maxExponent,
): GenerationPlan<true>

Parameters

`$precision`	`int`
`$scale`	`int`
`$minExponent`	`int`
`$maxExponent`	`int`

Returns

GenerationPlan<true>

Test cases 1

GenerationPlansTest::testFloatLiteralPlansThatLexeme calls

Called from 1

static-call SqlFaker\MySql\MySqlProvider::floatLiteral() packages/sql-faker/src/MySql/MySqlProvider.php:481

Calls 2

static-call GenerationPlan::lexical() line 114
function-call compact line 116

public static function hexLiteral(int $minLength, int $maxLength): GenerationPlan<true>

Parameters

`$minLength`	`int`
`$maxLength`	`int`

Returns

GenerationPlan<true>

Test cases 1

GenerationPlansTest::testHexLiteralPlansThatLexeme calls

Called from 1

static-call SqlFaker\MySql\MySqlProvider::hexLiteral() packages/sql-faker/src/MySql/MySqlProvider.php:498

Calls 2

static-call GenerationPlan::lexical() line 125
function-call compact line 125

public static function quotedHexLiteral(int $minBytes, int $maxBytes): GenerationPlan<true>

Parameters

`$minBytes`	`int`
`$maxBytes`	`int`

Returns

GenerationPlan<true>

Test cases 1

GenerationPlansTest::testQuotedHexLiteralPlansThatLexeme calls

Called from 1

static-call SqlFaker\MySql\MySqlProvider::quotedHexLiteral() packages/sql-faker/src/MySql/MySqlProvider.php:514

Calls 2

static-call GenerationPlan::lexical() line 133
function-call compact line 133

public static function binaryLiteral(int $minLength, int $maxLength): GenerationPlan<true>

Parameters

`$minLength`	`int`
`$maxLength`	`int`

Returns

GenerationPlan<true>

Test cases 1

GenerationPlansTest::testBinaryLiteralPlansThatLexeme calls

Called from 1

static-call SqlFaker\MySql\MySqlProvider::binaryLiteral() packages/sql-faker/src/MySql/MySqlProvider.php:530

Calls 2

static-call GenerationPlan::lexical() line 141
function-call compact line 141

public static function hostname(
    int $minParts,
    int $maxParts,
    int $maxPartLength,
): GenerationPlan<true>

Parameters

`$minParts`	`int`
`$maxParts`	`int`
`$maxPartLength`	`int`

Returns

GenerationPlan<true>

Test cases 1

GenerationPlansTest::testHostnamePlansThatLexeme calls

Called from 1

static-call SqlFaker\MySql\MySqlProvider::hostname() packages/sql-faker/src/MySql/MySqlProvider.php:546

Calls 2

static-call GenerationPlan::lexical() line 149
function-call compact line 149

public static function foreignKeyConstraint(Grammar $grammar): GenerationPlan<true>

Parameters

$grammar Grammar

Returns

GenerationPlan<true>

Test cases 1

GenerationPlansTest::testForeignKeyConstraintAdaptsToTheGrammarVersion calls

Called from 1

static-call SqlFaker\MySql\MySqlProvider::foreignKeyConstraint() packages/sql-faker/src/MySql/MySqlProvider.php:869

Calls 3

static-call GenerationPlan::constrained() line 167
static-call ProductionPattern::containing() line 168
static-call ProductionPattern::nonEmpty() line 170

public static function multiTableUpdateStatement(): GenerationPlan<true>

Returns

GenerationPlan<true>

Test cases 1

GenerationPlansTest::testMultiTableUpdateStatementRestrictsTheUpdateGrammar calls

Called from 1

static-call SqlFaker\MySql\MySqlProvider::multiTableUpdateStatement() packages/sql-faker/src/MySql/MySqlProvider.php:240

Calls 2

static-call GenerationPlan::constrained() line 180
static-call ProductionPattern::exactly() line 181

public static function updateJoinDerivedStatement(): GenerationPlan<true>

Returns

GenerationPlan<true>

Test cases 1

GenerationPlansTest::testUpdateJoinDerivedStatementRestrictsTheDerivedTableGrammar calls

Called from 1

static-call SqlFaker\MySql\MySqlProvider::updateJoinDerivedStatement() packages/sql-faker/src/MySql/MySqlProvider.php:889

Calls 4

static-call GenerationPlan::constrained() line 210
static-call ProductionPattern::exactly() line 211
static-call ProductionPattern::containing() line 218
static-call ProductionPattern::nonEmpty() line 224

public static function insertSelectCompoundStatement(): GenerationPlan<true>

Returns

GenerationPlan<true>

Test cases 1

GenerationPlansTest::testInsertSelectCompoundStatementRestrictsTheUnionGrammar calls

Called from 1

static-call SqlFaker\MySql\MySqlProvider::insertSelectCompoundStatement() packages/sql-faker/src/MySql/MySqlProvider.php:909

Calls 3

static-call GenerationPlan::constrained() line 234
static-call ProductionPattern::containing() line 235
static-call ProductionPattern::exactly() line 238

public static function insertRowAliasUpsertStatement(): GenerationPlan<true>

Returns

GenerationPlan<true>

Test cases 1

GenerationPlansTest::testInsertRowAliasUpsertStatementRestrictsTheValuesGrammar calls

Called from 1

static-call SqlFaker\MySql\MySqlProvider::insertRowAliasUpsertStatement() packages/sql-faker/src/MySql/MySqlProvider.php:929

Calls 4

static-call GenerationPlan::constrained() line 253
static-call ProductionPattern::containing() line 254
static-call ProductionPattern::exactly() line 256
static-call ProductionPattern::nonEmpty() line 257

public static function insertFunctionUpsertStatement(): GenerationPlan<true>

Returns

GenerationPlan<true>

Test cases 1

GenerationPlansTest::testInsertFunctionUpsertStatementRestrictsTheConflictFunctionGrammar calls

Called from 1

static-call SqlFaker\MySql\MySqlProvider::insertFunctionUpsertStatement() packages/sql-faker/src/MySql/MySqlProvider.php:947

Calls 4

static-call GenerationPlan::constrained() line 267
static-call ProductionPattern::containing() line 268
static-call ProductionPattern::exactly() line 270
static-call ProductionPattern::nonEmpty() line 277

public static function temporaryTableStatement(): GenerationPlan<true>

Returns

GenerationPlan<true>

Test cases 1

GenerationPlansTest::testTemporaryTableStatementRequiresTheTemporaryProduction calls

Called from 1

static-call SqlFaker\MySql\MySqlProvider::temporaryTableStatement() packages/sql-faker/src/MySql/MySqlProvider.php:982

Calls 2

static-call GenerationPlan::constrained() line 288
static-call ProductionPattern::nonEmpty() line 289

public static function viewStatement(): GenerationPlan<true>

Returns

GenerationPlan<true>

Test cases 1

GenerationPlansTest::testViewStatementRestrictsTheCreateGrammar calls

Called from 1

static-call SqlFaker\MySql\MySqlProvider::viewStatement() packages/sql-faker/src/MySql/MySqlProvider.php:999

Calls 2

static-call GenerationPlan::constrained() line 298
static-call ProductionPattern::exactly() line 299

public static function generatedColumnStatement(): GenerationPlan<true>

Returns

GenerationPlan<true>

Test cases 1

GenerationPlansTest::testGeneratedColumnStatementRequiresTheGeneratedAttribute calls

Called from 1

static-call SqlFaker\MySql\MySqlProvider::generatedColumnStatement() packages/sql-faker/src/MySql/MySqlProvider.php:1015

Calls 4

static-call GenerationPlan::constrained() line 313
static-call ProductionPattern::containing() line 314
static-call ProductionPattern::exactly() line 315
static-call ProductionPattern::nonEmpty() line 317

public static function foreignKeyCascadeStatement(): GenerationPlan<true>

Returns

GenerationPlan<true>

Test cases 1

GenerationPlansTest::testForeignKeyCascadeStatementRequiresBothCascadeActions calls

Called from 1

static-call SqlFaker\MySql\MySqlProvider::foreignKeyCascadeStatement() packages/sql-faker/src/MySql/MySqlProvider.php:1031

Calls 4

static-call GenerationPlan::constrained() line 327
static-call ProductionPattern::containing() line 328
static-call ProductionPattern::exactly() line 329
static-call ProductionPattern::nonEmpty() line 331

public static function partitionSelectStatement(): GenerationPlan<true>

Returns

GenerationPlan<true>

Test cases 1

GenerationPlansTest::testPartitionSelectStatementRequiresThePartitionClause calls

Called from 1

static-call SqlFaker\MySql\MySqlProvider::partitionSelectStatement() packages/sql-faker/src/MySql/MySqlProvider.php:1047

Calls 3

static-call GenerationPlan::constrained() line 347
static-call ProductionPattern::exactly() line 349
static-call ProductionPattern::nonEmpty() line 353

public static function loadDataStatement(): GenerationPlan<true>

Returns

GenerationPlan<true>

Test cases 1

GenerationPlansTest::testLoadDataStatementStartsFromTheLoadGrammar calls

Called from 1

static-call SqlFaker\MySql\MySqlProvider::loadDataStatement() packages/sql-faker/src/MySql/MySqlProvider.php:224

Calls 1

static-call GenerationPlan::fromRule() line 365

public static function fullTextSearchStatement(): GenerationPlan<true>

Returns

GenerationPlan<true>

Test cases 1

GenerationPlansTest::testFullTextSearchStatementRequiresMatchAgainstGrammar calls

Called from 1

static-call SqlFaker\MySql\MySqlProvider::fullTextSearchStatement() packages/sql-faker/src/MySql/MySqlProvider.php:964

Calls 4

static-call GenerationPlan::constrained() line 373
static-call ProductionPattern::exactly() line 374
static-call ProductionPattern::nonEmpty() line 376
static-call ProductionPattern::containing() line 379

public static function multiTableDeleteStatement(): GenerationPlan<true>

Returns

GenerationPlan<true>

Test cases 1

GenerationPlansTest::testMultiTableDeleteStatementRestrictsTheDeleteGrammar calls

Called from 1

static-call SqlFaker\MySql\MySqlProvider::multiTableDeleteStatement() packages/sql-faker/src/MySql/MySqlProvider.php:256

Calls 3

static-call GenerationPlan::constrained() line 388
static-call ProductionPattern::containing() line 389
static-call ProductionPattern::exactly() line 390

Test cases 29§

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

Dedicated tests 28

Other tests reaching this symbol 1

MySqlProviderTest calls

Relations§

Static calls 28