DialogHelper ^deprecated

setHelperSet(HelperSet $helperSet = null)

Устанавливает набор помощников, связанных с этим помощником.

Параметры

HelperSet

$helperSet

Экземпляр HelperSet

HelperSet getHelperSet()

Получает набор помощников, связанных с этим помощником.

Значение возврата

HelperSet

Экземпляр HelperSet

static int strlen(string $string)

Возвращает длину строки, используя mb_strwidth, если оно доступно.

Параметры

string

$string

Строка, для которой нужно проверить длину

Значение возврата

int	Длина строки

static formatTime($secs)

Параметры

$secs

static formatMemory($memory)

Параметры

$memory

static strlenWithoutDecoration(OutputFormatterInterface $formatter, $string)

Параметры

OutputFormatterInterface	$formatter
	$string

static removeDecoration(OutputFormatterInterface $formatter, $string)

Параметры

OutputFormatterInterface	$formatter
	$string

setInput(InputInterface $input)

Устанавливает входной поток консоли.

Параметры

InputInterface

$input

__construct($triggerDeprecationError = true)

Параметры

$triggerDeprecationError

int|string|array select(OutputInterface $output, string|array $question, array $choices, bool|string $default = null, bool|int $attempts = false, string $errorMessage = 'Value "%s" is invalid', bool $multiselect = false)

Запрашивает у пользователя выбор значения.

Параметры

OutputInterface	$output	Экземпляр Output
string|array	$question	Вопрос для пользователя
array	$choices	Список доступных вариантов
bool|string	$default	Значение по умолчанию в случае пустого ввода
bool|int	$attempts	Максимальное количество попыток запроса (по умолчанию бесконечно)
string	$errorMessage	Сообщение об ошибке при вводе недопустимого значения
bool	$multiselect	Выбирать несколько значений, разделенных запятой

Значение возврата

int|string|array

Выбранное значение или значения (ключ из массива $choices)

Исключения

InvalidArgumentException

string ask(OutputInterface $output, string|array $question, string $default = null, array $autocomplete = null)

Задает вопрос пользователю.

Параметры

OutputInterface	$output	Экземпляр Output
string|array	$question	Вопрос для пользователя
string	$default	Значение по умолчанию, если пользователь ничего не вводит
array	$autocomplete	Список значений для автозаполнения

Значение возврата

string

Ответ пользователя

Исключения

RuntimeException

Если нет данных для чтения из потока ввода

bool askConfirmation(OutputInterface $output, string|array $question, bool $default = true)

Задает вопрос пользователю о подтверждении.

Вопрос будет задаваться до тех пор, пока пользователь не ответит пустым значением, «да» или «нет».

Параметры

OutputInterface	$output	Экземпляр Output
string|array	$question	Вопрос для пользователя
bool	$default	Значение по умолчанию, если пользователь ничего не вводит

Значение возврата

bool	true, если пользователь подтвердил, false иначе

string askHiddenResponse(OutputInterface $output, string|array $question, bool $fallback = true)

Задает вопрос пользователю, ответ скрыт.

Параметры

OutputInterface	$output	Экземпляр Output
string|array	$question	Вопрос
bool	$fallback	В случае, если ответ не может быть скрыт, перейти к нескрытому вопросу или нет

Значение возврата

string

Ответ

Исключения

RuntimeException

Если отказ от скрытия ответа и ответ не может быть скрыт

mixed askAndValidate(OutputInterface $output, string|array $question, callable $validator, int|false $attempts = false, string $default = null, array $autocomplete = null)

Запрашивает значение и проверяет ответ.

Функция-валидатор получает данные для проверки. Она должна вернуть валидные данные, если данные валидны, и выбросить исключение в противном случае.

Параметры

OutputInterface	$output	Экземпляр Output
string|array	$question	Вопрос для пользователя
callable	$validator	PHP коллбэк
int|false	$attempts	Максимальное количество попыток запроса (по умолчанию бесконечно)
string	$default	Значение по умолчанию, если пользователь ничего не вводит
array	$autocomplete	Список значений для автозаполнения

Значение возврата

mixed

Исключения

Исключение

При возникновении ошибки любого из валидаторов

string askHiddenResponseAndValidate(OutputInterface $output, string|array $question, callable $validator, int|false $attempts = false, bool $fallback = true)

Запрашивает значение, скрывает и проверяет ответ.

Функция-валидатор получает данные для проверки. Она должна вернуть валидные данные, если данные валидны, и выбросить исключение в противном случае.

Параметры

OutputInterface	$output	Экземпляр Output
string|array	$question	Вопрос для пользователя
callable	$validator	PHP коллбэк
int|false	$attempts	Максимальное количество попыток запроса (по умолчанию бесконечно)
bool	$fallback	В случае, если ответ не может быть скрыт, перейти к нескрытому вопросу или нет

Значение возврата

string

Ответ

Исключения

Исключение	Когда любой из валидаторов возвращает ошибку
Исключение выполнения	В случае, если кеширование отключено, и ответ не может быть скрыт

setInputStream(resource $stream)

Устанавливает входной поток для чтения при взаимодействии с пользователем.

Это полезно в основном для целей тестирования.

Параметры

ресурс

$stream

Входящий поток

resource|null getInputStream()

Возвращает входной поток помощника.

Значение возврата

resource|null

Входной поток или null, если используется стандартный STDIN

string getName()

Возвращает каноническое имя этого помощника.

Значение возврата

строка

Каноническое имя