deployphp / deployer

src/ProcessRunner/Printer.php

<?php

declare(strict_types=1);

/* (c) Anton Medvedev <anton@medv.io>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Deployer\ProcessRunner;

use Deployer\Host\Host;
use Symfony\Component\Console\Output\OutputInterface;

class Printer
{
    private OutputInterface $output;

    public function __construct(OutputInterface $output)
    {
        $this->output = $output;
    }

    public function command(Host $host, string $type, string $command): void
    {
        // -v for run command
        if ($this->output->isVerbose()) {
            $this->output->writeln("[$host] <fg=green;options=bold>$type</> $command");
        }
    }

    /**
     * Returns a callable for use with the symfony Process->run($callable) method.
     *
     * @return callable A function expecting a int $type (e.g. Process::OUT or Process::ERR) and string $buffer parameters.
     */
    public function callback(Host $host, bool $forceOutput): callable
    {
        return function ($type, $buffer) use ($forceOutput, $host) {
            if ($this->output->isVerbose() || $forceOutput) {
                $this->printBuffer($type, $host, $buffer);
            }
        };
    }

    /**
     * @param string $type Process::OUT or Process::ERR
     */
    public function printBuffer(string $type, Host $host, string $buffer): void
    {
        foreach (explode("\n", rtrim($buffer)) as $line) {
            $this->writeln($type, $host, $line);
        }
    }

    public function writeln(string $type, Host $host, string $line): void

The parameter $type is not used and could be removed.

    {
        // Omit empty lines
        if (empty($line)) {
            return;
        }

        $this->output->writeln("[$host] $line");
    }
}