ConsoleOutput.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Extbase\Mvc\Cli;

/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */

use Symfony\Component\Console\Formatter\OutputFormatterStyle;
use Symfony\Component\Console\Helper\DialogHelper;
use Symfony\Component\Console\Helper\FormatterHelper;
use Symfony\Component\Console\Helper\HelperSet;
use Symfony\Component\Console\Helper\ProgressHelper;
use Symfony\Component\Console\Helper\TableHelper;
use Symfony\Component\Console\Output\ConsoleOutput as SymfonyConsoleOutput;

class ConsoleOutput
{
    protected $output;

    protected $dialogHelper;

    protected $progressHelper;

    protected $tableHelper;

    public function __construct()
    {
        $this->output = new SymfonyConsoleOutput();
        $this->output->getFormatter()->setStyle('b', new OutputFormatterStyle(null, null, ['bold']));
        $this->output->getFormatter()->setStyle('i', new OutputFormatterStyle('black', 'white'));
        $this->output->getFormatter()->setStyle('u', new OutputFormatterStyle(null, null, ['underscore']));
        $this->output->getFormatter()->setStyle('em', new OutputFormatterStyle(null, null, ['reverse']));
        $this->output->getFormatter()->setStyle('strike', new OutputFormatterStyle(null, null, ['conceal']));
    }

    public function getMaximumLineLength()
    {
        return 79;
    }

    public function output($text, array $arguments = [])
    {
        if ($arguments !== []) {
            $text = vsprintf($text, $arguments);
        }
        $this->output->write($text);
    }

    public function outputLine($text = '', array $arguments = [])
    {
        $this->output($text . PHP_EOL, $arguments);
    }

    public function outputFormatted($text = '', array $arguments = [], $leftPadding = 0)
    {
        $lines = explode(PHP_EOL, $text);
        foreach ($lines as $line) {
            $formattedText = str_repeat(' ', $leftPadding) . wordwrap($line, $this->getMaximumLineLength() - $leftPadding, PHP_EOL . str_repeat(' ', $leftPadding), true);
            $this->outputLine($formattedText, $arguments);
        }
    }

    public function outputTable($rows, $headers = null)
    {
        $tableHelper = $this->getTableHelper();
        if ($headers !== null) {
            $tableHelper->setHeaders($headers);
        }
        $tableHelper->setRows($rows);
        $tableHelper->render($this->output);
    }

    public function select($question, $choices, $default = null, $multiSelect = false, $attempts = false)
    {
        return $this->getDialogHelper()->select($this->output, $question, $choices, $default, $attempts, 'Value "%s" is invalid', $multiSelect);
    }

    public function ask($question, $default = null, array $autocomplete = null)
    {
        return $this->getDialogHelper()->ask($this->output, $question, $default, $autocomplete);
    }

    public function askConfirmation($question, $default = true)
    {
        return $this->getDialogHelper()->askConfirmation($this->output, $question, $default);
    }

    public function askHiddenResponse($question, $fallback = true)
    {
        return $this->getDialogHelper()->askHiddenResponse($this->output, $question, $fallback);
    }

    public function askAndValidate($question, $validator, $attempts = false, $default = null, array $autocomplete = null)
    {
        return $this->getDialogHelper()->askAndValidate($this->output, $question, $validator, $attempts, $default, $autocomplete);
    }

    public function askHiddenResponseAndValidate($question, $validator, $attempts = false, $fallback = true)
    {
        return $this->getDialogHelper()->askHiddenResponseAndValidate($this->output, $question, $validator, $attempts, $fallback);
    }

    public function progressStart($max = null)
    {
        $this->getProgressHelper()->start($this->output, $max);
    }

    public function progressAdvance($step = 1, $redraw = false)
    {
        $this->getProgressHelper()->advance($step, $redraw);
    }

    public function progressSet($current, $redraw = false)
    {
        $this->getProgressHelper()->setCurrent($current, $redraw);
    }

    public function progressFinish()
    {
        $this->getProgressHelper()->finish();
    }

    protected function getDialogHelper()
    {
        if ($this->dialogHelper === null) {
            $this->dialogHelper = new DialogHelper(false);
            $helperSet = new HelperSet([new FormatterHelper()]);
            $this->dialogHelper->setHelperSet($helperSet);
        }
        return $this->dialogHelper;
    }

    protected function getProgressHelper()
    {
        if ($this->progressHelper === null) {
            $this->progressHelper = new ProgressHelper(false);
        }
        return $this->progressHelper;
    }

    protected function getTableHelper()
    {
        if ($this->tableHelper === null) {
            $this->tableHelper = new TableHelper(false);
        }
        return $this->tableHelper;
    }
}