How to Define Commands as Services

Edit this page

If you're using the default services.yaml configuration, your command classes are already registered as services. Great! This is the recommended setup.

Note

You can also manually register your command as a service by configuring the service and tagging it with console.command.

For example, suppose you want to log something from within your command:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
namespace App\Command;

use Psr\Log\LoggerInterface;
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:sunshine')]
class SunshineCommand extends Command
{
    public function __construct(
        private LoggerInterface $logger,
    ) {
        // you *must* call the parent constructor
        parent::__construct();
    }

    protected function configure(): void
    {
        $this
            ->setDescription('Good morning!');
    }

    protected function execute(InputInterface $input, OutputInterface $output): int
    {
        $this->logger->info('Waking up the sun');
        // ...

        return Command::SUCCESS;
    }
}

If you're using the default services.yaml configuration, the command class will automatically be registered as a service and passed the $logger argument (thanks to autowiring). In other words, you only need to create this class and everything works automatically! You can call the app:sunshine command and start logging.

Warning

You do have access to services in configure(). However, if your command is not lazy, try to avoid doing any work (e.g. making database queries), as that code will be run, even if you're using the console to execute a different command.

Lazy Loading

To make your command lazily loaded, either define its name using the PHP AsCommand attribute:

1
2
3
4
5
6
7
8
use Symfony\Component\Console\Attribute\AsCommand;
// ...

#[AsCommand(name: 'app:sunshine')]
class SunshineCommand extends Command
{
    // ...
}

Or set the command attribute on the console.command tag in your service definition:

1
2
3
4
5
6
7
# config/services.yaml
services:
    # ...

    App\Command\SunshineCommand:
        tags:
            - { name: 'console.command', command: 'app:sunshine' }

Note

If the command defines aliases (using the getAliases() method) you must add one console.command tag per alias.

That's it. One way or another, the SunshineCommand will be instantiated only when the app:sunshine command is actually called.

Note

You don't need to call setName() for configuring the command when it is lazy.

Warning

Calling the list command will instantiate all commands, including lazy commands. However, if the command is a Symfony\Component\Console\Command\LazyCommand, then the underlying command factory will not be executed.

This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.
TOC
    Version