InputInterface

string|null getFirstArgument()

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

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

string|null

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

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

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