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

Интерактивен ли ввод