StringInput

$input = new StringInput('foo --bar="foobar"');

__construct(string $input)

Параметры

string

$input

Строка, представляющая параметры из командной строки

bind(InputDefinition $definition)

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

Параметры

InputDefinition

$definition

Исключения

RuntimeException

protected parse()

Обрабатывает аргументы командной строки.

validate()

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

Исключения

RuntimeException

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

bool isInteractive()

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

Значение возврата

bool

setInteractive(bool $interactive)

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

Параметры

bool

$interactive

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

array getArguments()

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

Значение возврата

array

string|string[]|null getArgument(string $name)

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

Параметры

string

$name

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

Значение возврата

string|string[]|null

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

Исключения

InvalidArgumentException

Если указанный аргумент не существует

setArgument(string $name, string|string[]|null $value)

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

Параметры

string	$name	Имя аргумента
string|string[]|null	$value	Значение аргумента

Исключения

InvalidArgumentException

Если указанный аргумент не существует

bool hasArgument(string|int $name)

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

Параметры

string|int

$name

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

Значение возврата

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

array getOptions()

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

Значение возврата

array

string|string[]|bool|null getOption(string $name)

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

Параметры

string

$name

Имя опции

Значение возврата

string|string[]|bool|null

Значение опции

Исключения

InvalidArgumentException

Если заданная опция не существует

setOption(string $name, string|string[]|bool|null $value)

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

Параметры

string	$name	Имя опции
string|string[]|bool|null	$value	Значение опции

Исключения

InvalidArgumentException

Если заданная опция не существует

bool hasOption(string $name)

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

Параметры

string

$name

Имя InputOption

Значение возврата

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

string escapeToken(string $token)

Экранирует маркер с помощью escapeshellarg, если он содержит небезопасные символы.

Параметры

string

$token

Значение возврата

string

setStream(resource $stream)

Устанавливает поток ввода для чтения при взаимодействии с пользователем.

Это в основном полезно для целей тестирования.

Параметры

resource

$stream

Поток ввода

resource|null getStream()

Возвращает поток ввода.

Значение возврата

resource|null

protected setTokens(array $tokens)

Параметры

array

$tokens

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

Значение опции

string __toString()

Возвращает строковое представление аргументов, переданных команде.

Значение возврата

string