class DebugFormatterHelper

Helps outputting debug information when running an external program from a command.

An external program can be a Process, an HTTP request, or anything else.

@author Fabien Potencier <fabien@symfony.com>

Hierarchy

class \Symfony\Component\Console\Helper\Helper implements \Symfony\Component\Console\Helper\HelperInterface
- class \Symfony\Component\Console\Helper\DebugFormatterHelper extends \Symfony\Component\Console\Helper\Helper

Expanded class hierarchy of DebugFormatterHelper

1 file declares its use of DebugFormatterHelper

Application.php in vendor/symfony/console/Application.php

File

vendor/symfony/console/Helper/DebugFormatterHelper.php, line 21

Namespace

Symfony\Component\Console\Helper

View source

class DebugFormatterHelper extends Helper {
    private const COLORS = [
        'black',
        'red',
        'green',
        'yellow',
        'blue',
        'magenta',
        'cyan',
        'white',
        'default',
    ];
    private array $started = [];
    private int $count = -1;
    
    /**
     * Starts a debug formatting session.
     */
    public function start(string $id, string $message, string $prefix = 'RUN') : string {
        $this->started[$id] = [
            'border' => ++$this->count % \count(self::COLORS),
        ];
        return \sprintf("%s<bg=blue;fg=white> %s </> <fg=blue>%s</>\n", $this->getBorder($id), $prefix, $message);
    }
    
    /**
     * Adds progress to a formatting session.
     */
    public function progress(string $id, string $buffer, bool $error = false, string $prefix = 'OUT', string $errorPrefix = 'ERR') : string {
        $message = '';
        if ($error) {
            if (isset($this->started[$id]['out'])) {
                $message .= "\n";
                unset($this->started[$id]['out']);
            }
            if (!isset($this->started[$id]['err'])) {
                $message .= \sprintf('%s<bg=red;fg=white> %s </> ', $this->getBorder($id), $errorPrefix);
                $this->started[$id]['err'] = true;
            }
            $message .= str_replace("\n", \sprintf("\n%s<bg=red;fg=white> %s </> ", $this->getBorder($id), $errorPrefix), $buffer);
        }
        else {
            if (isset($this->started[$id]['err'])) {
                $message .= "\n";
                unset($this->started[$id]['err']);
            }
            if (!isset($this->started[$id]['out'])) {
                $message .= \sprintf('%s<bg=green;fg=white> %s </> ', $this->getBorder($id), $prefix);
                $this->started[$id]['out'] = true;
            }
            $message .= str_replace("\n", \sprintf("\n%s<bg=green;fg=white> %s </> ", $this->getBorder($id), $prefix), $buffer);
        }
        return $message;
    }
    
    /**
     * Stops a formatting session.
     */
    public function stop(string $id, string $message, bool $successful, string $prefix = 'RES') : string {
        $trailingEOL = isset($this->started[$id]['out']) || isset($this->started[$id]['err']) ? "\n" : '';
        if ($successful) {
            return \sprintf("%s%s<bg=green;fg=white> %s </> <fg=green>%s</>\n", $trailingEOL, $this->getBorder($id), $prefix, $message);
        }
        $message = \sprintf("%s%s<bg=red;fg=white> %s </> <fg=red>%s</>\n", $trailingEOL, $this->getBorder($id), $prefix, $message);
        unset($this->started[$id]['out'], $this->started[$id]['err']);
        return $message;
    }
    private function getBorder(string $id) : string {
        return \sprintf('<bg=%s> </>', self::COLORS[$this->started[$id]['border']]);
    }
    public function getName() : string {
        return 'debug_formatter';
    }

}

Members

Title Sort descending	Modifiers	Object type	Summary	Overriden Title
DebugFormatterHelper::$count	private	property
DebugFormatterHelper::$started	private	property
DebugFormatterHelper::COLORS	private	constant
DebugFormatterHelper::getBorder	private	function
DebugFormatterHelper::getName	public	function	Returns the canonical name of this helper.	Overrides HelperInterface::getName
DebugFormatterHelper::progress	public	function	Adds progress to a formatting session.
DebugFormatterHelper::start	public	function	Starts a debug formatting session.
DebugFormatterHelper::stop	public	function	Stops a formatting session.
Helper::$helperSet	protected	property
Helper::formatMemory	public static	function
Helper::formatTime	public static	function
Helper::getHelperSet	public	function	Gets the helper set associated with this helper.	Overrides HelperInterface::getHelperSet
Helper::length	public static	function	Returns the length of a string, using mb_strlen if it is available. The length is related to how many bytes the string will use.
Helper::removeDecoration	public static	function
Helper::setHelperSet	public	function	Sets the helper set associated with this helper.	Overrides HelperInterface::setHelperSet
Helper::substr	public static	function	Returns the subset of a string, using mb_substr if it is available.
Helper::width	public static	function	Returns the width of a string, using mb_strwidth if it is available. The width is how many characters positions the string will use.