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

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