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 2b473cbb65 Merge branch '2.2'
* 2.2:
  added missing license blocks
  added missing license blocks
2013-04-22 06:30:07 +02:00
..
Exception [Process] added exit code to ProcessFailedException message 2013-04-11 19:56:25 +06:00
Tests Merge branch '2.2' 2013-04-22 06:30:07 +02:00
.gitignore made usage of Composer autoloader for subtree-split unit tests 2012-11-09 14:10:06 +01:00
CHANGELOG.md merged branch hason/process (PR #6796) 2013-04-21 10:43:42 +02:00
composer.json updated the branch alias in composer files 2013-01-31 22:39:01 +01: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 [Process] Add default xampp path to the list of possible paths to check 2012-07-03 18:58:37 +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 [Process] fixed CS 2013-04-20 14:33:48 +02:00
ProcessBuilder.php merged branch hason/process (PR #6796) 2013-04-21 10:43:42 +02:00
ProcessUtils.php [Process] Added ProcessUtils::escapeArgument() to fix the bug in escapeshellarg() function on Windows 2013-01-18 14:43:03 +01: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