Command
class Command extends Command (View source)
Properties
| protected Application | $laravel | The Laravel application instance. |
|
| protected InputInterface | $input | The input interface implementation. |
|
| protected OutputInterface | $output | The output interface implementation. |
|
| protected string | $name | The console command name. |
|
| protected string | $description | The console command description. |
Methods
Create a new console command instance.
Specify the arguments and options on the command.
Run the console command.
Execute the console command.
Call another console command.
Call another console command silently.
Get the value of a command argument.
Get the value of a command option.
Confirm a question with the user.
Prompt the user for input.
Prompt the user for input with auto completion.
Prompt the user for input but hide the answer from the console.
Give the user a single choice from an array of answers.
Format input to textual table
Write a string as information output.
Write a string as standard output.
Write a string as comment output.
Write a string as question output.
Write a string as error output.
Get the console command arguments.
Get the console command options.
Get the output implementation.
Get the Laravel application instance.
Details
void
__construct()
Create a new console command instance.
protected void
specifyParameters()
Specify the arguments and options on the command.
int
run(InputInterface $input, OutputInterface $output)
Run the console command.
protected mixed
execute(InputInterface $input, OutputInterface $output)
Execute the console command.
int
call(string $command, array $arguments = array())
Call another console command.
int
callSilent(string $command, array $arguments = array())
Call another console command silently.
string|array
argument(string $key = null)
Get the value of a command argument.
string|array
option(string $key = null)
Get the value of a command option.
bool
confirm(string $question, bool $default = false)
Confirm a question with the user.
string
ask(string $question, string $default = null)
Prompt the user for input.
string
askWithCompletion(string $question, array $choices, string $default = null)
Prompt the user for input with auto completion.
string
secret(string $question, bool $fallback = true)
Prompt the user for input but hide the answer from the console.
bool
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.
void
table(array $headers, array $rows, string $style = 'default')
Format input to textual table
void
info(string $string)
Write a string as information output.
void
line(string $string)
Write a string as standard output.
void
comment(string $string)
Write a string as comment output.
void
question(string $string)
Write a string as question output.
void
error(string $string)
Write a string as error output.
protected array
getArguments()
Get the console command arguments.
protected array
getOptions()
Get the console command options.
OutputInterface
getOutput()
Get the output implementation.
Application
getLaravel()
Get the Laravel application instance.
void
setLaravel(Application $laravel)
Set the Laravel application instance.