Laravel Packages

Dispatch Laravel Jobs Via Artisan

Published
Dispatch Laravel Jobs Via Artisan image

Laravel Artisan Dispatchable is a package by Spatie to register queue jobs as Artisan commands. The Laravel scheduler can schedule queue jobs that do not block the scheduler, but this approach has one downside:

You have to choose between using an artisan command + blocking the scheduler on the one hand, and job + not blocking the scheduler on the other hand.

Using our package, you don't have to make that choice anymore. When letting your job implement Spatie's ArtisanDispatchable, you will not block the scheduler and can still execute the logic via Artisan.

The way this package works is that you implement this packages ArtisanDispatchable interface, and your job is available as an artisan command:

use Illuminate\Contracts\Queue\ShouldQueue;
use Spatie\ArtisanDispatchable\Jobs\ArtisanDispatchable;
 
class ProcessPodcast implements ShouldQueue, ArtisanDispatchable
{
public function handle()
{
// perform some work...
}
}

The neat part about this package is that it comes with conventions that allow your job to be available to artisan without any more work, using the kebab-case of the class name:

# Execute via Artisan
php artisan process-podcast
 
# Put your job on the queue instead of executing immediately
php artisan process-podcast --queued
 
# Eloquent models as constructor arguments
# Podcast model instance as a constructor argument
php artisan process-podcast --podcast="1234"

While this package has conventions of command names, the package allows you to override both the command name and description.

You can learn more about this package, get full installation instructions, and view the source code on GitHub. Also, check out the announcement post by Freek Van der Herten.

Paul Redmond photo

Staff writer at Laravel News. Full stack web developer and author.

Sponsored

laravelcloud logo
Laravel Cloud

Easily create and manage your servers and deploy your Laravel applications in seconds.

Visit Laravel Cloud

The latest

View all →
CPX: The Composer Package Executor for PHP image

CPX: The Composer Package Executor for PHP

Read article
Laravel AI SDK Adds Human-in-the-Loop Tool Approval image

Laravel AI SDK Adds Human-in-the-Loop Tool Approval

Read article
Pest 5 Released With Test Impact Analysis, Agent Verification, and Evals image

Pest 5 Released With Test Impact Analysis, Agent Verification, and Evals

Read article
Queue-SQL: Run Mass Deletes and Updates Across Parallel Queue Jobs image

Queue-SQL: Run Mass Deletes and Updates Across Parallel Queue Jobs

Read article
Blade Formatting in Laravel Pint image

Blade Formatting in Laravel Pint

Read article
Inertia DevTools Is Now on the Chrome Web Store image

Inertia DevTools Is Now on the Chrome Web Store

Read article