Использование Symfony Console: от простых команд до продвинутых сценариев

Наиболее распространённый способ – создать класс, наследуемый от Command, и зарегистрировать его как сервис. Команда автоматически обнаруживается через автоконфигурацию, если файл находится в src/Command.

// src/Command/HelloCommand.php
namespace App\Command;

use Symfony\Component\Console\Attribute\AsCommand;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;

#[AsCommand(name: 'app:hello')]
class HelloCommand extends Command
{
    protected function configure(): void
    {
        $this->setDescription('Prints a greeting.');
    }

    protected function execute(InputInterface $input, OutputInterface $output): int
    {
        $output->writeln('Hello, Symfony Console!');
        return Command::SUCCESS;
    }
}

Php symfony console (symfony консоль)

Аргументы и опции определяются в методе configure() с помощью объекта InputArgument и InputOption. Основной подход – использование fluent-интерфейса addArgument() и addOption().

protected function configure(): void
{
    $this->addArgument('name', InputArgument::REQUIRED, 'Who do you want to greet?')
         ->addOption('yell', 'y', InputOption::VALUE_NONE, 'Output greeting in uppercase');
}

protected function execute(InputInterface $input, OutputInterface $output): int
{
    $name = $input->getArgument('name');
    $text = "Hello, $name!";
    if ($input->getOption('yell')) {
        $text = strtoupper($text);
    }
    $output->writeln($text);
    return Command::SUCCESS;
}

Использование вспомогательного класса Symfony\Component\Console\Question\Question и QuestionHelper. Основной способ – получить helper из `$this->getHelper('question')` и задать вопрос.

use Symfony\Component\Console\Question\Question;

protected function execute(InputInterface $input, OutputInterface $output): int
{
    $helper = $this->getHelper('question');
    $question = new Question('Please enter your name: ', 'Guest');
    $name = $helper->ask($input, $output, $question);
    $output->writeln("Hello, $name!");
    return Command::SUCCESS;
}

Использовать конструктор с типизированными параметрами – Symfony автоматически внедрит зависимости благодаря автовайрингу. Команда должна быть зарегистрирована как сервис (по умолчанию это происходит автоматически).

use Psr\Log\LoggerInterface;

class GreetCommand extends Command
{
    public function __construct(private LoggerInterface $logger)
    {
        parent::__construct();
    }

    protected function execute(InputInterface $input, OutputInterface $output): int
    {
        $this->logger->info('Greet command executed');
        $output->writeln('Hello!');
        return Command::SUCCESS;
    }
}

Использовать CommandTester из пространства имён Symfony\Bundle\FrameworkBundle\Test\KernelTestCase. Этот класс позволяет выполнять команду в изолированном окружении и проверять вывод.

use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
use Symfony\Bundle\FrameworkBundle\Console\Application;
use Symfony\Component\Console\Tester\CommandTester;

class HelloCommandTest extends KernelTestCase
{
    public function testExecute(): void
    {
        $kernel = self::bootKernel();
        $application = new Application($kernel);
        $command = $application->find('app:hello');
        $commandTester = new CommandTester($command);
        $commandTester->execute([]);

        $output = $commandTester->getDisplay();
        $this->assertStringContainsString('Hello, Symfony Console!', $output);
    }
}