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

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

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

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