Метод setDescription
Метод setDescription класса Command задаёт текстовое описание консольной команды.
Это описание показывается в общем списке команд и в справке по команде.
Первым параметром передаётся строка с описанием.
Метод возвращает объект команды, поэтому вызовы можно выстраивать в цепочку.
Синтаксис
setDescription(string $description): static
Пример
Давайте создадим команду и зададим ей описание через метод setDescription:
<?php
namespace AppCommand;
use SymfonyComponentConsoleCommandCommand;
use SymfonyComponentConsoleInputInputInterface;
use SymfonyComponentConsoleOutputOutputInterface;
class ArticleCommand extends Command
{
protected function configure(): void
{
$this
->setName('app:article')
->setDescription('Creates a new article');
}
protected function execute(InputInterface $input, OutputInterface $output): int
{
$output->writeln('article created');
return Command::SUCCESS;
}
}
?>
Теперь посмотрим на список команд:
php bin/console list
Результат выполнения кода:
"app:article Creates a new article"
Пример
Давайте посмотрим описание в справке по команде:
php bin/console help app:article
Результат выполнения кода:
"Description:
Creates a new article"
