src/Console/Style/SF4/SerendipityHQStyleSF4.php
<?php
/*
* This file is part of the Serendipity HQ Console Styles Component.
*
* Copyright (c) Adamo Aerendir Crespi <aerendir@serendipityhq.com>.
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace SerendipityHQ\Bundle\ConsoleStyles\Console\Style\SF4;
use Symfony\Component\Console\Application;
use Symfony\Component\Console\Exception\RuntimeException;
use Symfony\Component\Console\Formatter\OutputFormatter;
use Symfony\Component\Console\Helper\Helper;
use Symfony\Component\Console\Helper\ProgressBar;
use Symfony\Component\Console\Helper\SymfonyQuestionHelper;
use Symfony\Component\Console\Helper\Table;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\BufferedOutput;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Question\ChoiceQuestion;
use Symfony\Component\Console\Question\ConfirmationQuestion;
use Symfony\Component\Console\Question\Question;
use Symfony\Component\Console\Style\OutputStyle;
/**
* {@inheritdoc}
*
* Derived from the SymfonyStyle bundled with Symfony.
*
* @author Kevin Bond <kevinbond@gmail.com>
* @author Adamo Aerendir Crespi <hello@aerendir.me>
*
* @deprecated SerendipityHQStyle is abandoned and will not be mantained anymore. Use Symfony\Component\Console\Style\SymfonyStyle instead.
*/
class SerendipityHQStyleSF4 extends OutputStyle
{
/**
* @var int
*/
const MAX_LINE_LENGTH = 120;
/**
* @var string
*/
private const CAUTION = 'CAUTION';
/** @var InputInterface $input */
private $input;
/** @var SymfonyQuestionHelper $questionHelper */
private $questionHelper;
/** @var ProgressBar $progressBar */
private $progressBar;
/** @var int $lineLength */
private $lineLength;
/** @var BufferedOutput $bufferedOutput */
private $bufferedOutput;
/**
* @param InputInterface $input
* @param OutputInterface $output
*/
public function __construct(InputInterface $input, OutputInterface $output)
{
trigger_error('SerendipityHQStyle is abandoned and will not be maintained anymore. Use Symfony\Component\Console\Style\SymfonyStyle instead.', E_USER_DEPRECATED);
$this->input = $input;
$this->bufferedOutput = new BufferedOutput($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.
$this->lineLength = \min($this->getTerminalWidth() - (int) (DIRECTORY_SEPARATOR === '\\'), self::MAX_LINE_LENGTH);
if (\class_exists(\Symfony\Component\Console\Terminal::class)) {
$width = (new \Symfony\Component\Console\Terminal())->getWidth() ?: self::MAX_LINE_LENGTH;
$this->lineLength = \min($width - (int) (DIRECTORY_SEPARATOR === '\\'), self::MAX_LINE_LENGTH);
}
// This is required as the parent::$output is private :(
parent::__construct($output);
}
/**
* Formats a message as a block of text.
*
* @param array|string $messages The message to write in the block
* @param string|null $type The block type (added in [] on first line)
* @param string|null $style The style to apply to the whole block
* @param string $prefix The prefix for the block
* @param bool $padding Whether to add vertical padding
*
* @deprecated @deprecated Use Symfony\Component\Console\Style\SymfonyStyle corresponding method instead.
*/
public function block($messages, $type = null, $style = null, $prefix = ' ', $padding = false)
{
trigger_error('Use Symfony\Component\Console\Style\SymfonyStyle corresponding method instead.', E_USER_DEPRECATED);
$messages = \is_array($messages) ? \array_values($messages) : [$messages];
$this->autoPrependBlock();
$this->writeln($this->createBlock($messages, $type, $style, $prefix, $padding, true));
$this->newLine();
}
/**
* {@inheritdoc}
*
* @deprecated Use Symfony\Component\Console\Style\SymfonyStyle::title() instead.
*/
public function title($message): void
{
trigger_error('Use Symfony\Component\Console\Style\SymfonyStyle corresponding method instead.', E_USER_DEPRECATED);
$this->autoPrependBlock();
$this->writeln([
\Safe\sprintf('<fg=green>%s</>', $message),
\Safe\sprintf('<fg=green>%s</>', \str_repeat('=', Helper::strlenWithoutDecoration($this->getFormatter(), $message))),
]);
$this->newLine();
}
/**
* {@inheritdoc}
*
* @deprecated Use Symfony\Component\Console\Style\SymfonyStyle::section() instead.
*/
public function section($message): void
{
trigger_error('Use Symfony\Component\Console\Style\SymfonyStyle corresponding method instead.', E_USER_DEPRECATED);
$this->autoPrependBlock();
$this->writeln([
\Safe\sprintf('<fg=green>%s</>', $message),
\Safe\sprintf('<fg=green>%s</>', \str_repeat('-', Helper::strlenWithoutDecoration($this->getFormatter(), $message))),
]);
$this->newLine();
}
/**
* {@inheritdoc}
*
* @deprecated Use Symfony\Component\Console\Style\SymfonyStyle::listing() instead.
*/
public function listing(array $elements): void
{
trigger_error('Use Symfony\Component\Console\Style\SymfonyStyle corresponding method instead.', E_USER_DEPRECATED);
$this->autoPrependText();
$elements = \array_map(function ($element): string {
return \Safe\sprintf(' * %s', $element);
}, $elements);
$this->writeln($elements);
$this->newLine();
}
/**
* {@inheritdoc}
*
* @deprecated Use Symfony\Component\Console\Style\SymfonyStyle::text() instead.
*/
public function text($message): void
{
trigger_error('Use Symfony\Component\Console\Style\SymfonyStyle corresponding method instead.', E_USER_DEPRECATED);
$this->autoPrependText();
$messages = \is_array($message) ? \array_values($message) : [$message];
foreach ($messages as $message) {
$this->writeln(\Safe\sprintf(' %s', $message));
}
}
/**
* {@inheritdoc}
*
* @deprecated Use Symfony\Component\Console\Style\SymfonyStyle::caution() instead.
*/
public function caution($message): void
{
trigger_error('Use Symfony\Component\Console\Style\SymfonyStyle corresponding method instead.', E_USER_DEPRECATED);
$this->block($message, self::CAUTION, 'caution', ' ! ', true);
}
/**
* Formats a command comment as single line.
*
* @param string $message
*/
public function cautionLine(string $message): void
{
trigger_error('Use an appropriate LoggerInterface level instead.', E_USER_DEPRECATED);
$this->writeln($this->createLine($message, self::CAUTION, 'caution', ' ! '));
}
/**
* Formats a command comment as single line without the background.
*
* @param string $message
*/
public function cautionLineNoBg(string $message): void
{
trigger_error('Use an appropriate LoggerInterface level instead.', E_USER_DEPRECATED);
$this->writeln($this->createLine($message, self::CAUTION, 'caution-nobg', ' ! '));
}
/**
* Formats a command comment as block.
*
* @param array|string $message
*
* @deprecated Use Symfony\Component\Console\Style\SymfonyStyle::comment() instead.
*/
public function comment($message): void
{
trigger_error('Use Symfony\Component\Console\Style\SymfonyStyle corresponding method instead.', E_USER_DEPRECATED);
$messages = \is_array($message) ? \array_values($message) : [$message];
$this->block($messages, 'COMMENT', 'comment', ' // ', true);
}
/**
* Formats a command comment as block.
*
* @param array|string $message
*/
public function commentNoBg($message): void
{
trigger_error('Use an appropriate LoggerInterface level instead.', E_USER_DEPRECATED);
$messages = \is_array($message) ? \array_values($message) : [$message];
$this->block($messages, 'COMMENT', 'comment-nobg', ' // ', true);
}
/**
* Formats a command comment as single line.
*
* @param string $message
*/
public function commentLine(string $message): void
{
trigger_error('Use an appropriate LoggerInterface level instead.', E_USER_DEPRECATED);
$this->writeln($this->createLine($message, null, 'comment', ' // '));
}
/**
* Formats a command comment as single line without the background.
*
* @param string $message
*/
public function commentLineNoBg(string $message): void
{
trigger_error('Use an appropriate LoggerInterface level instead.', E_USER_DEPRECATED);
$this->writeln($this->createLine($message, null, 'comment-nobg', ' // '));
}
/**
* {@inheritdoc}
*
* @deprecated Use Symfony\Component\Console\Style\SymfonyStyle::error() instead.
*/
public function error($message): void
{
trigger_error('Use Symfony\Component\Console\Style\SymfonyStyle corresponding method instead.', E_USER_DEPRECATED);
$this->block($message, "\xE2\x9C\x96", 'error', ' ', true);
}
/**
* Formats a command error as single line.
*
* @param string $message
*/
public function errorLine(string $message): void
{
trigger_error('Use an appropriate LoggerInterface level instead.', E_USER_DEPRECATED);
$this->writeln($this->createLine($message, "\xE2\x9C\x96", 'error'));
}
/**
* Formats a command error as single line without the background.
*
* @param string $message
*/
public function errorLineNoBg(string $message): void
{
trigger_error('Use an appropriate LoggerInterface level instead.', E_USER_DEPRECATED);
$this->writeln($this->createLine($message, "\xE2\x9C\x96", 'error-nobg'));
}
/**
* {@inheritdoc}
*
* @deprecated No replacement suggested.
*/
public function info($message): void
{
trigger_error('Use Symfony\Component\Console\Style\SymfonyStyle corresponding method instead.', E_USER_DEPRECATED);
$this->block($message, 'INFO', 'info', ' ', true);
}
/**
* Formats a command error as single line.
*
* @param string $message
*/
public function infoLine(string $message): void
{
trigger_error('Use an appropriate LoggerInterface level instead.', E_USER_DEPRECATED);
$this->writeln($this->createLine($message, '>', 'info'));
}
/**
* Formats a command error as single line without the background.
*
* @param string $message
*/
public function infoLineNoBg(string $message): void
{
trigger_error('Use an appropriate LoggerInterface level instead.', E_USER_DEPRECATED);
$this->writeln($this->createLine($message, '>', 'info-nobg'));
}
/**
* {@inheritdoc}
*
* @deprecated Use Symfony\Component\Console\Style\SymfonyStyle::note() instead.
*/
public function note($message): void
{
trigger_error('Use Symfony\Component\Console\Style\SymfonyStyle corresponding method instead.', E_USER_DEPRECATED);
$this->block($message, 'NOTE', 'note', ' ! ', true);
}
/**
* Formats a command note as single line.
*
* @param string $message
*/
public function noteLine(string $message): void
{
trigger_error('Use an appropriate LoggerInterface level instead.', E_USER_DEPRECATED);
$this->writeln($this->createLine($message, '!', 'note'));
}
/**
* Formats a command note as single line without the background.
*
* @param string $message
*/
public function noteLineNoBg(string $message): void
{
trigger_error('Use an appropriate LoggerInterface level instead.', E_USER_DEPRECATED);
$this->writeln($this->createLine($message, '!', 'note-nobg'));
}
/**
* {@inheritdoc}
*
* @deprecated Use Symfony\Component\Console\Style\SymfonyStyle::success() instead.
*/
public function success($message): void
{
trigger_error('Use Symfony\Component\Console\Style\SymfonyStyle corresponding method instead.', E_USER_DEPRECATED);
$this->block($message, "\xE2\x9C\x94", 'success', ' ', true);
}
/**
* Formats a command success as single line.
*
* @param string $message
*/
public function successLine(string $message): void
{
trigger_error('Use an appropriate LoggerInterface level instead.', E_USER_DEPRECATED);
$this->writeln($this->createLine($message, "\xE2\x9C\x94", 'success'));
}
/**
* Formats a command success as single line without the background.
*
* @param string $message
*/
public function successLineNoBg(string $message): void
{
trigger_error('Use an appropriate LoggerInterface level instead.', E_USER_DEPRECATED);
$this->writeln($this->createLine($message, "\xE2\x9C\x94", 'success-nobg'));
}
/**
* {@inheritdoc}
*
* @deprecated Use Symfony\Component\Console\Style\SymfonyStyle::warning() instead.
*/
public function warning($message): void
{
trigger_error('Use Symfony\Component\Console\Style\SymfonyStyle corresponding method instead.', E_USER_DEPRECATED);
$this->block($message, 'WARNING', 'warning', ' ! ', true);
}
/**
* Formats a command error as single line.
*
* @param string $message
*/
public function warningLine(string $message): void
{
trigger_error('Use an appropriate LoggerInterface level instead.', E_USER_DEPRECATED);
$this->writeln($this->createLine($message, '!', 'warning'));
}
/**
* Formats a command error as single line without the background.
*
* @param string $message
*/
public function warningLineNoBg(string $message): void
{
trigger_error('Use an appropriate LoggerInterface level instead.', E_USER_DEPRECATED);
$this->writeln($this->createLine($message, '!', 'warning-nobg'));
}
/**
* {@inheritdoc}
*
* @deprecated Use Symfony\Component\Console\Style\SymfonyStyle::table() instead.
*/
public function table(array $headers, array $rows)
{
trigger_error('Use Symfony\Component\Console\Style\SymfonyStyle corresponding method instead.', E_USER_DEPRECATED);
$style = clone Table::getStyleDefinition('symfony-style-guide');
$style->setCellHeaderFormat('<fg=green>%s</>');
$table = new Table($this);
$table->setHeaders($headers);
$table->setRows($rows);
$table->setStyle($style);
$table->render();
$this->newLine();
}
/**
* {@inheritdoc}
*
* @deprecated Use Symfony\Component\Console\Style\SymfonyStyle::ask() instead.
*/
public function ask($question, $default = null, $validator = null): string
{
trigger_error('Use Symfony\Component\Console\Style\SymfonyStyle corresponding method instead.', E_USER_DEPRECATED);
$question = new Question($question, $default);
$question->setValidator($validator);
return $this->askQuestion($question);
}
/**
* {@inheritdoc}
*
* @deprecated Use Symfony\Component\Console\Style\SymfonyStyle::askHidden() instead.
*/
public function askHidden($question, $validator = null): string
{
trigger_error('Use Symfony\Component\Console\Style\SymfonyStyle corresponding method instead.', E_USER_DEPRECATED);
$question = new Question($question);
$question->setHidden(true);
$question->setValidator($validator);
return $this->askQuestion($question);
}
/**
* {@inheritdoc}
*
* @deprecated Use Symfony\Component\Console\Style\SymfonyStyle::confirm() instead.
*/
public function confirm($question, $default = true): string
{
trigger_error('Use Symfony\Component\Console\Style\SymfonyStyle corresponding method instead.', E_USER_DEPRECATED);
return $this->askQuestion(new ConfirmationQuestion($question, $default));
}
/**
* {@inheritdoc}
*
* @deprecated Use Symfony\Component\Console\Style\SymfonyStyle::choice() instead.
*/
public function choice($question, array $choices, $default = null): string
{
trigger_error('Use Symfony\Component\Console\Style\SymfonyStyle corresponding method instead.', E_USER_DEPRECATED);
if (null !== $default) {
$values = \Safe\array_flip($choices);
$default = $values[$default];
}
return $this->askQuestion(new ChoiceQuestion($question, $choices, $default));
}
/**
* {@inheritdoc}
*
* @deprecated Use Symfony\Component\Console\Style\SymfonyStyle::progressStart() instead.
*/
public function progressStart($max = 0): void
{
trigger_error('Use Symfony\Component\Console\Style\SymfonyStyle corresponding method instead.', E_USER_DEPRECATED);
$this->progressBar = $this->createProgressBar($max);
$this->progressBar->start();
}
/**
* {@inheritdoc}
*
* @deprecated Use Symfony\Component\Console\Style\SymfonyStyle::progressAdvance() instead.
*/
public function progressAdvance($step = 1): void
{
trigger_error('Use Symfony\Component\Console\Style\SymfonyStyle corresponding method instead.', E_USER_DEPRECATED);
$this->getProgressBar()->advance($step);
}
/**
* {@inheritdoc}
*
* @deprecated Use Symfony\Component\Console\Style\SymfonyStyle::progressFinish() instead.
*/
public function progressFinish(): void
{
trigger_error('Use Symfony\Component\Console\Style\SymfonyStyle corresponding method instead.', E_USER_DEPRECATED);
$this->getProgressBar()->finish();
$this->newLine(2);
$this->progressBar = null;
}
/**
* {@inheritdoc}
*
* @deprecated Use Symfony\Component\Console\Style\SymfonyStyle::createProgressBar() instead.
*/
public function createProgressBar($max = 0): \Symfony\Component\Console\Helper\ProgressBar
{
trigger_error('Use Symfony\Component\Console\Style\SymfonyStyle corresponding method instead.', E_USER_DEPRECATED);
$progressBar = parent::createProgressBar($max);
if ('\\' !== DIRECTORY_SEPARATOR) {
$progressBar->setEmptyBarCharacter('░'); // light shade character \u2591
$progressBar->setProgressCharacter('');
$progressBar->setBarCharacter('▓'); // dark shade character \u2593
}
return $progressBar;
}
/**
* @param Question $question
*
* @deprecated Use Symfony\Component\Console\Style\SymfonyStyle::askQuestion() instead.
*/
public function askQuestion(Question $question): string
{
trigger_error('Use Symfony\Component\Console\Style\SymfonyStyle corresponding method instead.', E_USER_DEPRECATED);
if ($this->input->isInteractive()) {
$this->autoPrependBlock();
}
if ( ! $this->questionHelper) {
$this->questionHelper = new SymfonyQuestionHelper();
}
$answer = $this->questionHelper->ask($this->input, $this, $question);
if ($this->input->isInteractive()) {
$this->newLine();
$this->bufferedOutput->write("\n");
}
return $answer;
}
/**
* {@inheritdoc}
*
* @deprecated Use Symfony\Component\Console\Style\SymfonyStyle::writeln() instead.
*/
public function writeln($messages, $type = self::OUTPUT_NORMAL): void
{
trigger_error('Use Symfony\Component\Console\Style\SymfonyStyle corresponding method instead.', E_USER_DEPRECATED);
parent::writeln($messages, $type);
$this->bufferedOutput->writeln($this->reduceBuffer($messages), $type);
}
/**
* {@inheritdoc}
*
* @deprecated Use Symfony\Component\Console\Style\SymfonyStyle::write() instead.
*/
public function write($messages, $newline = false, $type = self::OUTPUT_NORMAL): void
{
trigger_error('Use Symfony\Component\Console\Style\SymfonyStyle corresponding method instead.', E_USER_DEPRECATED);
parent::write($messages, $newline, $type);
$this->bufferedOutput->write($this->reduceBuffer($messages), $newline, $type);
}
/**
* {@inheritdoc}
*
* @deprecated Use Symfony\Component\Console\Style\SymfonyStyle::newLine() instead.
*/
public function newLine($count = 1): void
{
trigger_error('Use Symfony\Component\Console\Style\SymfonyStyle corresponding method instead.', E_USER_DEPRECATED);
parent::newLine($count);
$this->bufferedOutput->write(\str_repeat("\n", $count));
}
/**
* Returns a new instance which makes use of stderr if available.
*
* @deprecated Use Symfony\Component\Console\Style\SymfonyStyle::getErrorStyle() instead.
*/
public function getErrorStyle(): \SerendipityHQ\Bundle\ConsoleStyles\Console\Style\SF4\SerendipityHQStyleSF4
{
trigger_error('Use Symfony\Component\Console\Style\SymfonyStyle corresponding method instead.', E_USER_DEPRECATED);
if (\method_exists($this, 'getErrorOutput')) {
return new self($this->input, $this->getErrorOutput());
}
return $this;
}
/**
* @return InputInterface
*
* @deprecated No replacement suggested.
*/
public function getInput(): InputInterface
{
trigger_error('No replacement suggested.', E_USER_DEPRECATED);
return $this->input;
}
/**
* @return int
*
* @deprecated No replacement suggested
*/
public function getLineLength(): int
{
trigger_error('No replacement suggested.', E_USER_DEPRECATED);
return $this->lineLength;
}
protected function getProgressBar(): \Symfony\Component\Console\Helper\ProgressBar
{
if ( ! $this->progressBar) {
throw new RuntimeException('The ProgressBar is not started.');
}
return $this->progressBar;
}
/**
* @return int
*/
protected function getTerminalWidth()
{
$application = new Application();
// Compatibility with Symfony ~3
if (\method_exists($application, 'getTerminalWidth')) {
$dimensions = $application->getTerminalDimensions();
return $dimensions[0] ?: self::MAX_LINE_LENGTH;
}
return self::MAX_LINE_LENGTH;
}
protected function autoPrependBlock(): void
{
$chars = \Safe\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.
}
// Prepend new line for each non LF chars (This means no blank line was output before)
$this->newLine(2 - \substr_count($chars, "\n"));
}
protected function autoPrependText(): void
{
$fetched = $this->bufferedOutput->fetch();
//Prepend new line if last char isn't EOL:
if ("\n" !== \Safe\substr($fetched, -1)) {
$this->newLine();
}
}
/**
* @param $messages
*/
protected function reduceBuffer($messages): array
{
// We need to know if the two last chars are PHP_EOL
// Preserve the last 4 chars inserted (PHP_EOL on windows is two chars) in the history buffer
return \array_map(function ($value): string {
return \Safe\substr($value, -4);
}, \array_merge([$this->bufferedOutput->fetch()], (array) $messages));
}
/**
* @param $messages
* @param null $type
* @param null $style
* @param string $prefix
* @param bool $padding
* @param bool $escape
*/
protected function createBlock($messages, $type = null, $style = null, $prefix = ' ', $padding = false, $escape = false)
{
$indentLength = 0;
$prefixLength = Helper::strlenWithoutDecoration($this->getFormatter(), $prefix);
$lines = [];
$lineIndentation = '';
if (null !== $type) {
$type = \Safe\sprintf('[%s] ', $type);
$indentLength = \strlen($type);
$lineIndentation = \str_repeat(' ', $indentLength);
}
// wrap and add newlines for each element
foreach ($messages as $key => $message) {
if ($escape) {
$message = OutputFormatter::escape($message);
}
$lines = \array_merge($lines, \explode(PHP_EOL, \wordwrap($message, $this->lineLength - $prefixLength - $indentLength, PHP_EOL, true)));
if ((\is_countable($messages) ? \count($messages) : 0) > 1 && $key < (\is_countable($messages) ? \count($messages) : 0) - 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(' ', $this->lineLength - Helper::strlenWithoutDecoration($this->getFormatter(), $line));
if ($style) {
$line = \Safe\sprintf('<%s>%s</>', $style, $line);
}
}
return $lines;
}
/**
* @param string $message
* @param null $type
* @param null $style
* @param string $prefix
* @param bool $escape
*/
protected function createLine(string $message, $type = null, $style = null, string $prefix = '', bool $escape = false): string
{
if ($escape) {
$message = OutputFormatter::escape($message);
}
if (null !== $type) {
$message = \Safe\sprintf('[%s] %s', $type, $message);
}
$message = $prefix . $message;
$length = $this->lineLength - Helper::strlenWithoutDecoration($this->getFormatter(), $message);
if (0 < $length) {
$message .= \str_repeat(' ', $length);
}
if ($style) {
$message = \Safe\sprintf('<%s>%s</>', $style, $message);
}
return $message;
}
}