IProgressMonitor interface

IProgressMonitor.php

<?php

namespace App\Core\Utils\ProgressMonitor;

interface IProgressMonitor {
    /**
     * Starts a new progress monitor
     *
     * @param string $title The title of progress monitor
     * @param int|null $max
     */
    public function start(string $title, int $max = null);

    /**
     * Advances the progress output X steps.
     *
     * @param int $step Number of steps to advance
     * @param string|null $message
     */
    public function advance(int $step = 1, ?string $message = null);

    /**
     * Sets progress of progress monitor
     *
     * @param int $progress
     */
    public function setProgress(int $progress);

    /**
     * @param int $max
     */
    public function setMax(int $max);

    /**
     * Shows a message in progress monitor
     *
     * @param string $message
     */
    public function message(string $message);

    /**
     * Finishes the progress output with specified message.
     *
     * @param string|null $message
     */
    public function finish(string $message = null);

    /**
     * Aborts progress monitor
     *
     * @return void
     */
    public function abort();
}