https://github.com/consoletvs/progresser
Add progress to your laravel application
https://github.com/consoletvs/progresser
Last synced: about 1 year ago
JSON representation
Add progress to your laravel application
- Host: GitHub
- URL: https://github.com/consoletvs/progresser
- Owner: ConsoleTVs
- License: mit
- Created: 2021-06-08T22:00:33.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2021-12-04T15:02:19.000Z (over 4 years ago)
- Last Synced: 2024-05-01T22:53:28.784Z (about 2 years ago)
- Language: PHP
- Size: 101 KB
- Stars: 7
- Watchers: 3
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: Readme.md
- License: LICENSE
Awesome Lists containing this project
README
# Progresser
Adds progress to your laravel application.
```php
$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;
```
```php
$progress = Progress::create();
$progress->start('Preparing information...');
$progress->step('Done task 1');
$progress->complete('Done task 2');
```
```php
$progress = Progress::create();
$progress->start('Preparing information...', 2);
$progress->step('Done task 1');
$progress->step('Done task 2');
```
```php
$progress = Progress::create();
$progress->start('Preparing information...');
$progress->step('Done task 1');
$progress->fail('Done task 2');
```
```php
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...');
```