added phpdoc to ProcessRunnter->run() (#1533)

This commit is contained in:
Markus Staab 2018-02-15 08:34:23 +01:00 committed by Anton Medvedev
parent c1e2633687
commit 6cfc6173ed

View File

@ -8,6 +8,7 @@
namespace Deployer\Utility;
use Deployer\Deployer;
use Symfony\Component\Process\Exception\ProcessFailedException;
use Symfony\Component\Process\Process;
class ProcessRunner
@ -22,6 +23,17 @@ class ProcessRunner
$this->pop = $pop;
}
/**
* Runs a command, consider deployer global configs (timeout,...)
*
* @param string $hostname
* @param string $command
* @param array $config
*
* @return string
*
* @throws ProcessFailedException When the process does not return a 0 exit code.
*/
public function run($hostname, string $command, array $config = [])
{
$defaults = [