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
Mikael Pajunen 75d0d593e3 Use PHPUnit ini_set wrapper in tests
PHPUnit ini_set wrapper is now used in tests to automatically reset
ini settings after the test is run. This avoids possible side effects
and test skipping.

Native ini_set is still used in DefaultCsrfProviderTest, but its
tests are run in isolation.
2015-01-02 18:15:09 +02:00
..
Exception [Process] added exit code to ProcessFailedException message 2013-04-11 19:56:25 +06:00
Tests Use PHPUnit ini_set wrapper in tests 2015-01-02 18:15:09 +02: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 updated the branch alias in composer files 2013-01-31 22:39:01 +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 Docblock fixes 2014-11-30 13:33:44 +00:00
phpunit.xml.dist [Tests] Silenced all deprecations in tests for 2.3 2014-12-18 20:00:19 +01:00
Process.php Fixes Issue #13184 - incremental output getters now return empty strings 2015-01-02 09:08:40 +01:00
ProcessBuilder.php [2.3] CS And DocBlock Fixes 2014-12-22 16:58:09 +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 [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