Added command timing

Author: kamermans

examples/complex_statement.php

@@ -9,15 +9,11 @@
 
 // This example probably only works in real BASH on Linux/UNIX
 // It will output a sorted list of directories in the $PATH
-//$cmd = Command::factory('IFS=":"; (for DIR in $PATH; do echo $DIR; done) | sort', $escape)->run();
-$cmd = Command::factory('IFS=":"; (for DIR in $PATH; do echo $DIR; done) | sort', $no_escape)->run();
+$cmd = Command::factory('IFS=":"; (for DIR in $PATH; do echo $DIR; done) | sort', $no_escape)
+    // Throw an exception if it fails
+    ->useExceptions()
+    ->run();
 
-if ($cmd->getExitCode() === 0) {
-	echo "STDOUT:\n";
-    echo $cmd->getStdOut();
-} else {
-	echo "STDERR:\n";
-    echo $cmd->getStdErr();
-}
+echo $cmd->getStdOut();
 
 echo "Done.\n";

examples/timing.php

@@ -0,0 +1,14 @@
+<?php
+
+use kamermans\Command\Command;
+
+require_once __DIR__.'/../vendor/autoload.php';
+
+$cmd = Command::factory('sleep 2 && echo "OK"', true)
+    // Throw an exception if it fails
+    ->useExceptions()
+    ->run();
+
+echo $cmd->getStdOut();
+echo "Finished in ".$cmd->getDuration()." second(s)\n";
+echo " (with microseconds: ".$cmd->getDuration(true).")\n";

src/Command.php

@@ -33,6 +33,8 @@ class Command
     protected $_stdout = null;
     protected $_stderr = null;
     protected $_callback = null;
+    protected $_timestart = null;
+    protected $_timeend = null;
     protected $_cwd = null;
     protected $_env = null;
     protected $_conf = array();
@@ -189,6 +191,7 @@ public function run($stdin = null)
         $this->_exitcode = null;
         $this->_stdout = null;
         $this->_stderr = null;
+        $this->_timestart = microtime(true);
 
         // Prepare the buffers structure
         $buffers = array(
@@ -197,9 +200,10 @@ public function run($stdin = null)
             2 => &$this->_stderr,
         );
         $this->_exitcode = self::exec($this->getFullCommand(), $buffers, $this->_callback, $this->_cwd, $this->_env, $this->_conf);
+        $this->_timeend = microtime(true);
 
         if ($this->_throw && $this->_exitcode !== 0) {
-            throw new CommandException($this, "Command failed '".$this->getFullCommand()."':\n".trim($this->getStdErr()));
+            throw new CommandException($this, "Command failed '$this':\n".trim($this->getStdErr()));
         }
 
         return $this;
@@ -250,6 +254,17 @@ public function getStdErr()
         return $this->_stderr;
     }
 
+    /**
+     * Gets the duration of the command execution
+     *
+     * @param bool $microseconds If true, return microseconds (float), otherwise seconds (int)
+     * @return int|float
+     */
+    public function getDuration($microseconds=false)
+    {
+        $duration = $this->_timeend - $this->_timestart;
+        return $microseconds? $duration: round($duration);
+    }
 
     /**
      * Executes a command returning the exitcode and capturing the stdout and stderr