InputInterface

строка|null getFirstArgument()

Возвращает первый аргумент из исходных параметров (не обработанных).

Значение, возвращаемое функцией

строка|null

Значение первого аргумента или null в противном случае

bool hasParameterOption(строка|массив $values, bool $onlyParams = false)

Возвращает true, если исходные параметры (не обработанные) содержат значение.

Этот метод предназначен для проверки входных параметров до их проверки. Он должен использоваться с осторожностью. Не гарантирует правильный результат для коротких параметров, когда несколько флагов объединены в один параметр.

Параметры

строка|массив	$values	Значения для поиска в исходных параметрах (может быть массивом)
bool	$onlyParams	Проверять только реальные параметры, пропускать те, что следуют за сигналом конца параметров (--)

Значение, возвращаемое функцией

bool	true, если значение содержится в исходных параметрах

mixed getParameterOption(строка|массив $values, mixed $default = false, bool $onlyParams = false)

Возвращает значение исходного параметра (не обработанного).

Этот метод предназначен для проверки входных параметров до их проверки. Он должен использоваться с осторожностью. Не гарантирует правильный результат для коротких параметров, когда несколько флагов объединены в один параметр.

Параметры

строка|массив	$values	Значение(я) для поиска в исходных параметрах (может быть массивом)
mixed	$default	Значение по умолчанию, возвращаемое, если результат не найден
bool	$onlyParams	Проверять только реальные параметры, пропускать те, что следуют за сигналом конца параметров (--)

Значение, возвращаемое функцией

mixed

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

bind(InputDefinition $definition)

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

Параметры

InputDefinition

$definition

Исключения

RuntimeException

validate()

Проверяет входные данные.

Исключения

RuntimeException

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

массив getArguments()

Возвращает все заданные аргументы, объединённые со значениями по умолчанию.

Значение, возвращаемое функцией

массив

строка|массив строк|null getArgument(строка $name)

Возвращает значение аргумента для данного имени аргумента.

Параметры

строка

$name

Имя аргумента

Значение, возвращаемое функцией

строка|массив строк|null

Значение аргумента

Исключения

InvalidArgumentException

При отсутствии указанного аргумента

setArgument(строка $name, строка|массив строк|null $value)

Устанавливает значение аргумента по имени.

Параметры

строка	$name	Имя аргумента
строка|массив строк|null	$value	Значение аргумента

Исключения

InvalidArgumentException

При отсутствии указанного аргумента

bool hasArgument(строка|целое $name)

Возвращает true, если объект InputArgument существует по имени или позиции.

Параметры

строка|целое

$name

Имя или позиция InputArgument

Значение, возвращаемое функцией

bool	true, если объект InputArgument существует, иначе false

массив getOptions()

Возвращает все заданные параметры, объединённые со значениями по умолчанию.

Значение, возвращаемое функцией

массив

строка|массив строк|bool|null getOption(строка $name)

Возвращает значение параметра для данного имени параметра.

Параметры

строка

$name

Имя параметра

Значение, возвращаемое функцией

строка|массив строк|bool|null

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

Исключения

InvalidArgumentException

При отсутствии указанного параметра

setOption(строка $name, строка|массив строк|bool|null $value)

Устанавливает значение параметра по имени.

Параметры

строка	$name	Имя параметра
строка|массив строк|bool|null	$value	Значение параметра

Исключения

InvalidArgumentException

При отсутствии указанного параметра

bool hasOption(строка $name)

Возвращает true, если объект InputOption существует по имени.

Параметры

строка

$name

Имя InputOption

Значение, возвращаемое функцией

bool	true, если объект InputOption существует, иначе false

bool isInteractive()

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

Значение, возвращаемое функцией

bool

setInteractive(bool $interactive)

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

Параметры

bool

$interactive

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