class SymfonyStyle
Output decorator helpers for the Symfony Style Guide.
@author Kevin Bond <kevinbond@gmail.com>
Hierarchy
- class \Symfony\Component\Console\Style\OutputStyle implements \Symfony\Component\Console\Output\OutputInterface, \Symfony\Component\Console\Style\StyleInterface
- class \Symfony\Component\Console\Style\SymfonyStyle extends \Symfony\Component\Console\Style\OutputStyle
Expanded class hierarchy of SymfonyStyle
14 files declare their use of SymfonyStyle
- Application.php in vendor/
symfony/ console/ Application.php - CacheWarmerAggregate.php in vendor/
symfony/ http-kernel/ CacheWarmer/ CacheWarmerAggregate.php - CliDescriptor.php in vendor/
symfony/ var-dumper/ Command/ Descriptor/ CliDescriptor.php - DebugCommand.php in vendor/
symfony/ serializer/ Command/ DebugCommand.php - DebugCommand.php in vendor/
symfony/ validator/ Command/ DebugCommand.php
File
-
vendor/
symfony/ console/ Style/ SymfonyStyle.php, line 39
Namespace
Symfony\Component\Console\StyleView source
class SymfonyStyle extends OutputStyle {
public const MAX_LINE_LENGTH = 120;
private SymfonyQuestionHelper $questionHelper;
private ProgressBar $progressBar;
private int $lineLength;
private TrimmedBufferOutput $bufferedOutput;
public function __construct(InputInterface $input, OutputInterface $output) {
$this->bufferedOutput = new TrimmedBufferOutput(\DIRECTORY_SEPARATOR === '\\' ? 4 : 2, $output->getVerbosity(), false, clone $output->getFormatter());
// Windows cmd wraps lines as soon as the terminal width is reached, whether there are following chars or not.
$width = (new Terminal())->getWidth() ?: self::MAX_LINE_LENGTH;
$this->lineLength = min($width - (int) (\DIRECTORY_SEPARATOR === '\\'), self::MAX_LINE_LENGTH);
parent::__construct($output);
}
/**
* Formats a message as a block of text.
*/
public function block(string|array $messages, ?string $type = null, ?string $style = null, string $prefix = ' ', bool $padding = false, bool $escape = true) : void {
$messages = \is_array($messages) ? array_values($messages) : [
$messages,
];
$this->autoPrependBlock();
$this->writeln($this->createBlock($messages, $type, $style, $prefix, $padding, $escape));
$this->newLine();
}
public function title(string $message) : void {
$this->autoPrependBlock();
$this->writeln([
\sprintf('<comment>%s</>', OutputFormatter::escapeTrailingBackslash($message)),
\sprintf('<comment>%s</>', str_repeat('=', Helper::width(Helper::removeDecoration($this->getFormatter(), $message)))),
]);
$this->newLine();
}
public function section(string $message) : void {
$this->autoPrependBlock();
$this->writeln([
\sprintf('<comment>%s</>', OutputFormatter::escapeTrailingBackslash($message)),
\sprintf('<comment>%s</>', str_repeat('-', Helper::width(Helper::removeDecoration($this->getFormatter(), $message)))),
]);
$this->newLine();
}
public function listing(array $elements) : void {
$this->autoPrependText();
$elements = array_map(fn($element) => \sprintf(' * %s', $element), $elements);
$this->writeln($elements);
$this->newLine();
}
public function text(string|array $message) : void {
$this->autoPrependText();
$messages = \is_array($message) ? array_values($message) : [
$message,
];
foreach ($messages as $message) {
$this->writeln(\sprintf(' %s', $message));
}
}
/**
* Formats a command comment.
*/
public function comment(string|array $message) : void {
$this->block($message, null, null, '<fg=default;bg=default> // </>', false, false);
}
public function success(string|array $message) : void {
$this->block($message, 'OK', 'fg=black;bg=green', ' ', true);
}
public function error(string|array $message) : void {
$this->block($message, 'ERROR', 'fg=white;bg=red', ' ', true);
}
public function warning(string|array $message) : void {
$this->block($message, 'WARNING', 'fg=black;bg=yellow', ' ', true);
}
public function note(string|array $message) : void {
$this->block($message, 'NOTE', 'fg=yellow', ' ! ');
}
/**
* Formats an info message.
*/
public function info(string|array $message) : void {
$this->block($message, 'INFO', 'fg=green', ' ', true);
}
public function caution(string|array $message) : void {
$this->block($message, 'CAUTION', 'fg=white;bg=red', ' ! ', true);
}
public function table(array $headers, array $rows) : void {
$this->createTable()
->setHeaders($headers)
->setRows($rows)
->render();
$this->newLine();
}
/**
* Formats a horizontal table.
*/
public function horizontalTable(array $headers, array $rows) : void {
$this->createTable()
->setHorizontal(true)
->setHeaders($headers)
->setRows($rows)
->render();
$this->newLine();
}
/**
* Formats a list of key/value horizontally.
*
* Each row can be one of:
* * 'A title'
* * ['key' => 'value']
* * new TableSeparator()
*/
public function definitionList(string|array|TableSeparator ...$list) : void {
$headers = [];
$row = [];
foreach ($list as $value) {
if ($value instanceof TableSeparator) {
$headers[] = $value;
$row[] = $value;
continue;
}
if (\is_string($value)) {
$headers[] = new TableCell($value, [
'colspan' => 2,
]);
$row[] = null;
continue;
}
if (!\is_array($value)) {
throw new InvalidArgumentException('Value should be an array, string, or an instance of TableSeparator.');
}
$headers[] = key($value);
$row[] = current($value);
}
$this->horizontalTable($headers, [
$row,
]);
}
public function ask(string $question, ?string $default = null, ?callable $validator = null) : mixed {
$question = new Question($question, $default);
$question->setValidator($validator);
return $this->askQuestion($question);
}
public function askHidden(string $question, ?callable $validator = null) : mixed {
$question = new Question($question);
$question->setHidden(true);
$question->setValidator($validator);
return $this->askQuestion($question);
}
public function confirm(string $question, bool $default = true) : bool {
return $this->askQuestion(new ConfirmationQuestion($question, $default));
}
public function choice(string $question, array $choices, mixed $default = null, bool $multiSelect = false) : mixed {
if (null !== $default) {
$values = array_flip($choices);
$default = $values[$default] ?? $default;
}
$questionChoice = new ChoiceQuestion($question, $choices, $default);
$questionChoice->setMultiselect($multiSelect);
return $this->askQuestion($questionChoice);
}
public function progressStart(int $max = 0) : void {
$this->progressBar = $this->createProgressBar($max);
$this->progressBar
->start();
}
public function progressAdvance(int $step = 1) : void {
$this->getProgressBar()
->advance($step);
}
public function progressFinish() : void {
$this->getProgressBar()
->finish();
$this->newLine(2);
unset($this->progressBar);
}
public function createProgressBar(int $max = 0) : ProgressBar {
$progressBar = parent::createProgressBar($max);
if ('\\' !== \DIRECTORY_SEPARATOR || 'Hyper' === getenv('TERM_PROGRAM')) {
$progressBar->setEmptyBarCharacter('░');
// light shade character \u2591
$progressBar->setProgressCharacter('');
$progressBar->setBarCharacter('▓');
// dark shade character \u2593
}
return $progressBar;
}
/**
* @see ProgressBar::iterate()
*
* @template TKey
* @template TValue
*
* @param iterable<TKey, TValue> $iterable
* @param int|null $max Number of steps to complete the bar (0 if indeterminate), if null it will be inferred from $iterable
*
* @return iterable<TKey, TValue>
*/
public function progressIterate(iterable $iterable, ?int $max = null) : iterable {
yield from $this->createProgressBar()
->iterate($iterable, $max);
$this->newLine(2);
}
public function askQuestion(Question $question) : mixed {
if ($this->input
->isInteractive()) {
$this->autoPrependBlock();
}
$this->questionHelper ??= new SymfonyQuestionHelper();
$answer = $this->questionHelper
->ask($this->input, $this, $question);
if ($this->input
->isInteractive()) {
if ($this->output instanceof ConsoleSectionOutput) {
// add the new line of the `return` to submit the input to ConsoleSectionOutput, because ConsoleSectionOutput is holding all it's lines.
// this is relevant when a `ConsoleSectionOutput::clear` is called.
$this->output
->addNewLineOfInputSubmit();
}
$this->newLine();
$this->bufferedOutput
->write("\n");
}
return $answer;
}
public function writeln(string|iterable $messages, int $type = self::OUTPUT_NORMAL) : void {
if (!is_iterable($messages)) {
$messages = [
$messages,
];
}
foreach ($messages as $message) {
parent::writeln($message, $type);
$this->writeBuffer($message, true, $type);
}
}
public function write(string|iterable $messages, bool $newline = false, int $type = self::OUTPUT_NORMAL) : void {
if (!is_iterable($messages)) {
$messages = [
$messages,
];
}
foreach ($messages as $message) {
parent::write($message, $newline, $type);
$this->writeBuffer($message, $newline, $type);
}
}
public function newLine(int $count = 1) : void {
parent::newLine($count);
$this->bufferedOutput
->write(str_repeat("\n", $count));
}
/**
* Returns a new instance which makes use of stderr if available.
*/
public function getErrorStyle() : self {
return new self($this->input, $this->getErrorOutput());
}
public function createTable() : Table {
$output = $this->output instanceof ConsoleOutputInterface ? $this->output
->section() : $this->output;
$style = clone Table::getStyleDefinition('symfony-style-guide');
$style->setCellHeaderFormat('<info>%s</info>');
return (new Table($output))->setStyle($style);
}
private function getProgressBar() : ProgressBar {
return $this->progressBar ?? throw new RuntimeException('The ProgressBar is not started.');
}
private function autoPrependBlock() : void {
$chars = substr(str_replace(\PHP_EOL, "\n", $this->bufferedOutput
->fetch()), -2);
if (!isset($chars[0])) {
$this->newLine();
// empty history, so we should start with a new line.
return;
}
// Prepend new line for each non LF chars (This means no blank line was output before)
$this->newLine(2 - substr_count($chars, "\n"));
}
private function autoPrependText() : void {
$fetched = $this->bufferedOutput
->fetch();
// Prepend new line if last char isn't EOL:
if ($fetched && !str_ends_with($fetched, "\n")) {
$this->newLine();
}
}
private function writeBuffer(string $message, bool $newLine, int $type) : void {
// We need to know if the last chars are PHP_EOL
$this->bufferedOutput
->write($message, $newLine, $type);
}
private function createBlock(iterable $messages, ?string $type = null, ?string $style = null, string $prefix = ' ', bool $padding = false, bool $escape = false) : array {
$indentLength = 0;
$prefixLength = Helper::width(Helper::removeDecoration($this->getFormatter(), $prefix));
$lines = [];
if (null !== $type) {
$type = \sprintf('[%s] ', $type);
$indentLength = Helper::width($type);
$lineIndentation = str_repeat(' ', $indentLength);
}
// wrap and add newlines for each element
$outputWrapper = new OutputWrapper();
foreach ($messages as $key => $message) {
if ($escape) {
$message = OutputFormatter::escape($message);
}
$lines = array_merge($lines, explode(\PHP_EOL, $outputWrapper->wrap($message, $this->lineLength - $prefixLength - $indentLength, \PHP_EOL)));
if (\count($messages) > 1 && $key < \count($messages) - 1) {
$lines[] = '';
}
}
$firstLineIndex = 0;
if ($padding && $this->isDecorated()) {
$firstLineIndex = 1;
array_unshift($lines, '');
$lines[] = '';
}
foreach ($lines as $i => &$line) {
if (null !== $type) {
$line = $firstLineIndex === $i ? $type . $line : $lineIndentation . $line;
}
$line = $prefix . $line;
$line .= str_repeat(' ', max($this->lineLength - Helper::width(Helper::removeDecoration($this->getFormatter(), $line)), 0));
if ($style) {
$line = \sprintf('<%s>%s</>', $style, $line);
}
}
return $lines;
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title |
---|---|---|---|---|
OutputInterface::OUTPUT_NORMAL | public | constant | ||
OutputInterface::OUTPUT_PLAIN | public | constant | ||
OutputInterface::OUTPUT_RAW | public | constant | ||
OutputInterface::VERBOSITY_DEBUG | public | constant | ||
OutputInterface::VERBOSITY_NORMAL | public | constant | ||
OutputInterface::VERBOSITY_QUIET | public | constant | ||
OutputInterface::VERBOSITY_SILENT | public | constant | ||
OutputInterface::VERBOSITY_VERBOSE | public | constant | ||
OutputInterface::VERBOSITY_VERY_VERBOSE | public | constant | ||
OutputStyle::getErrorOutput | protected | function | ||
OutputStyle::getFormatter | public | function | Returns current output formatter instance. | Overrides OutputInterface::getFormatter |
OutputStyle::getVerbosity | public | function | Gets the current verbosity of the output. | Overrides OutputInterface::getVerbosity |
OutputStyle::isDebug | public | function | Returns whether verbosity is debug (-vvv). | Overrides OutputInterface::isDebug |
OutputStyle::isDecorated | public | function | Gets the decorated flag. | Overrides OutputInterface::isDecorated |
OutputStyle::isQuiet | public | function | Returns whether verbosity is quiet (-q). | Overrides OutputInterface::isQuiet |
OutputStyle::isSilent | public | function | ||
OutputStyle::isVerbose | public | function | Returns whether verbosity is verbose (-v). | Overrides OutputInterface::isVerbose |
OutputStyle::isVeryVerbose | public | function | Returns whether verbosity is very verbose (-vv). | Overrides OutputInterface::isVeryVerbose |
OutputStyle::setDecorated | public | function | Sets the decorated flag. | Overrides OutputInterface::setDecorated |
OutputStyle::setFormatter | public | function | Overrides OutputInterface::setFormatter | |
OutputStyle::setVerbosity | public | function | Sets the verbosity of the output. | Overrides OutputInterface::setVerbosity |
SymfonyStyle::$bufferedOutput | private | property | ||
SymfonyStyle::$lineLength | private | property | ||
SymfonyStyle::$progressBar | private | property | ||
SymfonyStyle::$questionHelper | private | property | ||
SymfonyStyle::ask | public | function | Asks a question. | Overrides StyleInterface::ask |
SymfonyStyle::askHidden | public | function | Asks a question with the user input hidden. | Overrides StyleInterface::askHidden |
SymfonyStyle::askQuestion | public | function | ||
SymfonyStyle::autoPrependBlock | private | function | ||
SymfonyStyle::autoPrependText | private | function | ||
SymfonyStyle::block | public | function | Formats a message as a block of text. | |
SymfonyStyle::caution | public | function | Formats a caution admonition. | Overrides StyleInterface::caution |
SymfonyStyle::choice | public | function | Asks a choice question. | Overrides StyleInterface::choice |
SymfonyStyle::comment | public | function | Formats a command comment. | |
SymfonyStyle::confirm | public | function | Asks for confirmation. | Overrides StyleInterface::confirm |
SymfonyStyle::createBlock | private | function | ||
SymfonyStyle::createProgressBar | public | function | Overrides OutputStyle::createProgressBar | |
SymfonyStyle::createTable | public | function | ||
SymfonyStyle::definitionList | public | function | Formats a list of key/value horizontally. | |
SymfonyStyle::error | public | function | Formats an error result bar. | Overrides StyleInterface::error |
SymfonyStyle::getErrorStyle | public | function | Returns a new instance which makes use of stderr if available. | |
SymfonyStyle::getProgressBar | private | function | ||
SymfonyStyle::horizontalTable | public | function | Formats a horizontal table. | |
SymfonyStyle::info | public | function | Formats an info message. | |
SymfonyStyle::listing | public | function | Formats a list. | Overrides StyleInterface::listing |
SymfonyStyle::MAX_LINE_LENGTH | public | constant | ||
SymfonyStyle::newLine | public | function | Add newline(s). | Overrides OutputStyle::newLine |
SymfonyStyle::note | public | function | Formats a note admonition. | Overrides StyleInterface::note |
SymfonyStyle::progressAdvance | public | function | Advances the progress output X steps. | Overrides StyleInterface::progressAdvance |
SymfonyStyle::progressFinish | public | function | Finishes the progress output. | Overrides StyleInterface::progressFinish |
SymfonyStyle::progressIterate | public | function | @template TKey @template TValue |
|
SymfonyStyle::progressStart | public | function | Starts the progress output. | Overrides StyleInterface::progressStart |
SymfonyStyle::section | public | function | Formats a section title. | Overrides StyleInterface::section |
SymfonyStyle::success | public | function | Formats a success result bar. | Overrides StyleInterface::success |
SymfonyStyle::table | public | function | Formats a table. | Overrides StyleInterface::table |
SymfonyStyle::text | public | function | Formats informational text. | Overrides StyleInterface::text |
SymfonyStyle::title | public | function | Formats a command title. | Overrides StyleInterface::title |
SymfonyStyle::warning | public | function | Formats an warning result bar. | Overrides StyleInterface::warning |
SymfonyStyle::write | public | function | Writes a message to the output. | Overrides OutputStyle::write |
SymfonyStyle::writeBuffer | private | function | ||
SymfonyStyle::writeln | public | function | Writes a message to the output and adds a newline at the end. | Overrides OutputStyle::writeln |
SymfonyStyle::__construct | public | function | Overrides OutputStyle::__construct |