consoletvs/progresser

Add progress to your laravel application

4.1.0 2021-12-03 14:05 UTC

This package is auto-updated.

Last update: 2024-10-29 05:40:25 UTC


README

Adds progress to your laravel application.

$progress = Progress::create();

// Control methods
$progress->start('Preparing information...');
$progress->step('Done task 1');
$progress->status('Now doing this...');
$progress->complete('Done task 2');
$progress->fail('Failed at task 2');

// Methods
$progress->isRunning();
$progress->hasFailed();
$progress->hasCompleted();
$progress->hasSteps();
$progress->percentage();

// Attributes
$progress->status;
$progress->current_step;
$progress->steps;
$progress->running;
$progress->failed;
$progress->failed_payload;
$progress->default_completed_status;
$progress->default_failed_status;
$progress = Progress::create();

$progress->start('Preparing information...');
$progress->step('Done task 1');
$progress->complete('Done task 2');
$progress = Progress::create();

$progress->start('Preparing information...', 2);
$progress->step('Done task 1');
$progress->step('Done task 2');
$progress = Progress::create();

$progress->start('Preparing information...');
$progress->step('Done task 1');
$progress->fail('Done task 2');
use Illuminate\Database\Eloquent\Model;
use ConsoleTVs\Progresser\Traits\Progressable;

class Book extends Model
{
    use Progressable;
}

$book = Book::create();
$progress = $book->progress('review');
$progress->start('Starting book review...');
$progress->complete('Finished review...');