InputDefinition

$definition = new InputDefinition(array(
  new InputArgument('name', InputArgument::REQUIRED),
  new InputOption('foo', 'f', InputOption::VALUE_REQUIRED),
));

__construct(array $definition = array())

Параметры

array

$definition

Массив экземпляров InputArgument и InputOption

setDefinition(array $definition)

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

Параметры

array

$definition

setArguments(InputArgument[] $arguments = array())

Устанавливает объекты InputArgument.

Параметры

InputArgument[]

$arguments

Массив объектов InputArgument

addArguments(InputArgument[] $arguments = array())

Добавляет массив объектов InputArgument.

Параметры

InputArgument[]

$arguments

Массив объектов InputArgument

addArgument(InputArgument $argument)

Параметры

InputArgument

$argument

Исключения

LogicException

При неправильном аргументе

InputArgument getArgument(string|int $name)

Возвращает InputArgument по имени или позиции.

Параметры

string|int

$name

Имя или позиция InputArgument

Значение, возвращаемое функцией

InputArgument

Объект InputArgument

Исключения

InvalidArgumentException

Если аргумент не существует

bool hasArgument(string|int $name)

Возвращает true, если объект InputArgument существует по имени или позиции.

Параметры

string|int

$name

Имя или позиция InputArgument

Значение, возвращаемое функцией

bool	true, если объект InputArgument существует, иначе false

InputArgument[] getArguments()

Получает массив объектов InputArgument.

Значение, возвращаемое функцией

InputArgument[]

Массив объектов InputArgument

int getArgumentCount()

Возвращает количество InputArgument.

Значение, возвращаемое функцией

int	Количество InputArgument

int getArgumentRequiredCount()

Возвращает количество обязательных InputArgument.

Значение, возвращаемое функцией

int	Количество обязательных InputArgument

array getArgumentDefaults()

Получает значения по умолчанию.

Значение, возвращаемое функцией

array

Массив значений по умолчанию

setOptions(InputOption[] $options = array())

Устанавливает объекты InputOption.

Параметры

InputOption[]

$options

Массив объектов InputOption

addOptions(InputOption[] $options = array())

Добавляет массив объектов InputOption.

Параметры

InputOption[]

$options

Массив объектов InputOption

addOption(InputOption $option)

Параметры

InputOption

$option

Исключения

LogicException

Если опция уже существует

InputOption getOption(string $name)

Возвращает InputOption по имени.

Параметры

string

$name

Имя InputOption

Значение, возвращаемое функцией

InputOption

Объект InputOption

Исключения

InvalidArgumentException

Если опция не существует

bool hasOption(string $name)

Возвращает true, если объект InputOption существует по имени.

Этот метод не может использоваться для проверки, включила ли пользователь опцию при выполнении команды (используйте getOption() вместо этого).

Параметры

string

$name

Имя InputOption

Значение, возвращаемое функцией

bool	true, если объект InputOption существует, иначе false

InputOption[] getOptions()

Получает массив объектов InputOption.

Значение, возвращаемое функцией

InputOption[]

Массив объектов InputOption

bool hasShortcut(string $name)

Возвращает true, если объект InputOption существует по сокращению.

Параметры

string

$name

Сокращение InputOption

Значение, возвращаемое функцией

bool	true, если объект InputOption существует, иначе false

InputOption getOptionForShortcut(string $shortcut)

Получает InputOption по сокращению.

Параметры

string

$shortcut

Имя сокращения

Значение, возвращаемое функцией

InputOption

Объект InputOption

array getOptionDefaults()

Получает массив значений по умолчанию.

Значение, возвращаемое функцией

array

Массив всех значений по умолчанию

string getSynopsis(bool $short = false)

Получает описание.

Параметры

bool

$short

Возвращать короткую версию (с сложенными опциями) или нет

Значение, возвращаемое функцией

string

Описание

string asText() ^deprecated

^deprecated

since version 2.3, to be removed in 3.0.

Возвращает текстовое представление InputDefinition.

Значение, возвращаемое функцией

string

Строковое представление InputDefinition

string|DOMDocument asXml(bool $asDom = false) ^deprecated

^deprecated

since version 2.3, to be removed in 3.0.

Возвращает XML-представление InputDefinition.

Параметры

bool

$asDom

Возвращать DOM или XML-строку

Значение, возвращаемое функцией

string|DOMDocument

XML-строка, представляющая InputDefinition