InteractsWithIO
интерфейс InteractsWithIO (Просмотреть исходный код)
Свойства
| protected InputInterface | $input | Реализация интерфейса ввода. | |
| protected OutputStyle | $output | Реализация интерфейса вывода. | |
| protected int | $verbosity | Уровень подробности по умолчанию для команд вывода. | |
| protected array | $verbosityMap | Сопоставление удобочитаемых уровней подробности и уровней OutputInterface Symfony. |
Методы
| bool | hasArgument(string|int $name)
Определяет, присутствует ли заданный аргумент. | |
| string|array|null | argument(string|null $key = null)
Получение значения аргумента команды. | |
| array | arguments()
Получение всех аргументов, переданных команде. | |
| bool | hasOption(string $name)
Определяет, присутствует ли заданный параметр. | |
| string|array|bool|null | option(string|null $key = null)
Получение значения параметра команды. | |
| array | options()
Получение всех параметров, переданных команде. | |
| bool | confirm(string $question, bool $default = false)
Подтверждение вопроса у пользователя. | |
| mixed | ask(string $question, string|null $default = null)
Запрос ввода данных от пользователя. | |
| mixed | anticipate(string $question, array|callable $choices, string|null $default = null)
Запрос ввода данных от пользователя с автодополнением. | |
| mixed | askWithCompletion(string $question, array|callable $choices, string|null $default = null)
Запрос ввода данных от пользователя с автодополнением. | |
| mixed | secret(string $question, bool $fallback = true)
Запрос ввода данных от пользователя, скрывая ответ в консоли. | |
| string|array | choice(string $question, array $choices, string|null $default = null, mixed|null $attempts = null, bool $multiple = false)
Предложение пользователю выбрать один вариант из массива ответов. | |
| void | table(array $headers, Arrayable|array $rows, string $tableStyle = 'default', array $columnStyles = [])
Форматирование ввода в таблицу. | |
| mixed|void | withProgressBar(iterable|int $totalSteps, Closure $callback)
Выполнение заданного обратного вызова с прогресс-баром. | |
| void | info(string $string, int|string|null $verbosity = null)
Вывод строки как информации. | |
| void | line(string $string, string|null $style = null, int|string|null $verbosity = null)
Вывод строки как стандартного вывода. | |
| void | comment(string $string, int|string|null $verbosity = null)
Вывод строки как комментарий. | |
| void | question(string $string, int|string|null $verbosity = null)
Вывод строки как вопрос. | |
| void | error(string $string, int|string|null $verbosity = null)
Вывод строки как ошибка. | |
| void | warn(string $string, int|string|null $verbosity = null)
Вывод строки как предупреждение. | |
| void | alert(string $string)
Вывод строки в виде предупреждающего окна. | |
| void | newLine(int $count = 1)
Вывод пустой строки. | |
| void | setInput(InputInterface $input)
Установка реализации интерфейса ввода. | |
| void | setOutput(OutputStyle $output)
Установка реализации интерфейса вывода. | |
| void | setVerbosity(string|int $level)
Установка уровня подробности. | |
| int | parseVerbosity(string|int|null $level = null)
Получение уровня подробности с точки зрения уровня OutputInterface Symfony. | |
| OutputStyle | getOutput()
Получение реализации вывода. |
Подробности
bool hasArgument(string|int $name)
Определяет, присутствует ли заданный аргумент.
string|array|null argument(string|null $key = null)
Получение значения аргумента команды.
array arguments()
Получение всех аргументов, переданных команде.
bool hasOption(string $name)
Определяет, присутствует ли заданный параметр.
string|array|bool|null option(string|null $key = null)
Получение значения параметра команды.
array options()
Получение всех параметров, переданных команде.
bool confirm(string $question, bool $default = false)
Подтверждение вопроса у пользователя.
mixed ask(string $question, string|null $default = null)
Запросить у пользователя ввод.
mixed anticipate(string $question, array|callable $choices, string|null $default = null)
Запросить у пользователя ввод с автозавершением.
mixed askWithCompletion(string $question, array|callable $choices, string|null $default = null)
Запросить у пользователя ввод с автозавершением.
mixed secret(string $question, bool $fallback = true)
Запросить у пользователя ввод, скрывая ответ в консоли.
string|array choice(string $question, array $choices, string|null $default = null, mixed|null $attempts = null, bool $multiple = false)
Предложить пользователю одиночный выбор из массива ответов.
void table(array $headers, Arrayable|array $rows, string $tableStyle = 'default', array $columnStyles = [])
Форматировать ввод в текстовую таблицу.
mixed|void withProgressBar(iterable|int $totalSteps, Closure $callback)
Выполнить заданный обратный вызов, продвигая полосу прогресса.
void info(string $string, int|string|null $verbosity = null)
Вывести строку как информацию.
void line(string $string, string|null $style = null, int|string|null $verbosity = null)
Вывести строку как стандартный вывод.
void comment(string $string, int|string|null $verbosity = null)
Вывести строку как комментарий.
void question(string $string, int|string|null $verbosity = null)
Вывести строку как вопрос.
void error(string $string, int|string|null $verbosity = null)
Вывести строку как ошибку.
void warn(string $string, int|string|null $verbosity = null)
Вывести строку как предупреждение.
void alert(string $string)
Вывести строку в всплывающем окне.
void newLine(int $count = 1)
Вывести пустую строку.
void setInput(InputInterface $input)
Установить реализацию интерфейса ввода.
void setOutput(OutputStyle $output)
Установить реализацию интерфейса вывода.
protected void setVerbosity(string|int $level)
Установить уровень подробности.
protected int parseVerbosity(string|int|null $level = null)
Получить уровень подробности с точки зрения уровня OutputInterface Symfony.
OutputStyle getOutput()
Получить реализацию вывода.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/8.x/Illuminate/Console/Concerns/InteractsWithIO.html
