ArrayInput

$input = new ArrayInput(array('name' => 'foo', '--bar' => 'foobar'));

__construct(array $parameters, InputDefinition $definition = null)

Параметры

array	$parameters
InputDefinition	$definition

bind(InputDefinition $definition)

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

Параметры

InputDefinition

$definition

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

setStream(resource $stream)

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

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

Параметры

resource

$stream

Поток ввода

resource|null getStream()

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

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

resource|null

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