Параметр description атрибута AsCommand
Параметр description атрибута AsCommand задаёт текстовое описание консольной команды Symfony.
Это описание выводится в общем списке команд при вызове bin/console list,
а также в подробной справке по команде при вызове bin/console help.
Параметр передаётся именованно и содержит краткую строку, поясняющую назначение команды.
Синтаксис
#[AsCommand(name: name, description: description)]
Пример
Давайте создадим команду с описанием:
<?php
namespace AppCommand;
use SymfonyComponentConsoleAttributeAsCommand;
use SymfonyComponentConsoleCommandCommand;
use SymfonyComponentConsoleInputInputInterface;
use SymfonyComponentConsoleOutputOutputInterface;
#[AsCommand(
name: 'app:article',
description: 'Outputs a hello message',
)]
class ArticleCommand extends Command
{
protected function execute(InputInterface $input, OutputInterface $output): int
{
$output->writeln('hello');
return Command::SUCCESS;
}
}
?>
Теперь вызовем список команд:
php bin/console list
В списке рядом с именем команды появится её описание:
app:article Outputs a hello message
Пример
Давайте посмотрим справку по команде:
php bin/console help app:article
Описание будет выведено в блоке Description:
Description:
Outputs a hello message
