DialogHelper ^{устаревший}

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

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	Максимальное количество попыток запроса перед отказом (по умолчанию false, что означает бесконечно)
string	$errorMessage	Сообщение, отображаемое при вводе некорректного значения из списка выбора
bool	$multiselect	Выбрать несколько значений, разделенных запятой

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

int|string|array

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

Исключения

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	Максимальное количество попыток запроса перед отказом (по умолчанию false, что означает бесконечно)
string	$default	Ответ по умолчанию, если пользователь ничего не ввел
array	$autocomplete	Список значений для автодополнения

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

mixed

Исключения

Exception

Когда любой из валидаторов возвращает ошибку

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	Максимальное количество попыток запроса перед отказом (по умолчанию false, что означает бесконечно)
bool	$fallback	В случае, если ответ нельзя скрыть, использовать ли резервный вариант с нескрытым вопросом

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

string

Ответ

Исключения

Exception	Когда любой из валидаторов возвращает ошибку
RuntimeException	Если резервный вариант отключен, и ответ нельзя скрыть

setInputStream(resource $stream)

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

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

Параметры

resource

$stream

Поток ввода

resource|null getInputStream()

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

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

resource|null

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

string getName()

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

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

string

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