abstract class Migration

Migration factory.

Implements some handy shortcuts for creating typical migrations.

Methods

static array
createTable(string $name, callable $definition, callable|bool|null $shouldRun = null)

No description

static array
createTableIfNotExists(string $name, callable $definition, callable|bool|null $shouldRun = null)

No description

static array
renameTable(string $from, string $to, callable|bool|null $shouldRun = null)

No description

static array
addColumns(string $tableName, array $columnDefinitions, callable|bool|null $shouldRun = null)

No description

static array
dropColumns(string $tableName, array $columnDefinitions, callable|bool|null $shouldRun = null)

No description

static array
renameColumn(string $tableName, string $from, string $to, callable|bool|null $shouldRun = null)

No description

static array
renameColumns(string $tableName, array $columnNames, callable|bool|null $shouldRun = null)

No description

static array
addSettings(array $defaults, callable|bool|null $shouldRun = null)

Add default values for config values.

static array
addPermissions(array $permissions, callable|bool|null $shouldRun = null)

No description

Details

static array createTable(string $name, callable $definition, callable|bool|null $shouldRun = null)

Parameters

string $name
callable $definition
callable|bool|null $shouldRun

Return Value

array

static array createTableIfNotExists(string $name, callable $definition, callable|bool|null $shouldRun = null)

Parameters

string $name
callable $definition
callable|bool|null $shouldRun

Return Value

array

static array renameTable(string $from, string $to, callable|bool|null $shouldRun = null)

Parameters

string $from
string $to
callable|bool|null $shouldRun

Return Value

array

static array addColumns(string $tableName, array $columnDefinitions, callable|bool|null $shouldRun = null)

Parameters

string $tableName
array $columnDefinitions
callable|bool|null $shouldRun

Return Value

array

static array dropColumns(string $tableName, array $columnDefinitions, callable|bool|null $shouldRun = null)

Parameters

string $tableName
array $columnDefinitions
callable|bool|null $shouldRun

Return Value

array

static array renameColumn(string $tableName, string $from, string $to, callable|bool|null $shouldRun = null)

Parameters

string $tableName
string $from
string $to
callable|bool|null $shouldRun

Return Value

array

static array renameColumns(string $tableName, array $columnNames, callable|bool|null $shouldRun = null)

Parameters

string $tableName
array $columnNames
callable|bool|null $shouldRun

Return Value

array

static array addSettings(array $defaults, callable|bool|null $shouldRun = null)

Add default values for config values.

You generally should use the Settings extender's `default` method instead to register settings.

Parameters

array $defaults
callable|bool|null $shouldRun

Return Value

array

See also

Settings::default

static array addPermissions(array $permissions, callable|bool|null $shouldRun = null)

Parameters

array $permissions
callable|bool|null $shouldRun

Return Value

array