Command
class Command extends Command
Properties
| protected Application | $laravel | The Laravel application instance. |
|
| protected InputInterface | $input | The input interface implementation. |
|
| protected OutputStyle | $output | The output interface implementation. |
|
| protected string | $signature | The name and signature of the console command. |
|
| protected string | $name | The console command name. |
|
| protected string | $description | The console command description. |
|
| $hidden | Indicates whether the command should be shown in the Artisan command list. |
||
| protected int | $verbosity | The default verbosity of output commands. |
|
| protected array | $verbosityMap | The mapping between human readable verbosity levels and Symfony's OutputInterface. |
Methods
Create a new console command instance.
Configure the console command using a fluent definition.
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.
Determine if the given argument is present.
Get the value of a command argument.
Get all of the arguments passed to the command.
Determine if the given option is present.
Get the value of a command option.
Get all of the options passed to the command.
Confirm a question with the user.
Prompt the user for input.
Prompt the user for input with auto completion.
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.
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.
Write a string as warning output.
Write a string in an alert box.
Set the verbosity level.
Get the verbosity level in terms of Symfony's OutputInterface level.
Get the console command arguments.
Get the console command options.
Get the output implementation.
Get the Laravel application instance.
Details
at line 92
void
__construct()
Create a new console command instance.
at line 120
protected void
configureUsingFluentDefinition()
Configure the console command using a fluent definition.
at line 143
protected void
specifyParameters()
Specify the arguments and options on the command.
at line 164
int
run(InputInterface $input, OutputInterface $output)
Run the console command.
at line 178
protected mixed
execute(InputInterface $input, OutputInterface $output)
Execute the console command.
at line 192
int
call(string $command, array $arguments = [])
Call another console command.
at line 208
int
callSilent(string $command, array $arguments = [])
Call another console command silently.
at line 223
bool
hasArgument(string|int $name)
Determine if the given argument is present.
at line 234
string|array
argument(string|null $key = null)
Get the value of a command argument.
at line 248
array
arguments()
Get all of the arguments passed to the command.
at line 259
bool
hasOption(string $name)
Determine if the given option is present.
at line 270
string|array
option(string $key = null)
Get the value of a command option.
at line 284
array
options()
Get all of the options passed to the command.
at line 296
bool
confirm(string $question, bool $default = false)
Confirm a question with the user.
at line 308
string
ask(string $question, string $default = null)
Prompt the user for input.
at line 321
string
anticipate(string $question, array $choices, string $default = null)
Prompt the user for input with auto completion.
at line 334
string
askWithCompletion(string $question, array $choices, string $default = null)
Prompt the user for input with auto completion.
at line 350
string
secret(string $question, bool $fallback = true)
Prompt the user for input but hide the answer from the console.
at line 369
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.
at line 386
void
table(array $headers, Arrayable|array $rows, string $style = 'default')
Format input to textual table.
at line 404
void
info(string $string, null|int|string $verbosity = null)
Write a string as information output.
at line 417
void
line(string $string, string $style = null, null|int|string $verbosity = null)
Write a string as standard output.
at line 431
void
comment(string $string, null|int|string $verbosity = null)
Write a string as comment output.
at line 443
void
question(string $string, null|int|string $verbosity = null)
Write a string as question output.
at line 455
void
error(string $string, null|int|string $verbosity = null)
Write a string as error output.
at line 467
void
warn(string $string, null|int|string $verbosity = null)
Write a string as warning output.
at line 484
void
alert(string $string)
Write a string in an alert box.
at line 499
protected void
setVerbosity(string|int $level)
Set the verbosity level.
at line 510
protected int
parseVerbosity(string|int $level = null)
Get the verbosity level in terms of Symfony's OutputInterface level.
at line 526
protected array
getArguments()
Get the console command arguments.
at line 536
protected array
getOptions()
Get the console command options.
at line 546
OutputInterface
getOutput()
Get the output implementation.
at line 556
Application
getLaravel()
Get the Laravel application instance.
at line 567
void
setLaravel(Container $laravel)
Set the Laravel application instance.