InteractsWithIO

trait InteractsWithIO (View source)

Properties

protected InputInterface $input The input interface implementation.
protected OutputStyle $output The output interface implementation.
protected int $verbosity The default verbosity of output commands.
protected array $verbosityMap The mapping between human readable verbosity levels and Symfony's OutputInterface.

Methods

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

Prompt the user for input with auto completion.
mixed askWithCompletion(string $question, array|callable $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|array choice(string $question, array $choices, string|null $default = null, mixed|null $attempts = null, bool $multiple = false)

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 setInput(InputInterface $input)

Set the input interface implementation.
void setOutput(OutputStyle $output)

Set the output interface implementation.
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.
OutputStyle getOutput()

Get the output implementation.

Details

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

Get the value of a command option.

Parameters

string|null $key

Return Value

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

Prompt the user for input with auto completion.

Parameters

string $question
array|callable $choices
string|null $default

Return Value

mixed

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

Prompt the user for input with auto completion.

Parameters

string $question
array|callable $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|array choice(string $question, array $choices, string|null $default = null, mixed|null $attempts = null, bool $multiple = false)

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

Parameters

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

Return Value

string|array

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

Write a string as standard output.

Parameters

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

void setInput(InputInterface $input)

Set the input interface implementation.

Parameters

InputInterface $input

Return Value

void

void setOutput(OutputStyle $output)

Set the output interface implementation.

Parameters

OutputStyle $output

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

OutputStyle getOutput()

Get the output implementation.

Return Value

OutputStyle

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/7.x/Illuminate/Console/Concerns/InteractsWithIO.html