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
Pascal Borreli e8af42e780 Fixed typos
2013-11-09 12:55:32 +01:00
..
Exception fixed CS 2013-10-30 09:33:58 +01:00
Tests Merge branch '2.3' 2013-10-30 09:31:46 +01:00
.gitignore Added missing files .gitignore 2013-07-21 14:12:18 +02:00
CHANGELOG.md [Process] updated the CHANGELOG 2013-08-03 08:07: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 Merge branch '2.3' 2013-10-30 09:31:46 +01:00
ProcessBuilder.php fixed CS 2013-10-30 09:33:58 +01:00
ProcessPipes.php Fixed typos 2013-11-09 12:55:32 +01:00
ProcessUtils.php Fix empty process argument escaping on Windows 2013-08-08 14:56:07 +02:00
README.md updated the composer install command to reflect changes in Composer 2013-09-18 09:27:26 +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;

$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
$ phpunit