<?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Symfony\Component\Console\Helper; /** * 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> */ 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'; } }
Name | Type | Size | Permission | Actions |
---|---|---|---|---|
DebugFormatterHelper.php | File | 3.34 KB | 0644 |
|
DescriptorHelper.php | File | 2.51 KB | 0644 |
|
Dumper.php | File | 1.91 KB | 0644 |
|
FormatterHelper.php | File | 2.26 KB | 0644 |
|
Helper.php | File | 4.46 KB | 0644 |
|
HelperInterface.php | File | 851 B | 0644 |
|
HelperSet.php | File | 1.86 KB | 0644 |
|
InputAwareHelper.php | File | 740 B | 0644 |
|
OutputWrapper.php | File | 3.01 KB | 0644 |
|
ProcessHelper.php | File | 4.77 KB | 0644 |
|
ProgressBar.php | File | 19.14 KB | 0644 |
|
ProgressIndicator.php | File | 7.08 KB | 0644 |
|
QuestionHelper.php | File | 19.71 KB | 0644 |
|
SymfonyQuestionHelper.php | File | 3.23 KB | 0644 |
|
Table.php | File | 31.46 KB | 0644 |
|
TableCell.php | File | 1.79 KB | 0644 |
|
TableCellStyle.php | File | 2.29 KB | 0644 |
|
TableRows.php | File | 620 B | 0644 |
|
TableSeparator.php | File | 556 B | 0644 |
|
TableStyle.php | File | 12.81 KB | 0644 |
|