W3cubDocs

/Laravel 5.4

MigrateCommand

class MigrateCommand extends BaseCommand (View source)

Traits

ConfirmableTrait

Methods

void __construct(Migrator $migrator)

Create a new migration command instance.
int run(InputInterface $input, OutputInterface $output)

Run the console command.

 from Command
int call(string $command, array $arguments = array())

Call another console command.

 from Command
int callSilent(string $command, array $arguments = array())

Call another console command silently.

 from Command
bool hasArgument(string|int $name)

Determine if the given argument is present.

 from Command
string|array argument(string $key = null)

Get the value of a command argument.

 from Command
array arguments()

Get all of the arguments passed to the command.

 from Command
bool hasOption(string $name)

Determine if the given option is present.

 from Command
string|array option(string $key = null)

Get the value of a command option.

 from Command
array options()

Get all of the options passed to the command.

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

Confirm a question with the user.

 from Command
string ask(string $question, string $default = null)

Prompt the user for input.

 from Command
string anticipate(string $question, array $choices, string $default = null)

Prompt the user for input with auto completion.

 from Command
string askWithCompletion(string $question, array $choices, string $default = null)

Prompt the user for input with auto completion.

 from Command
string secret(string $question, bool $fallback = true)

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

 from Command
string choice(string $question, array $choices, string $default = null, mixed $attempts = null, bool $multiple = null)

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

 from Command
void table(array $headers, Arrayable|array $rows, string $style = 'default')

Format input to textual table.

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

Write a string as information output.

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

Write a string as standard output.

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

Write a string as comment output.

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

Write a string as question output.

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

Write a string as error output.

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

Write a string as warning output.

 from Command
void alert(string $string)

Write a string in an alert box.

 from Command
OutputInterface getOutput()

Get the output implementation.

 from Command
Application getLaravel()

Get the Laravel application instance.

 from Command
void setLaravel(Container $laravel)

Set the Laravel application instance.

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

Confirm before proceeding with the action.

 from ConfirmableTrait
void fire()

Execute the console command.

Details

void __construct(Migrator $migrator)

Create a new migration command instance.

Parameters

Migrator $migrator

Return Value

void

int run(InputInterface $input, OutputInterface $output)

Run the console command.

Parameters

InputInterface $input
OutputInterface $output

Return Value

int

int call(string $command, array $arguments = array())

Call another console command.

Parameters

string $command
array $arguments

Return Value

int

int callSilent(string $command, array $arguments = array())

Call another console command silently.

Parameters

string $command
array $arguments

Return Value

int

bool hasArgument(string|int $name)

Determine if the given argument is present.

Parameters

string|int $name

Return Value

bool

string|array argument(string $key = null)

Get the value of a command argument.

Parameters

string $key

Return Value

string|array

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 option(string $key = null)

Get the value of a command option.

Parameters

string $key

Return Value

string|array

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

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

Prompt the user for input.

Parameters

string $question
string $default

Return Value

string

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

Prompt the user for input with auto completion.

Parameters

string $question
array $choices
string $default

Return Value

string

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

Prompt the user for input with auto completion.

Parameters

string $question
array $choices
string $default

Return Value

string

string 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

string

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

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

Parameters

string $question
array $choices
string $default
mixed $attempts
bool $multiple

Return Value

string

void table(array $headers, Arrayable|array $rows, string $style = 'default')

Format input to textual table.

Parameters

array $headers
Arrayable|array $rows
string $style

Return Value

void

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

Write a string as information output.

Parameters

string $string
null|int|string $verbosity

Return Value

void

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

Write a string as standard output.

Parameters

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

Return Value

void

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

Write a string as comment output.

Parameters

string $string
null|int|string $verbosity

Return Value

void

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

Write a string as question output.

Parameters

string $string
null|int|string $verbosity

Return Value

void

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

Write a string as error output.

Parameters

string $string
null|int|string $verbosity

Return Value

void

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

Write a string as warning output.

Parameters

string $string
null|int|string $verbosity

Return Value

void

void alert(string $string)

Write a string in an alert box.

Parameters

string $string

Return Value

void

OutputInterface getOutput()

Get the output implementation.

Return Value

OutputInterface

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

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

void fire()

Execute the console command.

Return Value

void

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.4/Illuminate/Database/Console/Migrations/MigrateCommand.html