owncloud/core

<?php
/**
 * @author Thomas Müller <thomas.mueller@tmit.eu>
 *
 * @copyright Copyright (c) 2018, ownCloud GmbH
 * @license AGPL-3.0
 *
 * This code is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License, version 3,
 * as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License, version 3,
 * along with this program.  If not, see <http://www.gnu.org/licenses/>
 *
 */

namespace OC\Migration;

use OCP\Migration\IOutput;
use Symfony\Component\Console\Helper\ProgressBar;
use Symfony\Component\Console\Output\OutputInterface;

/**
 * Class SimpleOutput
 *
 * Just a simple IOutput implementation with writes messages to the log file.
 * Alternative implementations will write to the console or to the web ui (web update case)
 *
 * @package OC\Migration
 */
class ConsoleOutput implements IOutput {
    /** @var OutputInterface */
    private $output;

    /** @var ProgressBar */
    private $progressBar;

    public function __construct(OutputInterface $output) {
        $this->output = $output;
    }

    /**
     * @param string $message
     */
    public function info($message) {
        $this->output->writeln("<info>$message</info>");
    }

    /**
     * @param string $message
     */
    public function warning($message) {
        $this->output->writeln("<comment>$message</comment>");
    }

    /**
     * @param int $max
     */
    public function startProgress($max = 0) {
        if ($this->progressBar !== null) {
            $this->progressBar->finish();
        }
        $this->progressBar = new ProgressBar($this->output);
        $this->progressBar->start($max);
    }

    /**
     * @param int $step
     * @param string $description
     */
    public function advance($step = 1, $description = '') {
        if ($this->progressBar !== null) {
            $this->progressBar = new ProgressBar($this->output);
            $this->progressBar->start();
        }
        $this->progressBar->advance($step);
    }

    public function finishProgress() {
        if ($this->progressBar === null) {
            return;
        }
        $this->progressBar->finish();
    }
}