StreamableInputInterface
интерфейс StreamableInputInterface реализует InputInterface
StreamableInputInterface — это интерфейс, реализуемый всеми классами ввода, имеющими поток ввода.
Методы
| string|null | getFirstArgument() Возвращает первый аргумент из необработанных параметров (не разобранных). | из InputInterface |
| bool | hasParameterOption(string|array $values, bool $onlyParams = false) Возвращает true, если необработанные параметры (не разобранные) содержат значение. | из InputInterface |
| mixed | getParameterOption(string|array $values, mixed $default = false, bool $onlyParams = false) Возвращает значение необработанного параметра (не разобранного). | из InputInterface |
| bind(InputDefinition $definition) Связывает текущий экземпляр Input с заданными аргументами и параметрами. | из InputInterface | |
| validate() Проверяет входные данные. | из InputInterface | |
| array | getArguments() Возвращает все заданные аргументы, объединённые со значениями по умолчанию. | из InputInterface |
| string|string[]|null | getArgument(string $name) Возвращает значение аргумента для заданного имени аргумента. | из InputInterface |
| setArgument(string $name, string|string[]|null $value) Устанавливает значение аргумента по имени. | из InputInterface | |
| bool | hasArgument(string|int $name) Возвращает true, если объект InputArgument существует по имени или позиции. | из InputInterface |
| array | getOptions() Возвращает все заданные параметры, объединённые со значениями по умолчанию. | из InputInterface |
| string|string[]|bool|null | getOption(string $name) Возвращает значение параметра для заданного имени параметра. | из InputInterface |
| setOption(string $name, string|string[]|bool|null $value) Устанавливает значение параметра по имени. | из InputInterface | |
| bool | hasOption(string $name) Возвращает true, если объект InputOption существует по имени. | из InputInterface |
| bool | isInteractive() Является ли этот ввод интерактивным? | из InputInterface |
| setInteractive(bool $interactive) Устанавливает интерактивность ввода. | из InputInterface | |
| setStream(resource $stream) Устанавливает поток ввода для чтения при взаимодействии с пользователем. | ||
| resource|null | getStream() Возвращает поток ввода. |
Подробное описание
строка|null getFirstArgument()
Возвращает первый аргумент из исходных параметров (не обработанных).
Значение возврата
| строка|null | Значение первого аргумента или null в противном случае |
bool hasParameterOption(строка|массив $values, bool $onlyParams = false)
Возвращает true, если исходные параметры (не обработанные) содержат значение.
Этот метод используется для интроспекции входных параметров до их валидации. Его необходимо использовать осторожно. Не обязательно возвращает правильный результат для коротких опций, когда несколько флагов объединены в одной опции.
Параметры
| строка|массив | $values | Искомые значения в исходных параметрах (может быть массивом) |
| bool | $onlyParams | Проверять только реальные параметры, пропускать те, которые следуют за сигналом конца опций (--) |
Значение возврата
| bool | true, если значение содержится в исходных параметрах |
смешанное getParameterOption(строка|массив $values, смешанное $default = false, bool $onlyParams = false)
Возвращает значение сырой опции (не обработанной).
Этот метод используется для интроспекции входных параметров до их валидации. Его необходимо использовать осторожно. Не обязательно возвращает правильный результат для коротких опций, когда несколько флагов объединены в одной опции.
Параметры
| строка|массив | $values | Искомое(ые) значение(я) в исходных параметрах (может быть массивом) |
| смешанное | $default | Значение по умолчанию, возвращаемое, если результат не найден |
| bool | $onlyParams | Проверять только реальные параметры, пропускать те, которые следуют за сигналом конца опций (--) |
Значение возврата
| смешанное | Значение опции |
bind(InputDefinition $definition)
Связывает текущий экземпляр Input с заданными аргументами и опциями.
Параметры
| InputDefinition | $definition |
Исключения
| RuntimeException |
validate()
Проверяет входные данные.
Исключения
| RuntimeException | При недостаточном количестве аргументов |
массив getArguments()
Возвращает все заданные аргументы, объединенные со значениями по умолчанию.
Значение возврата
| массив |
строка|массив строк|null getArgument(строка $name)
Возвращает значение аргумента для заданного имени аргумента.
Параметры
| строка | $name | Имя аргумента |
Значение возврата
| строка|массив строк|null | Значение аргумента |
Исключения
| InvalidArgumentException | При отсутствии заданного аргумента |
setArgument(строка $name, строка|массив строк|null $value)
Устанавливает значение аргумента по имени.
Параметры
| строка | $name | Имя аргумента |
| строка|массив строк|null | $value | Значение аргумента |
Исключения
| InvalidArgumentException | При отсутствии заданного аргумента |
bool hasArgument(строка|целое $name)
Возвращает true, если объект InputArgument существует по имени или позиции.
Параметры
| строка|целое | $name | Имя InputArgument или позиция |
Значение возврата
| bool | true, если объект InputArgument существует, иначе false |
массив getOptions()
Возвращает все заданные опции, объединенные со значениями по умолчанию.
Значение возврата
| массив |
строка|массив строк|bool|null getOption(строка $name)
Возвращает значение опции для заданного имени опции.
Параметры
| строка | $name | Имя опции |
Значение возврата
| строка|массив строк|bool|null | Значение опции |
Исключения
| InvalidArgumentException | При отсутствии заданной опции |
setOption(строка $name, строка|массив строк|bool|null $value)
Устанавливает значение опции по имени.
Параметры
| строка | $name | Имя опции |
| строка|массив строк|bool|null | $value | Значение опции |
Исключения
| InvalidArgumentException | При отсутствии заданной опции |
bool hasOption(строка $name)
Возвращает true, если объект InputOption существует по имени.
Параметры
| строка | $name | Имя InputOption |
Значение возврата
| bool | true, если объект InputOption существует, иначе false |
bool isInteractive()
Является ли этот вход интерактивным?
Значение возврата
| bool |
setInteractive(bool $interactive)
Устанавливает интерактивность ввода.
Параметры
| bool | $interactive | Если вход должен быть интерактивным |
setStream(ресурс $stream)
Устанавливает поток ввода для чтения при взаимодействии с пользователем.
Это преимущественно полезно для целей тестирования.
Параметры
| ресурс | $stream | Поток ввода |
ресурс|null getStream()
Возвращает поток ввода.
Значение возврата
| ресурс|null |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
https://api.symfony.com/4.1/Symfony/Component/Console/Input/StreamableInputInterface.html
