[Console] Add ArgvInput::__toString and ArrayInput::__toString, fixes #7257

Seldaek · Seldaek · commit 659eb663c69e · 2013-04-12T15:43:52.000+02:00
diff --git a/src/Symfony/Component/Console/Input/ArgvInput.php b/src/Symfony/Component/Console/Input/ArgvInput.php
@@ -312,4 +312,23 @@ public function getParameterOption($values, $default = false)
 
         return $default;
     }
+
+    /**
+     * Returns a stringified representation of the args passed to the command
+     *
+     * @return string
+     */
+    public function __toString()
+    {
+        $tokens = array_map(function ($token) {
+            $token = addcslashes($token, '"');
+            if (false !== strpos($token, ' ')) {
+                return '"'.$token.'"';
+            }
+
+            return $token;
+        }, $this->tokens);
+
+        return implode(' ', $tokens);
+    }
 }
diff --git a/src/Symfony/Component/Console/Input/ArrayInput.php b/src/Symfony/Component/Console/Input/ArrayInput.php
@@ -110,6 +110,29 @@ public function getParameterOption($values, $default = false)
         return $default;
     }
 
+    /**
+     * Returns a stringified representation of the args passed to the command
+     *
+     * @return string
+     */
+    public function __toString()
+    {
+        $params = array();
+        foreach ($this->parameters as $param => $val) {
+            $val = addcslashes($val, '"');
+            if (false !== strpos($val, ' ')) {
+                $val = '"'.$val.'"';
+            }
+            if ($param && '-' === $param[0]) {
+                $params[] = $param . ('' != $val ? ' '.$val : $val);
+            } else {
+                $params[] = $val;
+            }
+        }
+
+        return implode(' ', $params);
+    }
+
     /**
      * Processes command line arguments.
      */
diff --git a/src/Symfony/Component/Console/Tests/Input/ArgvInputTest.php b/src/Symfony/Component/Console/Tests/Input/ArgvInputTest.php
@@ -255,6 +255,15 @@ public function testHasParameterOption()
         $this->assertFalse($input->hasParameterOption('--foo'), '->hasParameterOption() returns false if the given short option is not in the raw input');
     }
 
+    public function testToString()
+    {
+        $input = new ArgvInput(array('cli.php', '-f', 'foo'));
+        $this->assertEquals('-f foo', (string) $input);
+
+        $input = new ArgvInput(array('cli.php', '-f', '--bar=foo', 'a b c d'));
+        $this->assertEquals('-f --bar=foo "a b c d"', (string) $input);
+    }
+
     /**
      * @dataProvider provideGetParameterOptionValues
      */
diff --git a/src/Symfony/Component/Console/Tests/Input/ArrayInputTest.php b/src/Symfony/Component/Console/Tests/Input/ArrayInputTest.php
@@ -120,4 +120,10 @@ public function provideInvalidInput()
             )
         );
     }
+
+    public function testToString()
+    {
+        $input = new ArrayInput(array('-f' => null, '-b' => 'bar', '--foo' => 'b a z', '--lala' => null, 'test' => 'Foo'));
+        $this->assertEquals('-f -b bar --foo "b a z" --lala Foo', (string) $input);
+    }
 }
diff --git a/src/Symfony/Component/Console/Tests/Input/StringInputTest.php b/src/Symfony/Component/Console/Tests/Input/StringInputTest.php
@@ -73,4 +73,16 @@ public function getTokenizeData()
             array('foo -a -ffoo --long bar', array('foo', '-a', '-ffoo', '--long', 'bar'), '->tokenize() parses when several arguments and options'),
         );
     }
+
+    public function testToString()
+    {
+        $input = new StringInput('-f foo');
+        $this->assertEquals('-f foo', (string) $input);
+
+        $input = new StringInput('-f --bar=foo "a b c d"');
+        $this->assertEquals('-f --bar=foo "a b c d"', (string) $input);
+
+        $input = new StringInput('-f --bar=foo \'a b c d\'');
+        $this->assertEquals('-f --bar=foo "a b c d"', (string) $input);
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -120,4 +120,10 @@ public function provideInvalidInput()`
`120`	`120`	`)`
`121`	`121`	`);`
`122`	`122`	`}`
	`123`	`+`
	`124`	`+ public function testToString()`
	`125`	`+ {`
	`126`	`+ $input = new ArrayInput(array('-f' => null, '-b' => 'bar', '--foo' => 'b a z', '--lala' => null, 'test' => 'Foo'));`
	`127`	`+ $this->assertEquals('-f -b bar --foo "b a z" --lala Foo', (string) $input);`
	`128`	`+ }`
`123`	`129`	`}`