Documentation

Migrate extends BaseCommand
in package

Runs all new migrations.

Table of Contents

$arguments  : array<string|int, mixed>
$commands  : Commands
$description  : string
$group  : string
$logger  : LoggerInterface
$name  : string
$options  : array<string|int, mixed>
$usage  : string
$arguments  : array<string|int, mixed>
the Command's Arguments description
$commands  : Commands
Instance of Commands so commands can call other commands.
$description  : string
the Command's short description
$group  : string
The group the command is lumped under when listing commands.
$logger  : LoggerInterface
The Logger to use for a command
$name  : string
The Command's name
$options  : array<string|int, mixed>
the Command's Options
$usage  : string
the Command's usage
__construct()  : mixed
BaseCommand constructor.
__get()  : mixed
Makes it simple to access our protected properties.
__isset()  : bool
Makes it simple to check our protected properties.
getPad()  : int
Get pad for $key => $value array output
run()  : void
Ensures that all migrations have been run.
setPad()  : string
Pads our string out so that all titles are the same length to nicely line up descriptions.
showHelp()  : mixed
Show Help includes (Usage, Arguments, Description, Options).
call()  : mixed
Can be used by a command to run other commands.
showError()  : mixed
A simple method to display an error with line/file, in child commands.

Properties

$arguments

public array<string|int, mixed> $arguments

$arguments

the Command's Arguments description

protected array<string|int, mixed> $arguments = []

$commands

Instance of Commands so commands can call other commands.

protected Commands $commands

$description

the Command's short description

protected string $description = 'Locates and runs all new migrations against the database.'

$group

The group the command is lumped under when listing commands.

protected string $group = 'Database'

$name

The Command's name

protected string $name = 'migrate'

$options

the Command's Options

protected array<string|int, mixed> $options = ['-n' => 'Set migration namespace', '-g' => 'Set database group', '--all' => 'Set for all namespaces, will ignore (-n) option']

$usage

the Command's usage

protected string $usage = 'migrate [options]'

Methods

__get()

Makes it simple to access our protected properties.

public __get(string $key) : mixed
Parameters
$key : string
Return values
mixed —

__isset()

Makes it simple to check our protected properties.

public __isset(string $key) : bool
Parameters
$key : string
Return values
bool —

getPad()

Get pad for $key => $value array output

public getPad(array<string|int, mixed> $array, int $pad) : int
Parameters
$array : array<string|int, mixed>
$pad : int
Tags
deprecated

Use setPad() instead.

codeCoverageIgnore
Return values
int —

run()

Ensures that all migrations have been run.

public run(array<string|int, mixed> $params) : void
Parameters
$params : array<string|int, mixed>
Return values
void —

setPad()

Pads our string out so that all titles are the same length to nicely line up descriptions.

public setPad(string $item, int $max[, int $extra = 2 ], int $indent) : string
Parameters
$item : string
$max : int
$extra : int = 2

How many extra spaces to add at the end

$indent : int
Return values
string —

showHelp()

Show Help includes (Usage, Arguments, Description, Options).

public showHelp() : mixed
Return values
mixed —

call()

Can be used by a command to run other commands.

protected call(string $command[, array<string|int, mixed> $params = [] ]) : mixed
Parameters
$command : string
$params : array<string|int, mixed> = []
Tags
throws
ReflectionException
Return values
mixed —

showError()

A simple method to display an error with line/file, in child commands.

protected showError(Throwable $e) : mixed
Parameters
$e : Throwable
Return values
mixed —

Search results