Scheduler

, _(*1)

PHP job scheduler. (Cronjob tasker), _(*2)

Installing

Via composer:, _(*3)

composer require 10quality/scheduler

Usage

Scheduler

Create a php file that will be called by cronjob, Sample, and include the following code lines:, _(*4)

// 1) LOAD COMPOSER AUTOLOAD OR BOOTSTRAP FIRST

// 2)
use Scheduler\Scheduler;

Init scheduler with the required configuration:, _(*5)

Scheduler::ready([
    'jobs'      => ['path' => __DIR__.'/jobs'],
    'session'   => ['driver' => 'file', 'path'=>__DIR__.'/.tmp'],
]);

NOTE: Scheduler requires a defined jobs path (where jobs are located) and the session driver/settings to use to handle intervals (the package only supports file atm)., _(*6)

Scheduler::ready([...])
    ->job('MyJob', function($task) {
        return $task->daily();
    });

Start scheduler:, _(*8)

Scheduler::ready([...])
    ->job(...)
    ->start();

Then setup a cronjob task to run scheduler, as follows:, _(*9)

* * * * * php /path/to/scheduler-file.php >> /dev/null 2>&1

Jobs

Scheduler runs jobs written in PHP. A job is a PHP class extended from Scheduler\Base\Job class. Once a job is registered in the scheduler, it will call to the execute() function in runtime, Sample., _(*10)

Create a job mimicking the following example:, _(*11)

use Scheduler\Base\Job;

class MyJob extends Job
{
    public function execute()
    {
        // My code here...
    }
}

For the example above, the job file must be named MyJob.php and must be stored in the jobs path., _(*12)

Intervals

Execution intervals are defined when registering a job:, _(*13)

Scheduler::ready([...])
    ->job('MyJob', function($task) {
        // Here we define the task interval
        return $task->daily();
    });

Available intervals:, _(*14)

// On every execution
$task->now();

// Daily
$task->daily();

// Weekly
$task->weekly();

// Monthly
$task->monthly();

// Every minute
$task->everyMinute();

// Every 5 minutes
$task->everyFiveMinutes();

// Every 10 minutes
$task->everyTenMinutes();

// Every 30 minutes
$task->everyHalfHour();

// Every hour
$task->everyHour();

// Every 12 hours
$task->everyTwelveHours();