gggeek / db-3v4l

app/src/Service/ProcessManager.php

<?php

Missing file doc comment

namespace Db3v4l\Service;

use Symfony\Component\Process\Process;

The type Symfony\Component\Process\Process was not found. Maybe you did not declare it correctly or list all dependencies?

/**
 * This ProcessManager is a simple wrapper to enable parallel processing using Symfony Process component.
 * Original source code from https://github.com/jagandecapri/symfony-parallel-process/blob/master/src/ProcessManager.php (MIT lic.)
 */

Missing @category tag in class comment

Missing @package tag in class comment

Missing @author tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

class ProcessManager
{
    /**

Missing short description in doc comment

     * @param Process[] $processes

Missing parameter comment

     * @param int $maxParallel

Missing parameter comment

Expected 7 spaces after parameter type; 1 found

     * @param int $poll microseconds

Expected 7 spaces after parameter type; 1 found

Expected 8 spaces after parameter name; 1 found

     * @param Callable $callback takes 4 args: $type, $buffer, $processIndex, $process

Expected 2 spaces after parameter type; 1 found

Expected 4 spaces after parameter name; 1 found

     */

Missing @return tag in function comment

    public function runParallel(array $processes, $maxParallel, $poll = 1000, $callback = null)
    {
        $this->validateProcesses($processes);
        // do not modify the object pointers in the argument, copy to local working variable
        $processesQueue = $processes;
        // fix maxParallel to be max the number of processes or positive
        $maxParallel = min(abs($maxParallel), count($processesQueue));
        // get the first stack of processes to start at the same time
        /** @var Process[] $currentProcesses */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

        $currentProcesses = array_splice($processesQueue, 0, $maxParallel);
        // start the initial stack of processes
        foreach ($currentProcesses as $idx => $process) {
            $process->start(function ($type, $buffer) use ($callback, $idx, $process) {

The opening parenthesis of a multi-line function call should be the last content on the line.

                if ($callback) {
                    $callback($type, $buffer, $idx, $process);
                }
            });

For multi-line function calls, the closing parenthesis should be on a new line.

        }
        do {
            // wait for the given time
            usleep($poll);
            // remove all finished processes from the stack
            foreach ($currentProcesses as $index => $process) {
                if (!$process->isRunning()) {
                    unset($currentProcesses[$index]);
                    // directly add and start new process after the previous finished
                    if (count($processesQueue) > 0) {
                        $nextProcess = array_shift($processesQueue);
                        $nextProcess->start(function ($type, $buffer) use ($callback, $nextProcess) {

The opening parenthesis of a multi-line function call should be the last content on the line.

                            if ($callback) {
                                $callback($type, $buffer, $nextProcess);
                            }
                        });

For multi-line function calls, the closing parenthesis should be on a new line.

                        $currentProcesses[] = $nextProcess;
                    }
                }
            }
            // continue loop while there are processes being executed or waiting for execution
        } while (count($processesQueue) > 0 || count($currentProcesses) > 0);
    }

    /**

Missing short description in doc comment

     * @param Process[] $processes

Missing parameter comment

     */

Missing @return tag in function comment

    protected function validateProcesses(array $processes)
    {
        if (empty($processes)) {
            throw new \InvalidArgumentException('Can not run in parallel 0 commands');
        }
        foreach ($processes as $process) {
            if (!($process instanceof Process)) {
                throw new \InvalidArgumentException('Process in array need to be instance of Symfony Process');
            }
        }
    }
}