[Console] Add support for method-based commands #62567

yceruto · 2025-11-29T11:33:00Z

Q	A
Branch?	8.1
Bug fix?	no
New feature?	yes
Deprecations?	no
Issues	-
License	MIT

Same as with Controllers and Messenger Handlers, this would allow defining multiple commands in the same class:

class MethodBasedCommand
{
    public function __construct(
        // common dependencies ...
    ) {
    }

    #[AsCommand('app:cmd1')]
    public function cmd1(): int
    {
        // ...
    }

    #[AsCommand('app:cmd2')]
    public function cmd2(): int
    {
        // ...
    }
}

Asked by @kbond in #59340 (review)

Component standalone usage:

$instance = new MethodBasedCommand();

$application = new Application();
$application->addCommand($instance->cmd1(...)); // or [$instance, 'cmd1']
$application->run($input, $output);

$application = new Application();
$application->addCommand($instance->cmd2(...));
$application->run($input, $output);

Testing:

$instance = new MethodBasedCommand();

$tester = new CommandTester($instance->cmd1(...)); // or [$instance, 'cmd1']
$tester->execute([]);
$tester->assertCommandIsSuccessful();

// etc.

yceruto · 2025-11-30T23:46:52Z

better review hiding whitespace https://github.com/symfony/symfony/pull/62567/files?w=1

stof · 2025-12-01T16:43:57Z

how does this interact with the Prompt attribute added in version 7.4 ?

stof · 2025-12-01T16:46:36Z

To me, the component standalone usage should show how to register those in an Application actually (which will probably show that those are much more cumbersome to use than the invokable commands by having to do the Command wrapping in userland instead of keeping it internal, unless I missed something)

yceruto · 2025-12-01T16:54:33Z

how does this interact with the Prompt attribute added in version 7.4 ?

when the #[Interact] attribute is used, it will need to check $input->getArgument('command') to distinguish the executed command. we can create as many #[Interact] as needed. though this new approach shouldn't be used for complex commands

stof · 2025-12-01T16:52:41Z

src/Symfony/Component/Console/DependencyInjection/AddConsoleCommandPass.php

+    private function registerCommand(ContainerBuilder $container, \ReflectionClass $reflection, string $id, string $class, array $tags, Definition $definition, array &$serviceIds, array &$lazyCommandMap, array &$lazyCommandRefs): void
+    {
+        if (!$reflection->isSubclassOf(Command::class)) {
+            $method = $tags[0]['method'] ?? '__invoke';


reading $tags[0] is broken when processing the registration for other tags. It will not validate the right method (and won't register the right one either)

I don't see the broken escenario. other tags for the same command method will be processed later and interpreted as aliases.

btw, tags are now split into methods, so there is no way to process other tags with a different method in this same iteration

src/Symfony/Component/Console/Tests/DependencyInjection/AddConsoleCommandPassTest.php

src/Symfony/Component/Console/DependencyInjection/AddConsoleCommandPass.php

stof · 2025-12-01T16:58:35Z

it will need to check $input->getArgument('command') to distinguish the executed command.

This is a bad advice because the Application class supports resolving commands using any non-ambiguous shortened name passed as the command argument. So you could be running the foobar command with $input->getArgument('command') === 'f' if this is non ambiguous.

yceruto · 2025-12-07T22:36:25Z

it will need to check $input->getArgument('command') to distinguish the executed command.

This is a bad advice because the Application class supports resolving commands using any non-ambiguous shortened name passed as the command argument. So you could be running the foobar command with $input->getArgument('command') === 'f' if this is non ambiguous.

yes, that's unfortunately not perfect, so I've added support for injecting the Command instance. This way people can check getName() to distinguish them:

#[Interact]
public function prompt(Command $cmd, /* ... */): void
{
    // $cmd->getName()
}

GromNaN

how does this interact with the Prompt attribute added in version 7.4 ?

when the #[Interact] attribute is used, it will need to check $input->getArgument('command') to distinguish the executed command. we can create as many #[Interact] as needed. though this new approach shouldn't be used for complex commands

Calling all the #[Interact] methods of the class for every commands is the most logical behavior. This feature will only be usable when all the command methods have the same interaction needs.

src/Symfony/Component/Console/Command/Command.php

src/Symfony/Component/Console/DependencyInjection/AddConsoleCommandPass.php

GromNaN · 2025-12-10T08:01:42Z

src/Symfony/Component/Console/DependencyInjection/AddConsoleCommandPass.php

+                if (isset($tag['method'])) {
+                    $commandServices[$id][$tag['method']][] = $tag;
+                } else {
+                    $commandServices[$id]['__invoke'][] = $tag;
+                }


Nit: This way, it is more obvious that these two lines do the same thing with a default value.

Suggested change

if (isset($tag['method'])) {

$commandServices[$id][$tag['method']][] = $tag;

} else {

$commandServices[$id]['__invoke'][] = $tag;

}

$commandServices[$id][$tag['method'] ?? '__invoke'][] = $tag;

I actually had the opposite view 😅 but I'm fine with your suggestion if others prefer it

thanks for your review 🙏

yceruto requested a review from chalasr as a code owner November 29, 2025 11:33

carsonbot added Status: Needs Review Console Feature labels Nov 29, 2025

carsonbot added this to the 8.1 milestone Nov 29, 2025

yceruto force-pushed the method_based_command branch 2 times, most recently from 9eaaeca to 8e4f9a0 Compare November 30, 2025 23:43

yceruto force-pushed the method_based_command branch from 8e4f9a0 to 74eac25 Compare December 1, 2025 16:37

stof reviewed Dec 1, 2025

View reviewed changes

yceruto force-pushed the method_based_command branch 2 times, most recently from b84cd82 to e123736 Compare December 7, 2025 22:32

GromNaN reviewed Dec 7, 2025

View reviewed changes

src/Symfony/Component/Console/Command/Command.php Outdated Show resolved Hide resolved

src/Symfony/Component/Console/Command/Command.php Show resolved Hide resolved

src/Symfony/Component/Console/DependencyInjection/AddConsoleCommandPass.php Outdated Show resolved Hide resolved

Add support for method-based commands with AsCommand attribute

cb1d853

yceruto force-pushed the method_based_command branch from e123736 to cb1d853 Compare December 8, 2025 10:39

GromNaN approved these changes Dec 10, 2025

View reviewed changes

carsonbot added Status: Reviewed and removed Status: Needs Review labels Dec 10, 2025

Uh oh!

[Console] Add support for method-based commands #62567

Are you sure you want to change the base?

[Console] Add support for method-based commands #62567

Conversation

yceruto commented Nov 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

yceruto commented Nov 30, 2025

Uh oh!

stof commented Dec 1, 2025

Uh oh!

stof commented Dec 1, 2025

Uh oh!

yceruto commented Dec 1, 2025

Uh oh!

stof Dec 1, 2025

Choose a reason for hiding this comment

Uh oh!

yceruto Dec 7, 2025

Choose a reason for hiding this comment

Uh oh!

yceruto Dec 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

stof commented Dec 1, 2025

Uh oh!

yceruto commented Dec 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

GromNaN left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

GromNaN Dec 10, 2025

Choose a reason for hiding this comment

Uh oh!

yceruto Dec 10, 2025

Choose a reason for hiding this comment

Uh oh!

yceruto Dec 10, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

yceruto commented Nov 29, 2025 •

edited

Loading

yceruto Dec 7, 2025 •

edited

Loading

yceruto commented Dec 7, 2025 •

edited

Loading

GromNaN left a comment •

edited

Loading