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 e4da1956a2 merged branch schmittjoh/processIdleTimeout (PR #8651)
This PR was merged into the master branch.

Discussion
----------

adds ability to define an idle timeout

This adds the ability to define an idle timeout which in contrast to the current timeout considers only the time since the last output was produced by a process.

It also adds a special exception for timeout cases.

Commits
-------

b922ba2 adds ability to define an idle timeout
2013-08-03 08:07:08 +02:00
..
Exception adds ability to define an idle timeout 2013-08-02 21:45:12 +02:00
Tests merged branch schmittjoh/processIdleTimeout (PR #8651) 2013-08-03 08:07:08 +02:00
.gitignore Added missing files .gitignore 2013-07-21 14:12:18 +02:00
CHANGELOG.md merged branch hason/process (PR #6796) 2013-04-21 10:43:42 +02:00
composer.json updated version to 2.4 2013-05-16 09:54:39 +02:00
ExecutableFinder.php [Process] Fix docblocks, remove return from PhpProcess#start() as parent returns nothing, cleaned up ExecutableFinder 2013-01-12 13:49:05 +01:00
LICENSE updated license year 2013-01-04 17:59:43 +01:00
PhpExecutableFinder.php Fixed #8455: PhpExecutableFinder::find() does not always return the correct binary 2013-07-21 14:15:26 +02:00
PhpProcess.php Merge branch '2.1' 2013-01-17 16:25:59 +01:00
phpunit.xml.dist made usage of Composer autoloader for subtree-split unit tests 2012-11-09 14:10:06 +01:00
Process.php adds ability to define an idle timeout 2013-08-02 21:45:12 +02:00
ProcessBuilder.php [Process] moved env check to the Process class (refs #8227) 2013-06-13 08:52:49 +02:00
ProcessUtils.php fixed CS 2013-07-01 14:24:43 +02:00
README.md made usage of Composer autoloader for subtree-split unit tests 2012-11-09 14:10:06 +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

You can run the unit tests with the following command:

$ cd path/to/Symfony/Component/XXX/
$ composer.phar install --dev
$ phpunit