Download the PHP package indatus/dispatcher without Composer
On this page you can find all versions of the php package indatus/dispatcher. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download indatus/dispatcher
More information about indatus/dispatcher
Files in indatus/dispatcher
Package dispatcher
Short Description Schedule your artisan commands within your application
License MIT
Informations about the package dispatcher
Dispatcher
Dispatcher allows you to schedule your artisan commands within your Laravel project, eliminating the need to touch the crontab when deploying. It also allows commands to run per environment and keeps your scheduling logic where it should be, in your version control.
README Contents
- Features
- Tutorial
- Installation
- For Laravel 4 (see 1.4 branch)
- Laravel 5's scheduler
- Upgrading from 1.4 to 2.0
- Usage
- Generating New Scheduled Commands
- Scheduling Existing Commands
- Running Commands As Users
- Environment-Specific Commands
- Running Commands In Maintenance Mode
- Advanced Scheduling
- Drivers
- DateTime
- Custom Drivers
- FAQ
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
By Ben Kuhl at the Laravel Louisville meetup (@lurvul): Video - Slides
By Jefferey Way at Laracasts: Recurring Tasks the Laravel Way
Installation
NOTICE: Laravel 5 now includes scheduling out of the box. This package will no longer be maintained for Laravel 5 and above
Requirements | 1.4.* | 2.* |
---|---|---|
Laravel | 4.1/4.2 | 5.x |
PHP | 5.3+ | 5.4+ |
HHVM | 3.3+ | 3.3+ |
Install with Composer... | ~1.4 | ~2.0@dev |
If you're using Laravel 4 view the readme in the 1.4 branch
Add this line to the providers array in your config/app.php
file :
Add the following to your root Crontab (via sudo crontab -e
):
If you are adding this to /etc/cron.d
you'll need to specify a user immediately after * * * * *
.
You may add this to any user's Crontab, but only the root crontab can run commands as other users.
Upgrading from 1.4 to 2.0
In all scheduled commands...
- Replace
use Indatus\Dispatcher\Drivers\Cron\Scheduler
withuse Indatus\Dispatcher\Drivers\DateTime\Scheduler
- Replaced uses of
Scheduler::[DAY_OF_WEEK]
withDay::[DAY_OF_WEEK]
andScheduler::[MONTH_OF_YEAR]
withMonth::[MONTH_OF_YEAR]
executable
config option has been removed. Dispatcher now inherits the path to the binary that was initially used to runscheduled:run
Usage
If commands are not visible via php artisan
then they cannot be scheduled.
Generating New Scheduled Commands
Use php artisan scheduled:make
to generate a new scheduled command, the same way you would use artisan's command:make
. Then register your command with Laravel.
Scheduling Existing Commands
You may either implement \Indatus\Dispatcher\Scheduling\ScheduledCommandInterface
or follow the below steps.
-
Add use statements to your command. If you're using a custom driver you will use a different
Scheduler
class. - Extend
\Indatus\Dispatcher\Scheduling\ScheduledCommand
- 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()
andopts()
, whichever is called first, will internally create a newSchedulable
instance for you so you don't need toApp::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
thatimplements Indatus\Dispatcher\Scheduling\Schedulable
. This class should provide a useful interface for programmers to schedule their commands.ScheduleService
thatextends \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?
Schedule scheduled:run
to run every minute with rcron:
Why are my commands not running when I've scheduled them correctly? I'm also not seeing any error output
1) Verify that mcrypt is installed and working correctly via the command php -i | mcrypt
.
2) Utilizing php artisan scheduled:run --debug
will tell you why they're not running. If you do not see your command listed here then it is not set up correctly.
Example:
I have commands that extend ScheduledCommand
but why don't they appear in when I run scheduled:summary
?
Commands that are disabled will not appear here. Check and be sure isEnabled()
returns true on those commands.
All versions of dispatcher with dependencies
wp-cli/php-cli-tools Version v0.9.4-patch46
mtdowling/cron-expression Version ~1.0.3