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
2014-03-31 10:11:45 +02:00
..
Exception When a process fails, check if the output is enabled 2014-03-25 23:03:32 +01:00
Tests [Process] Fix Process test suite 2014-03-31 10:11:45 +02:00
.gitignore Added missing files .gitignore 2013-07-21 14:12:18 +02:00
CHANGELOG.md feature #8655 Adds PTY mode & convenience method mustRun() (schmittjoh) 2014-02-03 09:11:05 +01:00
composer.json updated version to 2.5 2013-11-24 21:17:07 +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 update year on licenses 2014-01-07 08:19:25 -05:00
PhpExecutableFinder.php Add support SAPI cli-server 2014-01-05 02:14:11 +01: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.4' 2014-03-26 12:51:10 +01:00
ProcessBuilder.php [Process] Add Process::disableOutput and Process::enableOutput methods 2014-03-12 12:02:04 +01:00
ProcessPipes.php Merge branch '2.4' 2014-03-26 12:51:10 +01:00
ProcessUtils.php [Process] Fix escaping on Windows 2014-03-18 15:00:41 +01: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