class MigrateCommand extends BaseCommand implements Isolatable (View source)

Traits

Properties

protected Factory internal $components

The console components factory.

from  InteractsWithIO
protected InputInterface $input

The input interface implementation.

from  InteractsWithIO
protected OutputStyle $output

The output interface implementation.

from  InteractsWithIO
protected int $verbosity

The default verbosity of output commands.

from  InteractsWithIO
protected array $verbosityMap

The mapping between human readable verbosity levels and Symfony's OutputInterface.

from  InteractsWithIO
protected Signals|null $signals

The signal registrar instance.

from  InteractsWithSignals
static protected array $macros

The registered string macros.

from  Macroable
protected Application $laravel

The Laravel application instance.

from  Command
protected string $signature

The name and signature of the console command.

protected string $name

The console command name.

from  Command
protected string $description

The console command description.

protected string $help

The console command help text.

from  Command
protected bool $hidden

Indicates whether the command should be shown in the Artisan command list.

from  Command
protected bool $isolated

Indicates whether only one instance of the command can run at any given time.

from  Command
protected int $isolatedExitCode

The default exit code for isolated commands.

from  Command
protected array $aliases

The console command name aliases.

from  Command
protected Migrator $migrator

The migrator instance.

protected Dispatcher $dispatcher

The event dispatcher instance.

Methods

Command
resolveCommand(Command|string $command)

Resolve the console command instance for the given command.

int
call(Command|string $command, array $arguments = [])

Call another console command.

int
callSilent(Command|string $command, array $arguments = [])

Call another console command without output.

int
callSilently(Command|string $command, array $arguments = [])

Call another console command without output.

int
runCommand(Command|string $command, array $arguments, OutputInterface $output)

Run the given the console command.

ArrayInput
createInputFromArguments(array $arguments)

Create an input instance from the given arguments.

array
context()

Get all of the context passed to the command.

void
specifyParameters()

Specify the arguments and options on the command.

array
getArguments()

Get the console command arguments.

array
getOptions()

Get the console command options.

bool
hasArgument(string|int $name)

Determine if the given argument is present.

array|string|bool|null
argument(string|null $key = null)

Get the value of a command argument.

array
arguments()

Get all of the arguments passed to the command.

bool
hasOption(string $name)

Determine if the given option is present.

string|array|bool|null
option(string|null $key = null)

Get the value of a command option.

array
options()

Get all of the options passed to the command.

bool
confirm(string $question, bool $default = false)

Confirm a question with the user.

mixed
ask(string $question, string|null $default = null)

Prompt the user for input.

mixed
anticipate(string $question, array|callable $choices, string|null $default = null)

Prompt the user for input with auto completion.

mixed
askWithCompletion(string $question, array|callable $choices, string|null $default = null)

Prompt the user for input with auto completion.

mixed
secret(string $question, bool $fallback = true)

Prompt the user for input but hide the answer from the console.

string|array
choice(string $question, array $choices, string|int|null $default = null, mixed|null $attempts = null, bool $multiple = false)

Give the user a single choice from an array of answers.

void
table(array $headers, Arrayable|array $rows, TableStyle|string $tableStyle = 'default', array $columnStyles = [])

Format input to textual table.

mixed|void
withProgressBar(iterable|int $totalSteps, Closure $callback)

Execute a given callback while advancing a progress bar.

void
info(string $string, int|string|null $verbosity = null)

Write a string as information output.

void
line(string $string, string|null $style = null, int|string|null $verbosity = null)

Write a string as standard output.

void
comment(string $string, int|string|null $verbosity = null)

Write a string as comment output.

void
question(string $string, int|string|null $verbosity = null)

Write a string as question output.

void
error(string $string, int|string|null $verbosity = null)

Write a string as error output.

void
warn(string $string, int|string|null $verbosity = null)

Write a string as warning output.

void
alert(string $string, int|string|null $verbosity = null)

Write a string in an alert box.

$this
newLine(int $count = 1)

Write a blank line.

void
setInput(InputInterface $input)

Set the input interface implementation.

void
setOutput(OutputStyle $output)

Set the output interface implementation.

void
setVerbosity(string|int $level)

Set the verbosity level.

int
parseVerbosity(string|int|null $level = null)

Get the verbosity level in terms of Symfony's OutputInterface level.

getOutput()

Get the output implementation.

void
trap(iterable<array-key,int>|int $signals, $callback)

Define a callback to be run when the given signal(s) occurs.

void
untrap()

Untrap signal handlers set within the command's handler.

void
interact(InputInterface $input, OutputInterface $output)

Interact with the user before validating the input.

void
promptForMissingArguments(InputInterface $input, OutputInterface $output)

Prompt the user for any missing arguments.

array
promptForMissingArgumentsUsing()

Prompt for missing input arguments using the returned questions.

void
afterPromptingForMissingArguments(InputInterface $input, OutputInterface $output)

Perform actions after the user was prompted for missing arguments.

bool
didReceiveOptions(InputInterface $input)

Whether the input contains any options that differ from the default values.

static void
macro(string $name, object|callable $macro)

Register a custom macro.

static void
mixin(object $mixin, bool $replace = true)

Mix another object into the class.

static bool
hasMacro(string $name)

Checks if macro is registered.

static void
flushMacros()

Flush the existing macros.

static mixed
__callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

mixed
__call(string $method, array $parameters)

Dynamically handle calls to the class.

void
__construct(Migrator $migrator, Dispatcher $dispatcher)

Create a new migration command instance.

void
configureUsingFluentDefinition()

Configure the console command using a fluent definition.

from  Command
void
configureIsolation()

Configure the console command for isolation.

from  Command
int
run(InputInterface $input, OutputInterface $output)

Run the console command.

from  Command
int
execute(InputInterface $input, OutputInterface $output)

Execute the console command.

from  Command
commandIsolationMutex()

Get a command isolation mutex instance for the command.

from  Command
bool
isHidden()

{@inheritdoc}

from  Command
setHidden(bool $hidden = true)

{@inheritdoc}

from  Command
getLaravel()

Get the Laravel application instance.

from  Command
void
setLaravel(Container $laravel)

Set the Laravel application instance.

from  Command
array
getMigrationPaths()

Get all of the migration paths.

bool
usingRealPath()

Determine if the given path(s) are pre-resolved "real" paths.

string
getMigrationPath()

Get the path to the migration directory.

bool
confirmToProceed(string $warning = 'Application In Production', Closure|bool|null $callback = null)

Confirm before proceeding with the action.

getDefaultConfirmCallback()

Get the default confirmation callback.

int
handle()

Execute the console command.

void
prepareDatabase()

Prepare the migration database for running.

bool
repositoryExists()

Determine if the migrator repository exists.

bool
createMissingSqliteDatabase(string $path)

Create a missing SQLite database.

bool
createMissingMysqlDatabase($connection)

Create a missing MySQL database.

void
loadSchemaState()

Load the schema state to seed the initial database schema structure.

string
schemaPath(Connection $connection)

Get the path to the stored schema for the given connection.

Details

abstract protected Command resolveCommand(Command|string $command)

Resolve the console command instance for the given command.

Parameters

Command|string $command

Return Value

Command

int call(Command|string $command, array $arguments = [])

Call another console command.

Parameters

Command|string $command
array $arguments

Return Value

int

int callSilent(Command|string $command, array $arguments = [])

Call another console command without output.

Parameters

Command|string $command
array $arguments

Return Value

int

int callSilently(Command|string $command, array $arguments = [])

Call another console command without output.

Parameters

Command|string $command
array $arguments

Return Value

int

protected int runCommand(Command|string $command, array $arguments, OutputInterface $output)

Run the given the console command.

Parameters

Command|string $command
array $arguments
OutputInterface $output

Return Value

int

protected ArrayInput createInputFromArguments(array $arguments)

Create an input instance from the given arguments.

Parameters

array $arguments

Return Value

ArrayInput

protected array context()

Get all of the context passed to the command.

Return Value

array

protected void specifyParameters()

Specify the arguments and options on the command.

Return Value

void

protected array getArguments()

Get the console command arguments.

Return Value

array

protected array getOptions()

Get the console command options.

Return Value

array

bool hasArgument(string|int $name)

Determine if the given argument is present.

Parameters

string|int $name

Return Value

bool

array|string|bool|null argument(string|null $key = null)

Get the value of a command argument.

Parameters

string|null $key

Return Value

array|string|bool|null

array arguments()

Get all of the arguments passed to the command.

Return Value

array

bool hasOption(string $name)

Determine if the given option is present.

Parameters

string $name

Return Value

bool

string|array|bool|null option(string|null $key = null)

Get the value of a command option.

Parameters

string|null $key

Return Value

string|array|bool|null

array options()

Get all of the options passed to the command.

Return Value

array

bool confirm(string $question, bool $default = false)

Confirm a question with the user.

Parameters

string $question
bool $default

Return Value

bool

mixed ask(string $question, string|null $default = null)

Prompt the user for input.

Parameters

string $question
string|null $default

Return Value

mixed

mixed anticipate(string $question, array|callable $choices, string|null $default = null)

Prompt the user for input with auto completion.

Parameters

string $question
array|callable $choices
string|null $default

Return Value

mixed

mixed askWithCompletion(string $question, array|callable $choices, string|null $default = null)

Prompt the user for input with auto completion.

Parameters

string $question
array|callable $choices
string|null $default

Return Value

mixed

mixed secret(string $question, bool $fallback = true)

Prompt the user for input but hide the answer from the console.

Parameters

string $question
bool $fallback

Return Value

mixed

string|array choice(string $question, array $choices, string|int|null $default = null, mixed|null $attempts = null, bool $multiple = false)

Give the user a single choice from an array of answers.

Parameters

string $question
array $choices
string|int|null $default
mixed|null $attempts
bool $multiple

Return Value

string|array

void table(array $headers, Arrayable|array $rows, TableStyle|string $tableStyle = 'default', array $columnStyles = [])

Format input to textual table.

Parameters

array $headers
Arrayable|array $rows
TableStyle|string $tableStyle
array $columnStyles

Return Value

void

mixed|void withProgressBar(iterable|int $totalSteps, Closure $callback)

Execute a given callback while advancing a progress bar.

Parameters

iterable|int $totalSteps
Closure $callback

Return Value

mixed|void

void info(string $string, int|string|null $verbosity = null)

Write a string as information output.

Parameters

string $string
int|string|null $verbosity

Return Value

void

void line(string $string, string|null $style = null, int|string|null $verbosity = null)

Write a string as standard output.

Parameters

string $string
string|null $style
int|string|null $verbosity

Return Value

void

void comment(string $string, int|string|null $verbosity = null)

Write a string as comment output.

Parameters

string $string
int|string|null $verbosity

Return Value

void

void question(string $string, int|string|null $verbosity = null)

Write a string as question output.

Parameters

string $string
int|string|null $verbosity

Return Value

void

void error(string $string, int|string|null $verbosity = null)

Write a string as error output.

Parameters

string $string
int|string|null $verbosity

Return Value

void

void warn(string $string, int|string|null $verbosity = null)

Write a string as warning output.

Parameters

string $string
int|string|null $verbosity

Return Value

void

void alert(string $string, int|string|null $verbosity = null)

Write a string in an alert box.

Parameters

string $string
int|string|null $verbosity

Return Value

void

$this newLine(int $count = 1)

Write a blank line.

Parameters

int $count

Return Value

$this

void setInput(InputInterface $input)

Set the input interface implementation.

Parameters

InputInterface $input

Return Value

void

void setOutput(OutputStyle $output)

Set the output interface implementation.

Parameters

OutputStyle $output

Return Value

void

protected void setVerbosity(string|int $level)

Set the verbosity level.

Parameters

string|int $level

Return Value

void

protected int parseVerbosity(string|int|null $level = null)

Get the verbosity level in terms of Symfony's OutputInterface level.

Parameters

string|int|null $level

Return Value

int

OutputStyle getOutput()

Get the output implementation.

Return Value

OutputStyle

void trap(iterable<array-key,int>|int $signals, $callback)

Define a callback to be run when the given signal(s) occurs.

Parameters

iterable<array-key,int>|int $signals
$callback

Return Value

void

void untrap()

internal  
 

Untrap signal handlers set within the command's handler.

Return Value

void

protected void interact(InputInterface $input, OutputInterface $output)

Interact with the user before validating the input.

Parameters

InputInterface $input
OutputInterface $output

Return Value

void

protected void promptForMissingArguments(InputInterface $input, OutputInterface $output)

Prompt the user for any missing arguments.

Parameters

InputInterface $input
OutputInterface $output

Return Value

void

protected array promptForMissingArgumentsUsing()

Prompt for missing input arguments using the returned questions.

Return Value

array

protected void afterPromptingForMissingArguments(InputInterface $input, OutputInterface $output)

Perform actions after the user was prompted for missing arguments.

Parameters

InputInterface $input
OutputInterface $output

Return Value

void

protected bool didReceiveOptions(InputInterface $input)

Whether the input contains any options that differ from the default values.

Parameters

InputInterface $input

Return Value

bool

static void macro(string $name, object|callable $macro)

Register a custom macro.

Parameters

string $name
object|callable $macro

Return Value

void

static void mixin(object $mixin, bool $replace = true)

Mix another object into the class.

Parameters

object $mixin
bool $replace

Return Value

void

Exceptions

ReflectionException

static bool hasMacro(string $name)

Checks if macro is registered.

Parameters

string $name

Return Value

bool

static void flushMacros()

Flush the existing macros.

Return Value

void

static mixed __callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

mixed __call(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

void __construct(Migrator $migrator, Dispatcher $dispatcher)

Create a new migration command instance.

Parameters

Migrator $migrator
Dispatcher $dispatcher

Return Value

void

protected void configureUsingFluentDefinition()

Configure the console command using a fluent definition.

Return Value

void

protected void configureIsolation()

Configure the console command for isolation.

Return Value

void

int run(InputInterface $input, OutputInterface $output)

Run the console command.

Parameters

InputInterface $input
OutputInterface $output

Return Value

int

protected int execute(InputInterface $input, OutputInterface $output)

Execute the console command.

Parameters

InputInterface $input
OutputInterface $output

Return Value

int

protected CommandMutex commandIsolationMutex()

Get a command isolation mutex instance for the command.

Return Value

CommandMutex

bool isHidden()

{@inheritdoc}

Return Value

bool

Command setHidden(bool $hidden = true)

{@inheritdoc}

Parameters

bool $hidden

Return Value

Command

Application getLaravel()

Get the Laravel application instance.

Return Value

Application

void setLaravel(Container $laravel)

Set the Laravel application instance.

Parameters

Container $laravel

Return Value

void

protected array getMigrationPaths()

Get all of the migration paths.

Return Value

array

protected bool usingRealPath()

Determine if the given path(s) are pre-resolved "real" paths.

Return Value

bool

protected string getMigrationPath()

Get the path to the migration directory.

Return Value

string

bool confirmToProceed(string $warning = 'Application In Production', Closure|bool|null $callback = null)

Confirm before proceeding with the action.

This method only asks for confirmation in production.

Parameters

string $warning
Closure|bool|null $callback

Return Value

bool

protected Closure getDefaultConfirmCallback()

Get the default confirmation callback.

Return Value

Closure

int handle()

Execute the console command.

Return Value

int

protected void prepareDatabase()

Prepare the migration database for running.

Return Value

void

protected bool repositoryExists()

Determine if the migrator repository exists.

Return Value

bool

protected bool createMissingSqliteDatabase(string $path)

Create a missing SQLite database.

Parameters

string $path

Return Value

bool

protected bool createMissingMysqlDatabase($connection)

Create a missing MySQL database.

Parameters

$connection

Return Value

bool

protected void loadSchemaState()

Load the schema state to seed the initial database schema structure.

Return Value

void

protected string schemaPath(Connection $connection)

Get the path to the stored schema for the given connection.

Parameters

Connection $connection

Return Value

string