Download the PHP package eric28/dispatcher without Composer

Features

• Schedule artisan commands to run automatically
• Scheduling is maintained within your version control system
• Single source of truth for when and where commands run
• Schedule commands to run with arguments and options
• Run commands as other users
• Run commands in certain environments
• Use custom drivers for custom scheduling contexts

Tutorial

Installation

Upgrading from 1.4 to 2.0

In all scheduled commands...

Usage

If commands are not visible via php artisan then they cannot be scheduled.

Generating New Scheduled Commands

Scheduling Existing Commands

You may either implement \Indatus\Dispatcher\Scheduling\ScheduledCommandInterface or follow the below steps.

1. Add use statements to your command. If you're using a custom driver you will use a different Scheduler class.

2. Extend \Indatus\Dispatcher\Scheduling\ScheduledCommand
3. Implement schedule():

For details and examples on how to schedule, see the DateTime Driver.

Running Commands As Users

You may override user() to run a given artisan command as a specific user. Ensure your scheduled:run artisan command is running as root.

This feature may not be supported by all drivers.

Environment-Specific Commands

You may override environment() to ensure your command is only scheduled in specific environments. It should provide a single environment or an array of environments.

Maintenance Mode

By default, cron commands will not run when application is in Maintenance Mode. This will prevent all sorts of weird output that might occur if a cron command is run while you are migrating a database or doing a composer update.

You may override runInMaintenanceMode() to force your command to still be run while the application is in maintenance mode.

Advanced scheduling

You may schedule a given command to to run at multiple times by schedule() returning multiple Schedulable instances.

You may also schedule a command to run with arguments and options.

NOTE: Both args() and opts(), whichever is called first, will internally create a new Schedulable instance for you so you don't need to App::make().

Drivers

Drivers provide the ability to add additional context to your scheduling. Building custom drivers is a great way to customize this context to your application's needs.

DateTime (Default)

Examples of how to schedule:

Custom Drivers

Custom drivers allow you to provide application context within scheduling. For example, an education-based application may contain scheduling methods like inServiceDays(), springBreak() and christmasBreak() where commands are run or don't run during those times.

Create a packagepath such as \MyApp\ScheduleDriver\ and create two classes:

• Scheduler that implements Indatus\Dispatcher\Scheduling\Schedulable. This class should provide a useful interface for programmers to schedule their commands.
• ScheduleService that extends \Indatus\Dispatcher\Services\ScheduleService. This class contains logic on how to determine if a command is due to run.

Publish the configs using php artisan config:publish indatus/dispatcher. Then update your driver configuration to reference the package in which these 2 classes are included (do not include a trailing slash):

FAQ

I need to deploy to multiple servers representing a single environment. How can I be sure my command is only run by a single server and not run on each server?