InteractsWithIO
trait InteractsWithIO (View source)
Properties
| protected Factory internal | $components | The console components factory. |
|
| 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
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
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|int|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, TableStyle|string $tableStyle = 'default', array $columnStyles = [])
Format input to textual table.
mixed|void
withProgressBar(iterable|int $totalSteps, Closure $callback)
Execute a given callback while advancing a progress bar.
void
line(string $string, string|null $style = null, int|string|null $verbosity = null)
Write a string as standard output.