Merge pull request #28 from netconsult-sweden/master

Enable feeding a string from php to standard input

Author: mikehaertl

README.md

@@ -58,6 +58,9 @@ $command->addArg('--name=', "d'Artagnan");
 // Add argument with several values
 // results in --keys key1 key2
 $command->addArg('--keys', array('key1','key2'));
+
+// Add string to pipe to command on standard input
+$command->setStdIn('string');
 ```
 
 ## API
@@ -108,6 +111,7 @@ pass `command`, `execCommand` and `args` as options. This will call the respecti
        An array can be passed to add more than one value for a key, e.g. `addArg('--exclude', array('val1','val2'))`
        which will create the option "--exclude 'val1' 'val2'".
     * `$escape`: If set, this overrides the `$escapeArgs` setting and enforces escaping/no escaping
+ * `setStdIn()`: String to supply command via standard input.
  * `getOutput()`: The command output as string. Empty if none.
  * `getError()`: The error message, either stderr or internal message. Empty if no error.
  * `getStdErr()`: The stderr output. Empty if none.

src/Command.php

@@ -59,6 +59,11 @@ class Command
      */
     public $locale;
 
+    /**
+     * @var string to pipe to standard input
+     */
+    protected $_stdIn;
+
     /**
      * @var string the command to execute
      */
@@ -166,6 +171,16 @@ public function setCommand($command)
         return $this;
     }
 
+    /**
+     * @param string $stdIn If set, the string will be piped to the command via standard input.
+     * This enables the same functionality as piping on the command line.
+     * @return static for method chaining
+     */
+    public function setStdIn($stdIn) {
+        $this->_stdIn = $stdIn;
+        return $this;
+    }
+
     /**
      * @return string|null the command that was set through setCommand() or passed to the constructor. Null if none.
      */
@@ -322,10 +337,18 @@ public function execute()
                 1   => array('pipe','w'),
                 2   => array('pipe', $this->getIsWindows() ? 'a' : 'w'),
             );
+            if ($this->_stdIn!==null) {
+                $descriptors[0] = array('pipe', 'r');
+            }
+
             $process = proc_open($command, $descriptors, $pipes, $this->procCwd, $this->procEnv, $this->procOptions);
 
             if (is_resource($process)) {
 
+                if($this->_stdIn!==null) {
+                    fwrite($pipes[0], $this->_stdIn);
+                    fclose($pipes[0]);
+                }
                 $this->_stdOut = stream_get_contents($pipes[1]);
                 $this->_stdErr = stream_get_contents($pipes[2]);
                 fclose($pipes[1]);

tests/CommandTest.php

@@ -224,5 +224,14 @@ public function testCanProvideProcDir()
         $this->assertTrue($command->getExecuted());
         $this->assertEquals($tmpDir, $command->getOutput());
     }
+    public function testCanRunCommandWithStandardInput()
+    {
+        $command = new Command('/bin/cat');
+        $command->addArg('-T');
+        $command->setStdIn("\t");
+        $this->assertTrue($command->execute());
+        $this->assertTrue($command->getExecuted());
+        $this->assertEquals("^I", $command->getOutput());
+    }
 
 }