This repository has been archived on 2023-08-20. You can view files and clone it, but cannot push or open issues or pull requests.
symfony/src/Symfony/Component/Process
Fabien Potencier a15c9eb82d Merge branch '2.7' into 2.8
* 2.7:
  added the new Composer exclude-from-classmap option
  added the new Composer exclude-from-classmap option
  fix expected argument type docblock
  Set back libxml settings after testings.
  fixed Twig deprecation notices
2015-10-30 13:15:42 -07:00
..
Exception Include working directory in ProcessFailedException 2015-06-10 17:09:10 +02:00
Pipes Throw exception if tempnam returns false 2015-10-03 22:13:32 +02:00
Tests Merge branch '2.7' into 2.8 2015-10-10 20:55:46 +02:00
.gitignore Added missing files .gitignore 2013-07-21 14:12:18 +02:00
CHANGELOG.md [Process] Deprecate using values that are not string for Process::setStdin and ProcessBuilder::setInput 2014-05-23 11:02:52 +02:00
composer.json Merge branch '2.7' into 2.8 2015-10-30 13:15:42 -07:00
ExecutableFinder.php [Process] Workaround buggy PHP warning 2015-10-09 23:59:27 +02:00
LICENSE Updated copyright to 2015 2015-01-01 13:56:52 +01:00
PhpExecutableFinder.php Minor fixes 2015-06-30 18:05:31 +02:00
PhpProcess.php [Process] Inherit env vars by default in PhpProcess 2015-10-20 18:32:03 +02:00
phpunit.xml.dist Merge branch '2.3' into 2.7 2015-10-11 11:39:48 +02:00
Process.php Merge branch '2.3' into 2.7 2015-10-23 16:47:27 +02:00
ProcessBuilder.php Merge branch '2.6' into 2.7 2015-03-30 17:55:07 +02:00
ProcessUtils.php Merge branch '2.6' into 2.7 2015-06-18 15:03:50 +02:00
README.md [Process] tweaked README 2015-10-18 11:49:40 +02:00

Process Component

Process executes commands in sub-processes.

In this example, we run a simple directory listing and get the result back:

use Symfony\Component\Process\Process;
use Symfony\Component\Process\Exception\ProcessFailedException;

$process = new Process('ls -lsa');
$process->setTimeout(3600);
$process->run();
if (!$process->isSuccessful()) {
    throw new ProcessFailedException($process);
}

print $process->getOutput();

You can think that this is easy to achieve with plain PHP but it's not especially if you want to take care of the subtle differences between the different platforms.

You can simplify the code by using mustRun() instead of run(), which will throw a ProcessFailedException automatically in case of a problem:

use Symfony\Component\Process\Process;

$process = new Process('ls -lsa');
$process->setTimeout(3600);
$process->mustRun();

print $process->getOutput();

And if you want to be able to get some feedback in real-time, just pass an anonymous function to the run() method and you will get the output buffer as it becomes available:

use Symfony\Component\Process\Process;

$process = new Process('ls -lsa');
$process->run(function ($type, $buffer) {
    if (Process::ERR === $type) {
        echo 'ERR > '.$buffer;
    } else {
        echo 'OUT > '.$buffer;
    }
});

That's great if you want to execute a long running command (like rsync-ing files to a remote server) and give feedback to the user in real-time.

Resources

You can run the unit tests with the following command:

$ cd path/to/Symfony/Component/Process/
$ composer install
$ phpunit