[Console] Allow to returns all tokens after the command name

symfony · Mar 20, 2024 · 5d24503 · 5d24503
1 parent a9133af
commit 5d24503
Show file tree

Hide file tree

Showing 2 changed files with 47 additions and 2 deletions.
diff --git a/src/Symfony/Component/Console/Input/ArgvInput.php b/src/Symfony/Component/Console/Input/ArgvInput.php
@@ -348,11 +348,30 @@ public function getParameterOption(string|array $values, string|bool|int|float|a
     /**
      * Returns un-parsed and not validated tokens.
      *
+     * @param bool $strip Whether to return the raw parameters (false) or the values after the command name (true)
+     *
      * @return list<string>
      */
-    public function getRawTokens(): array
+    public function getRawTokens(bool $strip = false): array
     {
-        return $this->tokens;
+        if (!$strip) {
+            return $this->tokens;
+        }
+
+        $parameters = [];
+        $keep = false;
+        foreach ($this->tokens as $value) {
+            if ($value === $this->getFirstArgument()) {
+                $keep = true;
+
+                continue;
+            }
+            if ($keep) {
+                $parameters[] = $value;
+            }
+        }
+
+        return $parameters;
     }
 
     /**

diff --git a/src/Symfony/Component/Console/Tests/Input/ArgvInputTest.php b/src/Symfony/Component/Console/Tests/Input/ArgvInputTest.php
@@ -562,4 +562,30 @@ public function testParseOptionWithValueOptionalGivenEmptyAndOptionalArgument()
         $this->assertEquals(['foo' => '0'], $input->getOptions(), '->parse() parses optional options with empty value as null');
         $this->assertEquals(['name' => 'bar'], $input->getArguments(), '->parse() parses optional arguments');
     }
+
+    public function testGetRawTokensFalse()
+    {
+        $input = new ArgvInput(['cli.php', '--foo', 'bar']);
+        $this->assertSame(['--foo', 'bar'], $input->getRawTokens());
+    }
+
+    /**
+     * @dataProvider provideGetRawTokensTrueTests
+     */
+    public function testGetRawTokensTrue(array $argv, array $expected)
+    {
+        $input = new ArgvInput($argv);
+        $this->assertSame($expected, $input->getRawTokens(true));
+    }
+
+    public static function provideGetRawTokensTrueTests(): iterable
+    {
+        yield [['app/console', 'foo:bar'], []];
+        yield [['app/console', 'foo:bar', '--env=prod'], ['--env=prod']];
+        yield [['app/console', 'foo:bar', '--env', 'prod'], ['--env', 'prod']];
+        yield [['app/console', '--no-ansi', 'foo:bar', '--env', 'prod'], ['--env', 'prod']];
+        yield [['app/console', '--no-ansi', 'foo:bar', '--env', 'prod'], ['--env', 'prod']];
+        yield [['app/console', '--no-ansi', 'foo:bar', 'argument'], ['argument']];
+        yield [['app/console', '--no-ansi', 'foo:bar', '--', 'argument'], ['--', 'argument']];
+    }
 }