technopers/laravel-trackable-jobs

v2.0 2023-03-27 06:49 UTC

Requires

• php: ^8.1
• illuminate/support: ^10.0
• spatie/laravel-package-tools: ^1.14

Requires (Dev)

• orchestra/testbench: ^v8.0
• phpunit/phpunit: ^10.0

MIT

• Hardik Modha

• technopers
• laravel-trackable-jobs

README

Laravel trackable jobs is simple yet affective library for tracking background processes by Model entry (row).

Installation

You can install the package via composer:

composer require technopers/laravel-trackable-jobs

Usage

You have a process called compress user profile picture. Which is related to specific user. So your job will be

class CompressUserProfilePicture {
    
}

This job can easily be tracked by each user, You can have status of this process, What you need to do is that.

Just add trait called "Trackable" and pass model object

class CompressUserProfilePicture 
{
    use Trackable {
        Trackable::__construct as __trackableConstruct;
    };
    
    public $user;
    
    public function __construct($user)
    {
        $this->user = $user;
        $this->__trackableConstruct($user);
    }
}

Find processes by user

Get processes by User

For that add, Just add trait called "HasTrackedJobs"

use HasTrackedJobs;

It will add relations and give you finding methods like,

public function trackedJobs(): MorphMany
{
    return $this->morphMany(TrackedJob::class, 'trackable');
}

public function finishedJobs(): MorphMany
{
    return $this->morphMany(TrackedJob::class, 'trackable')
        ->where('status', TrackedJobStatuses::STATUS_FINISHED);
}

public function failedJobs(): MorphMany
{
    return $this->morphMany(TrackedJob::class, 'trackable')
        ->where('status', TrackedJobStatuses::STATUS_FAILED);
}

public function runningJobs(): MorphMany
{
    return $this->morphMany(TrackedJob::class, 'trackable')
        ->where('status', TrackedJobStatuses::STATUS_STARTED);
}

public function pendingJobs(): MorphMany
{
    return $this->morphMany(TrackedJob::class, 'trackable')
        ->where('status', TrackedJobStatuses::STATUS_QUEUED);
}

Also, if you have single job by each model

For that add, Just add trait called "HasTrackedJob" not "HasTrackedJobs"

use HasTrackedJob;

Which has methods like,

public function trackedJob(): MorphOne
{
    return $this->morphOne(TrackedJob::class, 'trackable');
}

public function finishedJobs(): MorphOne
{
    return $this->morphOne(TrackedJob::class, 'trackable')
        ->where('status', TrackedJobStatuses::STATUS_FINISHED);
}

public function failedJobs(): MorphOne
{
    return $this->morphOne(TrackedJob::class, 'trackable')
        ->where('status', TrackedJobStatuses::STATUS_FAILED);
}

public function runningJobs(): MorphOne
{
    return $this->morphOne(TrackedJob::class, 'trackable')
        ->where('status', TrackedJobStatuses::STATUS_STARTED);
}

public function pendingJobs(): MorphOne
{
    return $this->morphOne(TrackedJob::class, 'trackable')
        ->where('status', TrackedJobStatuses::STATUS_QUEUED);
}

Usage

Fetch processes

$userProcesses = $user->trackedJob()->get();

or

$userProcesses = $user->trackedJob;

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email [e-mail] instead of using the issue tracker.

Credits

• Hardik Modha
• All Contributors

License

The MIT License (MIT). Please see License File for more information.