class Command extends Command (View source)
Macroable |
static protected array | $macros | The registered string macros. | from Macroable |
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. |
static void | macro(string $name, object|callable $macro) Register a custom macro. | from Macroable |
static void | mixin(object $mixin, bool $replace = true) Mix another object into the class. | from Macroable |
static bool | hasMacro(string $name) Checks if macro is registered. | from Macroable |
static mixed | __callStatic(string $method, array $parameters) Dynamically handle calls to the class. | from Macroable |
mixed | __call(string $method, array $parameters) Dynamically handle calls to the class. | from Macroable |
void | __construct() Create a new console command instance. | |
void | configureUsingFluentDefinition() Configure the console command using a fluent definition. | |
void | specifyParameters() Specify the arguments and options on the command. | |
int | run(InputInterface $input, OutputInterface $output) Run the console command. | |
mixed | execute(InputInterface $input, OutputInterface $output) Execute the console command. | |
int | call(string $command, array $arguments = []) Call another console command. | |
int | callSilent(string $command, array $arguments = []) Call another console command silently. | |
ArrayInput | createInputFromArguments(array $arguments) Create an input instance from the given arguments. | |
array | context() Get all of the context passed to the command. | |
bool | hasArgument(string|int $name) Determine if the given argument is present. | |
string|array|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 $choices, string|null $default = null) Prompt the user for input with auto completion. | |
mixed | askWithCompletion(string $question, array $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 | choice(string $question, array $choices, string|null $default = null, mixed|null $attempts = null, bool|null $multiple = null) Give the user a single choice from an array of answers. | |
void | table(array $headers, Arrayable|array $rows, string $tableStyle = 'default', array $columnStyles = []) Format input to textual table. | |
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) Write a string in an alert box. | |
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. | |
isHidden() {@inheritdoc} | ||
setHidden($hidden) {@inheritdoc} | ||
array | getArguments() Get the console command arguments. | |
array | getOptions() Get the console command options. | |
OutputStyle | getOutput() Get the output implementation. | |
Application | getLaravel() Get the Laravel application instance. | |
void | setLaravel(Container $laravel) Set the Laravel application instance. |
Register a custom macro.
Mix another object into the class.
Checks if macro is registered.
Dynamically handle calls to the class.
Dynamically handle calls to the class.
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.
Create an input instance from the given arguments.
Get all of the context passed to the command.
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.
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.
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.
{@inheritdoc}
{@inheritdoc}
Get the console command arguments.
Get the console command options.
Get the output implementation.
Get the Laravel application instance.
Set the Laravel application instance.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.8/Illuminate/Console/Command.html