InputInterface

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

Значение опции

bind(InputDefinition $definition)

Связывает текущий экземпляр Input с заданными аргументами и опциями.

Параметры

InputDefinition

$definition

validate()

Проверяет ввод.

Исключения

RuntimeException

При недостаточном количестве аргументов

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 — в противном случае

bool isInteractive()

Является ли этот ввод интерактивным?

Возвращаемое значение

bool

setInteractive(bool $interactive)

Устанавливает интерактивность ввода.

Параметры

bool

$interactive

Если ввод должен быть интерактивным