[11.x] Add environmentSchedule method to the Scheduling Event

[modernben]

This PR introduces the ability to set different schedules for a job based on the environment.

Scenario:
You have a site in production and a dev site where you are making calls to a 3rd-party provider. This provider may have API quotas for how often it can be hit so you set different schedules for production and staging.

Current Solution:
Currently, you can use the ->environments() method to specify which environment to run it in. This works great but also leads to duplicate code.

$schedule->job(ProcessInvoices::class)
    ->name('process_invoices')
    ->onOneServer()
    ->runInBackground()
    ->environments(['production'])
    ->daily();

$schedule->job(ProcessInvoices::class)
    ->name('process_invoices')
    ->onOneServer()
    ->runInBackground()
    ->environments(['staging', 'development'])
    ->weekly();

The Solution:
I'd like to introduce the environmentSchedule method to simplify the scheduling

$schedule->job(ProcessInvoices::class)
    ->name('process_invoices')
    ->onOneServer()
    ->runInBackground()
    ->environmentSchedule(function(Event $schedule, string $environment) {
        return match($environment) {
            'production' => $schedule->daily(),
            default => $schedule->weekly(),
        };
    });

This reduces code duplication by simply accounting for both schedules in the same definition. I am passing in the current environment to the callback but users could use whatever they like.

[taylorotwell]

I would just add Tappable trait to the scheduling event then you could tap the schedule and do any conditional checks you want, not just environment.

[modernben]

Yep I added a macro on my project. Thanks for the review.

Event::macro('environmentSchedule', function (Closure $callback) {
    // Retrieve the current application environment
    $environment = config('app.env');

    // Execute the closure with the schedule instance and environment
    return $callback($this, $environment);
});

[taylorotwell]

I just pushed Tappable.

[modernben]

Thanks! Can you provide a quick example of what you mean?

I think you're talking about wrapping it in tap()?

[joshmanders]

Thanks! Can you provide a quick example of what you mean?

I think you're talking about wrapping it in tap()?

I'm assuming like this

$schedule->job(ProcessInvoices::class)
    ->name('process_invoices')
    ->onOneServer()
    ->runInBackground()
    ->tap(function(Event $schedule) {
        $environment = config('app.env');

        return match($environment) {
            'production' => $schedule->daily(),
            default => $schedule->weekly(),
        };
    });

[modernben]

Awesome. Thank you @joshmanders !