StringInput

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

__construct(string $input)

Конструктор.

Параметры

string

$input

Массив параметров из командной строки (в формате argv)

bind(InputDefinition $definition)

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

Параметры

InputDefinition

$definition

Экземпляр InputDefinition

validate()

Проверяет корректность заданных аргументов.

Выбрасывает исключение, если недостаточно аргументов.

Исключения

RuntimeException

bool isInteractive()

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

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

bool

setInteractive(bool $interactive)

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

Параметры

bool

$interactive

Будет ли ввод интерактивным

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

string escapeToken(string $token)

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

Параметры

string

$token

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

string

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

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

string __toString()

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

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

string