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 7575d0d2ca minor #12696 [2.7][Process] Add deprecation message for component (romainneutron)
This PR was merged into the 2.7 branch.

Discussion
----------

[2.7][Process] Add deprecation message for component

| Q             | A
| ------------- | ---
| Bug fix?      | no
| New feature?  | no
| BC breaks?    | no
| Deprecations? | no
| Tests pass?   | yes
| Fixed tickets | n/a
| License       | MIT

Commits
-------

b9a6b71 Add deprecation message for Process
2014-11-29 13:59:17 +01:00
..
Exception When a process fails, check if the output is enabled 2014-03-25 23:03:32 +01:00
Pipes Remove aligned '=>' and '=' 2014-11-04 15:29:39 +01:00
Tests Merge branch '2.5' 2014-11-03 20:49:01 +01: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.7 2014-11-10 19:00:54 +01:00
ExecutableFinder.php [Process] Fixes issue #11421 2014-07-19 17:29:08 -06:00
LICENSE update year on licenses 2014-01-07 08:19:25 -05:00
PhpExecutableFinder.php Use separated function to resolve command and related arguments 2014-09-11 18:27:13 +02:00
PhpProcess.php made phpdoc types consistent with those defined in Hack 2014-04-15 07:41:45 +02:00
phpunit.xml.dist Adjust error_reporting to allow deprecation messages for 3.0 2014-11-29 13:40:43 +01:00
Process.php Add deprecation message for Process 2014-11-29 12:54:42 +01:00
ProcessBuilder.php Merge branch '2.4' into 2.5 2014-07-08 14:21:33 +02:00
ProcessUtils.php [Process] Add support for streams as input 2014-06-17 07:31:38 +02:00
README.md [Doc] Use Markdown syntax highlighting 2014-10-01 07:38:33 +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