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 |
| string | getFirstArgument() Возвращает первый аргумент из исходных параметров (не обработанных). | |
| bool | hasParameterOption(string|array $values) Возвращает true, если исходные параметры (не обработанные) содержат значение. | |
| mixed | getParameterOption(string|array $values, mixed $default = false) Возвращает значение исходной опции (не обработанной). | |
| string | __toString() Возвращает строковое представление аргументов, переданных команде. |
Подробности
__construct(array $argv = null, InputDefinition $definition = null)
Параметры
| array | $argv | Массив параметров из командной строки (в формате argv) |
| 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 |
string getFirstArgument()
Возвращает первый аргумент из исходных параметров (не обработанных).
Значение результата
| string | Значение первого аргумента или null в противном случае |
bool hasParameterOption(string|array $values)
Возвращает true, если исходные параметры (не обработанные) содержат значение.
Этот метод следует использовать для проверки входных параметров до их валидации. Его необходимо использовать осторожно.
Параметры
| string|array | $values | Искомые значения в исходных параметрах (может быть массивом) |
Значение результата
| bool | true, если значение содержится в исходных параметрах |
mixed getParameterOption(string|array $values, mixed $default = false)
Возвращает значение исходной опции (не обработанной).
Этот метод следует использовать для проверки входных параметров до их валидации. Его необходимо использовать осторожно.
Параметры
| string|array | $values | Искомое(ые) значение(я) в исходных параметрах (может быть массивом) |
| mixed | $default | Значение по умолчанию, возвращаемое, если результат не найден |
Значение результата
| mixed | Значение опции |
string __toString()
Возвращает строковое представление аргументов, переданных команде.
Значение результата
| string |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/2.8/Symfony/Component/Console/Input/ArgvInput.html
