InteractsWithIO
trait InteractsWithIO (View source)
Properties
| protected Factory | $components | The console components factory. |
|
| protected InputInterface | $input | The input interface implementation. |
|
| protected OutputStyle | $output | The output interface implementation. |
|
| protected | $verbosity | The default verbosity of output commands. |
|
| protected | $verbosityMap | The mapping between human-readable verbosity levels and Symfony's OutputInterface. |
Methods
Determine if the given argument is present.
Get the value of a command argument.
Get all of the arguments passed to the command.
Determine whether the option is defined in the command signature.
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.
Execute a given callback while advancing a progress bar.
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.
Write a blank line.
Set the input interface implementation.
Set the verbosity level.
Get the verbosity level in terms of Symfony's OutputInterface level.
Get the output implementation.
Get the output component factory implementation.
Details
bool
hasArgument(string|int $name)
Determine if the given argument is present.
argument(string|null $key = null)
Get the value of a command argument.
(array|string|float|int|bool|null)[]
arguments()
Get all of the arguments passed to the command.
bool
hasOption(string $name)
Determine whether the option is defined in the command signature.
option(string|null $key = null)
Get the value of a command option.
(array|string|float|int|bool|null)[]
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, $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|int|null $default = null, ?positive-int $attempts = null, bool $multiple = false)
Give the user a single choice from an array of answers.
void
table(array $headers, Arrayable|array $rows, TableStyle|string $tableStyle = 'default', array $columnStyles = [])
Format input to textual table.
mixed|void
withProgressBar(TValue>|int $totalSteps, Closure $callback)
Execute a given callback while advancing a progress bar.
void
info(string $string, $verbosity = null)
Write a string as information output.
void
line(string $string, $style = null, $verbosity = null)
Write a string as standard output.
void
comment(string $string, $verbosity = null)
Write a string as comment output.
void
question(string $string, $verbosity = null)
Write a string as question output.
void
error(string $string, $verbosity = null)
Write a string as error output.
void
warn(string $string, $verbosity = null)
Write a string as warning output.
void
alert(string $string, $verbosity = null)
Write a string in an alert box.
$this
newLine(int $count = 1)
Write a blank line.
void
setInput(InputInterface $input)
Set the input interface implementation.
void
setOutput(OutputStyle $output)
Set the output interface implementation.
protected void
setVerbosity($level)
Set the verbosity level.
protected int
parseVerbosity($level = null)
Get the verbosity level in terms of Symfony's OutputInterface level.
OutputStyle
getOutput()
Get the output implementation.
Factory
outputComponents()
Get the output component factory implementation.