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 0b1f17206c minor #13829 [Process] prefix should not be escaped (pyrech)
This PR was merged into the 2.3 branch.

Discussion
----------

[Process] prefix should not be escaped

| Q             | A
| ------------- | ---
| Bug fix?      | yes
| New feature?  | no
| BC breaks?    | no
| Deprecations? | no
| Tests pass?   | yes
| Fixed tickets | #12826
| License       | MIT
| Doc PR        | -

The phpdoc of `ProcessBuilder#setPrefix` says:

```
Adds an unescaped prefix to the command string.
```
But in the current implementation, the prefix is merged with arguments array and then is escaped which seems wrong.

Commits
-------

67f65c9 Update phpdoc of ProcessBuilder#setPrefix()
2015-03-27 16:19:08 +01:00
..
Exception [Process] added exit code to ProcessFailedException message 2013-04-11 19:56:25 +06:00
Tests CS: Convert double quotes to single quotes 2015-03-21 12:11:30 +01:00
.gitignore Added missing files .gitignore 2013-07-21 14:12:18 +02:00
CHANGELOG.md merged branch hason/process (PR #6796) 2013-04-21 10:43:42 +02:00
composer.json [2.3] require-dev PHPUnit bridge 2015-02-24 11:24:26 +01: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 use value of DIRECTORY_SEPARATOR to detect Windows 2014-12-30 12:17:23 +01:00
PhpProcess.php [2.3][Process] Fixed PhpProcess::getCommandLine() result 2015-02-24 09:27:06 +01:00
phpunit.xml.dist [2.3] require-dev PHPUnit bridge 2015-02-24 11:24:26 +01:00
Process.php CS: Convert double quotes to single quotes 2015-03-21 12:11:30 +01:00
ProcessBuilder.php Update phpdoc of ProcessBuilder#setPrefix() 2015-03-27 16:14:25 +01:00
ProcessPipes.php [2.3] CS And DocBlock Fixes 2014-12-22 16:58:09 +01:00
ProcessUtils.php use value of DIRECTORY_SEPARATOR to detect Windows 2014-12-30 12:17:23 +01: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