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
Nicolas Grekas 209047ea79 Merge branch '2.3' into 2.7
Conflicts:
	src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php
	src/Symfony/Bundle/SecurityBundle/composer.json
	src/Symfony/Component/Process/Process.php
2015-10-06 10:31:51 +02:00
..
Exception When a process fails, check if the output is enabled 2014-03-25 23:03:32 +01:00
Pipes Throw exception if tempnam returns false 2015-10-03 22:13:32 +02:00
Tests Merge branch '2.3' into 2.7 2015-09-27 12:08:38 +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.6' into 2.7 2015-05-02 17:21:08 +02:00
ExecutableFinder.php use value of DIRECTORY_SEPARATOR to detect Windows 2014-12-30 12:17:23 +01: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 remove api tags from code 2015-09-28 19:11:22 +02:00
phpunit.xml.dist [2.3] require-dev PHPUnit bridge 2015-02-24 11:24:26 +01:00
Process.php Merge branch '2.3' into 2.7 2015-10-06 10:31:51 +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 renamed composer.phar to composer to be consistent with the Symfony docs 2015-02-08 08:41:14 +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 (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