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() ^{устаревший}

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

с версии 2.3, будет удалён в 3.0.

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

Возвращаемое значение

string

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

string|DOMDocument asXml(bool $asDom = false) ^{устаревший}

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

с версии 2.3, будет удалён в 3.0.

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

Параметры

bool

$asDom

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

Возвращаемое значение

string|DOMDocument

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