QuestionHelper
class QuestionHelper extends Helper
Класс QuestionHelper предоставляет вспомогательные функции для взаимодействия с пользователем.
Методы
| setHelperSet(HelperSet $helperSet = null) Устанавливает набор помощников, связанных с этим помощником. | из Helper | |
| HelperSet | getHelperSet() Возвращает набор помощников, связанных с этим помощником. | из Helper |
| static int | strlen(string $string) Возвращает длину строки, используя mb_strwidth, если он доступен. | из Helper |
| static | formatTime($secs) | из Helper |
| static | formatMemory($memory) | из Helper |
| static | strlenWithoutDecoration(OutputFormatterInterface $formatter, $string) | из Helper |
| static | removeDecoration(OutputFormatterInterface $formatter, $string) | из Helper |
| mixed | ask(InputInterface $input, OutputInterface $output, Question $question) Задает вопрос пользователю. | |
| setInputStream(resource $stream) Устанавливает поток ввода для чтения при взаимодействии с пользователем. | ||
| resource | getInputStream() Возвращает поток ввода помощника. | |
| string | getName() Возвращает каноническое имя этого помощника. | |
| bool|mixed|null|string | doAsk(OutputInterface $output, Question $question) Задает вопрос пользователю. |
Подробности
setHelperSet(HelperSet $helperSet = null)
Устанавливает набор помощников, связанных с этим помощником.
Параметры
| 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 |
mixed ask(InputInterface $input, OutputInterface $output, Question $question)
Задает вопрос пользователю.
Параметры
| InputInterface | $input | |
| OutputInterface | $output | |
| Question | $question |
Возвращаемое значение
| mixed | Ответ пользователя |
Исключения
| RuntimeException | Если нет данных для чтения в потоке ввода |
setInputStream(resource $stream)
Устанавливает поток ввода для чтения при взаимодействии с пользователем.
Это в основном полезно для тестирования.
Параметры
| resource | $stream | Поток ввода |
Исключения
| InvalidArgumentException | В случае, если поток не является ресурсом |
resource getInputStream()
Возвращает поток ввода помощника.
Возвращаемое значение
| resource |
string getName()
Возвращает каноническое имя этого помощника.
Возвращаемое значение
| string | Каноническое имя |
bool|mixed|null|string doAsk(OutputInterface $output, Question $question)
Задает вопрос пользователю.
Этот метод является публичным для совместимости с PHP 5.3, он должен быть приватным.
Параметры
| OutputInterface | $output | |
| Question | $question |
Возвращаемое значение
| bool|mixed|null|string |
Исключения
| Exception | |
| RuntimeException |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/2.7/Symfony/Component/Console/Helper/QuestionHelper.html