StringInput

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

__construct(string $input, InputDefinition $definition = null) ^{устаревший}

^{устаревший}

Второй аргумент устарел, так как он не работает (будет удален в версии 3.0). Используйте метод 'bind' вместо него.

Параметры

string	$input	Массив параметров из командной строки (в формате argv)
InputDefinition	$definition	Экземпляр InputDefinition

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

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

Исключения

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

string escapeToken(string $token)

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

Параметры

string

$token

Значение результата

string

string getFirstArgument()

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

Значение результата

string

Значение первого аргумента или null в противном случае

bool hasParameterOption(string|array $values)

Возвращает true, если исходные параметры (не обработанные) содержат значение.

Этот метод используется для проверки входных параметров до их проверки. Он должен использоваться с осторожностью.

Параметры

string|array

$values

Значения для поиска в исходных параметрах (может быть массивом)

Значение результата

bool	true, если значение содержится в исходных параметрах

mixed getParameterOption(string|array $values, mixed $default = false)

Возвращает значение исходной опции (не обработанной).

Этот метод используется для проверки входных параметров до их проверки. Он должен использоваться с осторожностью.

Параметры

string|array	$values	Значение(я) для поиска в исходных параметрах (может быть массивом)
mixed	$default	Значение по умолчанию, возвращаемое, если результат не найден

Значение результата

mixed

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

string __toString()

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

Значение результата

string