ArgvInput
class ArgvInput extends Input
ArgvInput представляет входные данные, поступающие из аргументов командной строки.
Использование:
$input = new ArgvInput();
По умолчанию для значений входных данных используется массив $_SERVER['argv'].
Это можно переопределить, явно передав значения входных данных в конструктор:
$input = new ArgvInput($_SERVER['argv']);
Если вы передаете их самостоятельно, не забудьте, что первый элемент массива — это имя запускаемого приложения.
При передаче аргумента в конструктор убедитесь, что он соответствует тем же правилам, что и argv. Практически всегда лучше использовать StringInput, если вы хотите предоставить собственные входные данные.
Методы
| __construct(array $argv = null, InputDefinition $definition = null) | ||
| bind(InputDefinition $definition) Связывает текущий экземпляр Input с заданными аргументами и опциями. | from Input | |
| validate() Проверяет входные данные. | from Input | |
| bool | isInteractive() Являются ли эти входные данные интерактивными? | from Input |
| setInteractive(bool $interactive) Устанавливает интерактивность входных данных. | from Input | |
| array | getArguments() Возвращает все заданные аргументы, объединённые со значениями по умолчанию. | from Input |
| mixed | getArgument(string $name) Возвращает значение аргумента для заданного имени аргумента. | from Input |
| setArgument(string $name, string $value) Устанавливает значение аргумента по имени. | from Input | |
| bool | hasArgument(string|int $name) Возвращает true, если объект InputArgument существует по имени или позиции. | from Input |
| array | getOptions() Возвращает все заданные опции, объединённые со значениями по умолчанию. | from Input |
| mixed | getOption(string $name) Возвращает значение опции для заданного имени опции. | from Input |
| setOption(string $name, string|bool $value) Устанавливает значение опции по имени. | from Input | |
| bool | hasOption(string $name) Возвращает true, если объект InputOption существует по имени. | from Input |
| string | escapeToken(string $token) Экранирует токен с помощью escapeshellarg, если он содержит небезопасные символы. | from Input |
| setStream(resource $stream) Устанавливает входной поток для чтения при взаимодействии с пользователем. | from Input | |
| resource|null | getStream() Возвращает входной поток. | from Input |
| string | getFirstArgument() Возвращает первый аргумент из исходных параметров (не обработанных). | |
| bool | hasParameterOption(string|array $values, bool $onlyParams = false) Возвращает true, если исходные параметры (не обработанные) содержат значение. | |
| mixed | getParameterOption(string|array $values, mixed $default = false, bool $onlyParams = false) Возвращает значение исходной опции (не обработанной). | |
| string | __toString() Возвращает строковое представление аргументов, переданных команде. |
Подробности
__construct(array $argv = null, InputDefinition $definition = null)
Параметры
| array | $argv | Массив параметров из командной строки (в формате argv) |
| InputDefinition | $definition |
bind(InputDefinition $definition)
Связывает текущий экземпляр Input с заданными аргументами и опциями.
Параметры
| InputDefinition | $definition |
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 |
setStream(resource $stream)
Устанавливает поток ввода для чтения при взаимодействии с пользователем.
Это в основном полезно для целей тестирования.
Параметры
| resource | $stream | Поток ввода |
resource|null getStream()
Возвращает поток ввода.
Возвращаемое значение
| resource|null |
string getFirstArgument()
Возвращает первый аргумент из исходных параметров (не обработанных).
Возвращаемое значение
| string | Значение первого аргумента или null в противном случае |
bool hasParameterOption(string|array $values, bool $onlyParams = false)
Возвращает true, если исходные параметры (не обработанные) содержат значение.
Этот метод используется для проверки входных параметров перед их валидацией. Его следует использовать осторожно.
Параметры
| string|array | $values | Искомые значения в исходных параметрах (может быть массивом) |
| bool | $onlyParams | Проверять только реальные параметры, пропуская те, что следуют за сигналом окончания опций (--) |
Возвращаемое значение
| bool | true, если значение содержится в исходных параметрах |
mixed getParameterOption(string|array $values, mixed $default = false, bool $onlyParams = false)
Возвращает значение исходной опции (не обработанной).
Этот метод используется для проверки входных параметров перед их валидацией. Его следует использовать осторожно.
Параметры
| string|array | $values | Искомое(ые) значение(я) в исходных параметрах (может быть массивом) |
| mixed | $default | Значение по умолчанию, если результат не найден |
| bool | $onlyParams | Проверять только реальные параметры, пропуская те, что следуют за сигналом окончания опций (--) |
Возвращаемое значение
| mixed | Значение опции |
string __toString()
Возвращает строковое представление аргументов, переданных команде.
Возвращаемое значение
| string |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.4/Symfony/Component/Console/Input/ArgvInput.html
