StringInput

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

__construct(string $input, InputDefinition $definition = null) ^deprecated

^deprecated

Второй аргумент устарел, так как не работает (будет удалён в версии 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