Martin Bean
Martin Bean

Reputation: 39429

How to schedule Artisan commands in a package?

I have a package that contains Artisan commands. I’ve registered these commands with Artisan via my service provider like so:

/**
 * Register the application services.
 *
 * @return void
 */
public function register()
{
    // Register Amazon Artisan commands
    $this->commands([
        'App\Marketplace\Amazon\Console\PostProductData',
        'App\Marketplace\Amazon\Console\PostProductImages',
        'App\Marketplace\Amazon\Console\PostProductInventory',
        'App\Marketplace\Amazon\Console\PostProductPricing',
    ]);
}

However, these commands need to be scheduled to run daily.

I know in app/Console/Kernel.php there is the schedule() method where you can register commands and their frequency, but how can I schedule commands in my package’s service provider instead?

Upvotes: 25

Views: 10208

Answers (2)

Zane
Zane

Reputation: 4752

(see Dave's answer below for Laravel 6.10+)

The trick is to wait until after the Application has booted to schedule the commands, since that is when Laravel defines the Schedule instance and then schedules commands internally. Hope this saves someone a few hours of painful debugging!

use Illuminate\Support\ServiceProvider;
use Illuminate\Console\Scheduling\Schedule;

class ScheduleServiceProvider extends ServiceProvider
{
    public function boot()
    {
        $this->app->booted(function () {
            $schedule = $this->app->make(Schedule::class);
            $schedule->command('some:command')->everyMinute();
        });
    }

    public function register()
    {
    }
}

Upvotes: 75

Dave James Miller
Dave James Miller

Reputation: 5308

In Laravel 6.10 and above:

use Illuminate\Support\ServiceProvider;
use Illuminate\Console\Scheduling\Schedule;

class ScheduleServiceProvider extends ServiceProvider
{
    public function boot()
    {
        $this->callAfterResolving(Schedule::class, function (Schedule $schedule) {
            $schedule->command('some:command')->everyMinute();
        });
    }

    public function register()
    {
    }
}

Upvotes: 26

Related Questions