RouterMatchCommand

__construct(string|null $name = null)

Конструктор.

Параметры

string|null

$name

Имя команды; передача null означает, что оно должно быть задано в configure()

Исключения

LogicException

Если имя команды пустое

ignoreValidationErrors()

Игнорирует ошибки проверки.

Это полезно в основном для команды help.

setApplication(Application $application = null)

Устанавливает экземпляр приложения для этой команды.

Параметры

Application

$application

Экземпляр Application

setHelperSet(HelperSet $helperSet)

Устанавливает набор помощников.

Параметры

HelperSet

$helperSet

Экземпляр HelperSet

HelperSet getHelperSet()

Получает набор помощников.

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

HelperSet

Экземпляр HelperSet

Application getApplication()

Получает экземпляр приложения для этой команды.

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

Application

Экземпляр Application

bool isEnabled()

Проверяет, включена ли команда в текущей среде.

Переопределите этот метод, чтобы проверить x или y и вернуть false, если команда не может корректно работать в текущих условиях.

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

bool

int run(InputInterface $input, OutputInterface $output)

Выполняет команду.

Код для выполнения определяется либо напрямую методом setCode(), либо путём переопределения метода execute() в подклассе.

Параметры

InputInterface	$input	Экземпляр InputInterface
OutputInterface	$output	Экземпляр OutputInterface

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

int	Код завершения команды

Исключения

Exception

См. также

setCode()
execute()

Command setCode(callable $code)

Устанавливает код для выполнения при запуске этой команды.

Если этот метод используется, он переопределяет код, определённый в методе execute().

Параметры

callable

$code

callable(InputInterface $input, OutputInterface $output)

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

Command

Текущий экземпляр

Исключения

InvalidArgumentException

См. также

execute()

mergeApplicationDefinition(bool $mergeArgs = true)

Объединяет определение приложения с определением команды.

Этот метод не входит в общедоступный API и не должен использоваться напрямую.

Параметры

bool

$mergeArgs

Объединять или нет аргументы определения приложения с аргументами определения команды

Command setDefinition(array|InputDefinition $definition)

Устанавливает массив экземпляров аргументов и опций.

Параметры

array|InputDefinition

$definition

Массив экземпляров аргументов и опций или экземпляр определения

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

Command

Текущий экземпляр

InputDefinition getDefinition()

Получает InputDefinition, присоединённый к этой команде.

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

InputDefinition

Экземпляр InputDefinition

InputDefinition getNativeDefinition()

Получает InputDefinition, используемый для создания XML и текстовых представлений этой команды.

Можно переопределить, чтобы предоставить исходное представление команды, когда в противном случае оно будет изменено путём объединения с InputDefinition приложения.

Этот метод не входит в общедоступный API и не должен использоваться напрямую.

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

InputDefinition

Экземпляр InputDefinition

Command addArgument(string $name, int $mode = null, string $description = '', mixed $default = null)

Добавляет аргумент.

Параметры

string	$name	Имя аргумента
int	$mode	Режим аргумента: InputArgument::REQUIRED или InputArgument::OPTIONAL
string	$description	Текст описания
mixed	$default	Значение по умолчанию (только для режима InputArgument::OPTIONAL)

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

Command

Текущий экземпляр

Command addOption(string $name, string $shortcut = null, int $mode = null, string $description = '', mixed $default = null)

Добавляет опцию.

Параметры

string	$name	Имя опции
string	$shortcut	Сокращение (может быть null)
int	$mode	Режим опции: Один из констант InputOption::VALUE_*
string	$description	Текст описания
mixed	$default	Значение по умолчанию (должно быть null для InputOption::VALUE_NONE)

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

Command

Текущий экземпляр

Command setName(string $name)

Устанавливает имя команды.

Этот метод может установить как имя пространства имён, так и имя, если вы разделите их двоеточием (:)

$command->setName('foo:bar');

Параметры

string

$name

Имя команды

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

Command

Текущий экземпляр

Исключения

InvalidArgumentException

При некорректном имени

Command setProcessTitle(string $title)

Устанавливает заголовок процесса для команды.

Эта функция должна использоваться только при создании команды с длительным процессом, например, демона.

Требуется PHP 5.5+ или библиотека proctitle PECL.

Параметры

string

$title

Заголовок процесса

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

Команда

Текущий экземпляр

строка getName()

Возвращает имя команды.

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

строка

Имя команды

Команда setDescription(строка $description)

Устанавливает описание команды.

Параметры

строка

$description

Описание команды

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

Команда

Текущий экземпляр

строка getDescription()

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

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

строка

Описание команды

Команда setHelp(строка $help)

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

Параметры

строка

$help

Справка по команде

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

Команда

Текущий экземпляр

строка getHelp()

Возвращает справку по команде.

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

строка

Справка по команде

строка getProcessedHelp()

Возвращает обработанную справку по команде, в которой шаблоны %command.name% и %command.full_name% динамически заменяются на реальные значения.

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

строка

Обработанная справка по команде

Команда setAliases(строка[] $aliases)

Устанавливает псевдонимы для команды.

Параметры

строка[]

$aliases

Массив псевдонимов для команды

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

Команда

Текущий экземпляр

Исключения

Исключение неверного аргумента

При некорректном псевдониме

массив getAliases()

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

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

массив

Массив псевдонимов для команды

строка getSynopsis(bool $short = false)

Возвращает сводку по команде.

Параметры

bool

$short

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

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

строка

Сводка

Команда addUsage(строка $usage)

Добавляет пример использования команды.

Параметры

строка

$usage

Использование, оно будет префиксным именем команды

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

Команда

Текущий экземпляр

массив getUsages()

Возвращает альтернативные способы использования команды.

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

массив

смешанный тип getHelper(строка $name)

Получает экземпляр помощника по имени.

Параметры

строка

$name

Имя помощника

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

смешанный тип

Значение помощника

Исключения

Логическая ошибка	если не определен HelperSet
Исключение неверного аргумента	если помощник не определен

строка asText() ^{устаревший}

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

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

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

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

строка

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

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

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

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

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

Параметры

bool

$asDom

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

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

строка|DOMDocument

Строка XML, представляющая команду

setContainer(ContainerInterface $container = null)

Устанавливает контейнер.

Параметры

ContainerInterface

$container

Экземпляр ContainerInterface или null