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
jgonzalezlopez 7bb98e2146 Update WindowsPipes.php
This file has made that my assetic had an error, the property assignment have an extra "$" that it mustn't be present. Please correct it
2014-06-18 13:43:36 +02:00
..
Exception When a process fails, check if the output is enabled 2014-03-25 23:03:32 +01:00
Pipes Update WindowsPipes.php 2014-06-18 13:43:36 +02:00
Tests [Process] Add support for streams as input 2014-06-17 07:31: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 updated version to 2.6 2014-05-23 16:36:49 +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 update year on licenses 2014-01-07 08:19:25 -05:00
PhpExecutableFinder.php [Process] fixed HHVM usage on the CLI 2014-03-30 09:33:30 +02:00
PhpProcess.php made phpdoc types consistent with those defined in Hack 2014-04-15 07:41:45 +02: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] Add support for streams as input 2014-06-17 07:31:38 +02:00
ProcessBuilder.php [Process] Deprecate using values that are not string for Process::setStdin and ProcessBuilder::setInput 2014-05-23 11:02:52 +02:00
ProcessUtils.php [Process] Add support for streams as input 2014-06-17 07:31:38 +02:00
README.md [Process] Minor README update 2014-06-11 09:56:44 +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 (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.phar install
$ phpunit