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
2012-02-22 14:38:43 +01:00
..
composer.json Revert "merged 2.0" 2012-01-08 20:43:02 +01:00
ExecutableFinder.php [Process] workaround a faulty implementation of is_executable on Windows 2011-09-15 19:42:58 +02:00
LICENSE added LICENSE files for the subtree repositories 2011-02-22 18:58:15 +01:00
PhpExecutableFinder.php [Process] introduced usage of PHP_BINARY (available as of PHP 5.4) 2011-12-07 19:32:30 +01:00
PhpProcess.php [Process] changed ExecutableFinder to return false instead of throwing an exception when the executable is not found 2011-04-26 15:18:24 +02:00
Process.php Feedback fixes 2012-02-22 14:38:43 +01:00
ProcessBuilder.php Feedback fixes 2012-02-22 14:38:43 +01:00
README.md tweaked the README files 2011-12-18 14:22:28 +01: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;

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

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.

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 ('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

Unit tests:

https://github.com/symfony/symfony/tree/master/tests/Symfony/Tests/Component/Process