Ввод
класс Input реализует InputInterface
Input — базовый класс для всех конкретных классов Input.
По умолчанию предоставляются три конкретных класса:
-
ArgvInput: Ввод происходит из аргументов командной строки (argv) -
StringInput: Ввод предоставляется в виде строки -
ArrayInput: Ввод предоставляется в виде массива
Методы
| __construct(InputDefinition $definition = null) Конструктор. | ||
| bind(InputDefinition $definition) Связывает текущий экземпляр Input с заданными аргументами и параметрами. | ||
| validate() Проверяет ввод. | ||
| bool | isInteractive() Проверяет, является ли ввод интерактивным. | |
| setInteractive(bool $interactive) Устанавливает интерактивность ввода. | ||
| array | getArguments() Возвращает значения аргументов. | |
| mixed | getArgument(string $name) Возвращает значение аргумента для данного имени аргумента. | |
| setArgument(string $name, string $value) Устанавливает значение аргумента по имени. | ||
| bool | hasArgument(string|int $name) Возвращает true, если объект InputArgument существует по имени или позиции. | |
| array | getOptions() Возвращает значения параметров. | |
| mixed | getOption(string $name) Возвращает значение параметра для данного имени параметра. | |
| setOption(string $name, string|bool $value) Устанавливает значение параметра по имени. | ||
| bool | hasOption(string $name) Возвращает true, если объект InputOption существует по имени. | |
| string | escapeToken(string $token) Экранирует токен через escapeshellarg, если он содержит небезопасные символы. |
Подробности
__construct(InputDefinition $definition = null)
Конструктор.
Параметры
| InputDefinition | $definition | Экземпляр InputDefinition |
bind(InputDefinition $definition)
Связывает текущий экземпляр Input с заданными аргументами и параметрами.
Параметры
| InputDefinition | $definition | Экземпляр InputDefinition |
validate()
Проверяет ввод.
Исключения
| RuntimeException | При недостатке аргументов |
bool isInteractive()
Проверяет, является ли ввод интерактивным.
Возвращаемое значение
| bool |
setInteractive(bool $interactive)
Устанавливает интерактивность ввода.
Параметры
| bool | $interactive | Является ли ввод интерактивным |
array getArguments()
Возвращает значения аргументов.
Возвращаемое значение
| array |
mixed getArgument(string $name)
Возвращает значение аргумента для данного имени аргумента.
Параметры
| string | $name | Имя аргумента |
Возвращаемое значение
| mixed |
Исключения
| InvalidArgumentException | При отсутствии заданного аргумента |
setArgument(string $name, string $value)
Устанавливает значение аргумента по имени.
Параметры
| string | $name | Имя аргумента |
| string | $value | Значение аргумента |
Исключения
| InvalidArgumentException | При отсутствии заданного аргумента |
bool hasArgument(string|int $name)
Возвращает true, если объект InputArgument существует по имени или позиции.
Параметры
| string|int | $name | Имя или позиция InputArgument |
Возвращаемое значение
| bool | true, если объект InputArgument существует, иначе false |
array getOptions()
Возвращает значения параметров.
Возвращаемое значение
| array |
mixed getOption(string $name)
Возвращает значение параметра для данного имени параметра.
Параметры
| string | $name | Имя параметра |
Возвращаемое значение
| mixed |
Исключения
| InvalidArgumentException | При отсутствии заданного параметра |
setOption(string $name, string|bool $value)
Устанавливает значение параметра по имени.
Параметры
| string | $name | Имя параметра |
| string|bool | $value | Значение параметра |
Исключения
| InvalidArgumentException | При отсутствии заданного параметра |
bool hasOption(string $name)
Возвращает true, если объект InputOption существует по имени.
Параметры
| string | $name | Имя InputOption |
Возвращаемое значение
| bool | true, если объект InputOption существует, иначе false |
string escapeToken(string $token)
Экранирует токен через escapeshellarg, если он содержит небезопасные символы.
Параметры
| string | $token |
Возвращаемое значение
| string |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.0/Symfony/Component/Console/Input/Input.html
