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