feature #62068 [Console] Add support for Cursor helper in invokable commands (yceruto)

nicolas-grekas · nicolas-grekas · commit d7b109788783 · 2025-10-14T17:50:15.000+02:00
This PR was merged into the 7.4 branch. Discussion ---------- [Console] Add support for `Cursor` helper in invokable commands | Q | A | ------------- | --- | Branch? | 7.4 | Bug fix? | no | New feature? | yes | Deprecations? | no | Issues | - | License | MIT I missed including this helper in #59340 and it's particularly useful for creating dynamic console commands. **Before:** ```php #[AsCommand('make:pizza')] class MakePizza { public function __invoke(OutputInterface $output): int { $cursor = new Cursor($output); // ... } } ``` **After:** ```php #[AsCommand('make:pizza')] class MakePizza { public function __invoke(Cursor $cursor): int { // ... } } ``` Cheers! Commits ------- f8f0683 [Console] Add support for `Cursor` helper in invokable commands
diff --git a/src/Symfony/Component/Console/CHANGELOG.md b/src/Symfony/Component/Console/CHANGELOG.md
@@ -14,6 +14,7 @@ CHANGELOG
  * Add `#[MapInput]` attribute to support DTOs in commands
  * Add optional timeout for interaction in `QuestionHelper`
  * Add support for interactive invokable commands with `#[Interact]` and `#[Ask]` attributes
+ * Add support for `Cursor` helper in invokable commands
 
 7.3
 ---
diff --git a/src/Symfony/Component/Console/Command/InvokableCommand.php b/src/Symfony/Component/Console/Command/InvokableCommand.php
@@ -16,6 +16,7 @@
 use Symfony\Component\Console\Attribute\Interact;
 use Symfony\Component\Console\Attribute\MapInput;
 use Symfony\Component\Console\Attribute\Option;
+use Symfony\Component\Console\Cursor;
 use Symfony\Component\Console\Exception\LogicException;
 use Symfony\Component\Console\Exception\RuntimeException;
 use Symfony\Component\Console\Input\InputArgument;
@@ -174,6 +175,7 @@ private function getParameters(\ReflectionFunction $function, InputInterface $in
             $parameters[] = match ($type->getName()) {
                 InputInterface::class => $input,
                 OutputInterface::class => $output,
+                Cursor::class => new Cursor($output),
                 SymfonyStyle::class => new SymfonyStyle($input, $output),
                 Application::class => $this->command->getApplication(),
                 default => throw new RuntimeException(\sprintf('Unsupported type "%s" for parameter "$%s".', $type->getName(), $parameter->getName())),
diff --git a/src/Symfony/Component/Console/Tests/Command/InvokableCommandTest.php b/src/Symfony/Component/Console/Tests/Command/InvokableCommandTest.php
@@ -14,19 +14,22 @@
 use PHPUnit\Framework\Assert;
 use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\TestCase;
+use Symfony\Component\Console\Application;
 use Symfony\Component\Console\Attribute\Argument;
 use Symfony\Component\Console\Attribute\Option;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Completion\CompletionInput;
 use Symfony\Component\Console\Completion\CompletionSuggestions;
 use Symfony\Component\Console\Completion\Suggestion;
+use Symfony\Component\Console\Cursor;
 use Symfony\Component\Console\Exception\InvalidArgumentException;
 use Symfony\Component\Console\Exception\InvalidOptionException;
 use Symfony\Component\Console\Exception\LogicException;
 use Symfony\Component\Console\Input\ArrayInput;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\NullOutput;
 use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\Console\Style\SymfonyStyle;
 use Symfony\Component\Console\Tests\Fixtures\InvokableTestCommand;
 
 class InvokableCommandTest extends TestCase
@@ -462,6 +465,25 @@ public function testInvalidRequiredValueOptionEvenWithDefault()
         $command->run(new ArrayInput(['--a' => null]), new NullOutput());
     }
 
+    public function testHelpersInjection()
+    {
+        $command = new Command('foo');
+        $command->setApplication(new Application());
+        $command->setCode(function (
+            InputInterface $input,
+            OutputInterface $output,
+            Cursor $cursor,
+            SymfonyStyle $io,
+            Application $application,
+        ): int {
+            $this->addToAssertionCount(1);
+
+            return 0;
+        });
+
+        $command->run(new ArrayInput([]), new NullOutput());
+    }
+
     public function getSuggestedRoles(CompletionInput $input): array
     {
         return ['ROLE_ADMIN', 'ROLE_USER'];
