InteractsWithIO

trait InteractsWithIO (View source)

Свойства

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

choice(string $question, array $choices, string|null $default = null, mixed|null $attempts = null, bool|null $multiple = null)

Предложить пользователю выбрать один вариант из списка ответов.

void

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

Форматирование ввода в текстовую таблицу.

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

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|int

$name

Возвращаемое значение

bool

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

Получить значение аргумента команды.

Параметры

string|null

$key

Возвращаемое значение

string|array|null

array arguments()

Получить все аргументы, переданные команде.

Возвращаемое значение

array

bool hasOption(string $name)

Определяет, присутствует ли заданный параметр.

Параметры

string

$name

Возвращаемое значение

bool

string|array|bool|null option(string|null $key = null)

Получить значение параметра команды.

Параметры

string|null

$key

Возвращаемое значение

string|array|bool|null

array options()

Получить все параметры, переданные команде.

Возвращаемое значение

array

bool confirm(string $question, bool $default = false)

Подтвердить вопрос у пользователя.

Параметры

string	$question
bool	$default

Возвращаемое значение

bool

mixed ask(string $question, string|null $default = null)

Задать вопрос пользователю и получить его ответ.

Параметры

string	$question
string\|null	$default

Возвращаемое значение

mixed

END_OF_DOCUMENT_MARKER

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

Запросить у пользователя ввод с автодополнением.

Параметры

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

Возвращаемое значение

mixed

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

Запросить у пользователя ввод с автодополнением.

Параметры

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

Возвращаемое значение

mixed

mixed secret(string $question, bool $fallback = true)

Запросить у пользователя ввод, скрыв ответ в консоли.

Параметры

string	$question
bool	$fallback

Возвращаемое значение

mixed

string choice(string $question, array $choices, string|null $default = null, mixed|null $attempts = null, bool|null $multiple = null)

Предложить пользователю выбрать один вариант из списка ответов.

Параметры

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

Возвращаемое значение

string

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

Форматировать ввод в текстовую таблицу.

Параметры

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

Возвращаемое значение

void

void info(string $string, int|string|null $verbosity = null)

Вывести строку как информационное сообщение.

Параметры

string	$string
int\|string\|null	$verbosity

Возвращаемое значение

void

void line(string $string, string|null $style = null, int|string|null $verbosity = null)

Вывести строку в стандартный вывод.

Параметры

string	$string
string\|null	$style
int\|string\|null	$verbosity

Возвращаемое значение

void

void comment(string $string, int|string|null $verbosity = null)

Вывести строку как комментарий.

Параметры

string	$string
int\|string\|null	$verbosity

Возвращаемое значение

void

void question(string $string, int|string|null $verbosity = null)

Вывести строку как вопрос.

Параметры

string	$string
int\|string\|null	$verbosity

Возвращаемое значение

void

void error(string $string, int|string|null $verbosity = null)

Вывести строку как сообщение об ошибке.

Параметры

string	$string
int\|string\|null	$verbosity

Возвращаемое значение

void

void warn(string $string, int|string|null $verbosity = null)

Вывести строку как предупреждение.

Параметры

string	$string
int\|string\|null	$verbosity

Возвращаемое значение

void

void alert(string $string)

Вывести строку в всплывающем окне с сообщением.

Параметры

string

$string

Возвращаемое значение

void

void setInput(InputInterface $input)

Установить реализацию интерфейса ввода.

Параметры

InputInterface

$input

Возвращаемое значение

void

void setOutput(OutputStyle $output)

Установить реализацию интерфейса вывода.

Параметры

OutputStyle

$output

Возвращаемое значение

void

protected void setVerbosity(string|int $level)

Установить уровень подробности.

Параметры

string|int

$level

Возвращаемое значение

void

protected int parseVerbosity(string|int|null $level = null)

Получить уровень подробности в терминах уровня OutputInterface Symfony.

Параметры

string|int|null

$level

Возвращаемое значение

int

OutputStyle getOutput()

Получить реализацию вывода.

Возвращаемое значение

OutputStyle

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