InputInterface

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

Значение параметра

bind(InputDefinition $definition)

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

Параметры

InputDefinition

$definition

Экземпляр InputDefinition

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

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