1. Home
2. Documentation
3. Components
4. Console
5. Helpers
6. Process Helper

Process Helper

2.7 version

Maintained

3.4 4.4 5.1 current 5.2 master

Unmaintained

2.6 2.8 3.0 3.1 3.2 3.3 4.0 4.1 4.2 4.3 5.0

• Process Helper
  • Arguments
  • Customized Display

Process Helper¶

New in version 2.6: The Process Helper was introduced in Symfony 2.6.

The Process Helper shows processes as they’re running and reports useful information about process status.

To display process details, use the Symfony\Component\Console\Helper\ProcessHelper and run your command with verbosity. For example, running the following code with a very verbose verbosity (e.g. -vv):

use Symfony\Component\Process\ProcessBuilder;

$helper = $this->getHelper('process');
$process = ProcessBuilder::create(array('figlet', 'Symfony'))->getProcess();

$helper->run($output, $process);

will result in this output:

It will result in more detailed output with debug verbosity (e.g. -vvv):

In case the process fails, debugging is easier:

Arguments¶

There are three ways to use the process helper:

• Using a command line string:

  // ...
  $helper->run($output, 'figlet Symfony');
  

• An array of arguments:

  // ...
  $helper->run($output, array('figlet', 'Symfony'));
  

  Note

  When running the helper against an array of arguments, be aware that these will be automatically escaped.

• Passing a Symfony\Component\Process\Process instance:

  use Symfony\Component\Process\ProcessBuilder;
  
  // ...
  $process = ProcessBuilder::create(array('figlet', 'Symfony'))->getProcess();
  
  $helper->run($output, $process);
  

Customized Display¶

You can display a customized error message using the third argument of the run() method:

$helper->run($output, $process, 'The process failed :(');

A custom process callback can be passed as the fourth argument. Refer to the Process Component for callback documentation:

use Symfony\Component\Process\Process;

$helper->run($output, $process, 'The process failed :(', function ($type, $data) {
    if (Process::ERR === $type) {
        // ... do something with the stderr output
    } else {
        // ... do something with the stdout
    }
});