Command

class Command extends Command (View source)

Traits

Macroable

Properties

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.
protected bool $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

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

Register a custom macro.

 from Macroable
static void mixin(object $mixin)

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.
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|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 $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.
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.

Details

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)

Mix another object into the class.

Parameters

object $mixin

Return Value

void

Exceptions

ReflectionException

static bool hasMacro(string $name)

Checks if macro is registered.

Parameters

string $name

Return Value

bool

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()

Create a new console command instance.

Return Value

void

protected void configureUsingFluentDefinition()

Configure the console command using a fluent definition.

Return Value

void

protected void specifyParameters()

Specify the arguments and options on the command.

Return Value

void

int run(InputInterface $input, OutputInterface $output)

Run the console command.

Parameters

InputInterface $input
OutputInterface $output

Return Value

int

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

Execute the console command.

Parameters

InputInterface $input
OutputInterface $output

Return Value

mixed

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

Call another console command.

Parameters

string $command
array $arguments

Return Value

int

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

Call another console command silently.

Parameters

string $command
array $arguments

Return Value

int

protected ArrayInput createInputFromArguments(array $arguments)

Create an input instance from the given arguments.

Parameters

array $arguments

Return Value

ArrayInput

bool hasArgument(string|int $name)

Determine if the given argument is present.

Parameters

string|int $name

Return Value

bool

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

Get the value of a command argument.

Parameters

string|null $key

Return Value

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

Get the value of a command option.

Parameters

string|null $key

Return Value

string|array|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 $choices, string|null $default = null)

Prompt the user for input with auto completion.

Parameters

string $question
array $choices
string|null $default

Return Value

mixed

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

Prompt the user for input with auto completion.

Parameters

string $question
array $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 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.

Parameters

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

Return Value

string

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

Format input to textual table.

Parameters

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

Return Value

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 $style = null, int|string|null $verbosity = null)

Write a string as standard output.

Parameters

string $string
string $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)

Write a string in an alert box.

Parameters

string $string

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

protected array getArguments()

Get the console command arguments.

Return Value

array

protected array getOptions()

Get the console command options.

Return Value

array

OutputStyle getOutput()

Get the output implementation.

Return Value

OutputStyle

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

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.7/Illuminate/Console/Command.html