README

An Lightweight Task Scheduler Package for Laravel 5. This package allows you to dispatch all scheduled jobs and run at the time.

Installation

Require the package

composer require "cyub/laravel-task-scheduler"

After adding the package, add the ServiceProvider to the providers array in config/app.php

'providers' => [
    ...
    Tink\Scheduler\SchedulerServiceProvider::class,
    ...
];

Then, publish the scheduler config and migration the database of scheduler

php artisan scheduler:install

Configuration

After Install the package, You will find the Configuration in config\scheduler.php

return [
    'enable' => true,
    'schedule_table_name' => 'cron_schedule',
    'schedule_generate_every' => 1,
    'schedule_ahead_for' => 50,
    'schedule_lifetime' => 15,
    'history_cleanup_every' => 10,
    'history_success_lifetime' => 600,
    'history_failure_lifetime' => 600,

    'schedules' => [
        'RegisterRedpacket.activate' => [
            'schedule'  => [
                'cron_expr'   => '*/1 * * * *',
            ],
            'run'   => [
                'class' => App\Cron\RegisterRedpacket::class,
                'function'  => 'activate',
                'params'    => ['isSendSmsNotice' => true]
            ],
            'description' => 'activate register redpacket'
        ]
    ]
];

Usage

Dispatch job and run

php artisan scheduler:dispatch

You can use in Cron

* * * * * php /your-application-path/artisan scheduler:dispatch >> /dev/null 2>&1

View the scheduler config

php artisan scheduler:info config

View the scheduler run result stats

php artisan scheduler:info stats

Clean the scheduler cache

php artisan scheduler:clean