halftome/scheduler

This package is abandoned and no longer maintained. No replacement package was suggested.

An advanced scheduler for CakePHP

dev-master 2016-12-08 21:48 UTC

Requires

• php: >=7.0
• cakephp/cakephp: ^3.3.2
• cakephp/migrations: ^1.6

Requires (Dev)

• phpunit/phpunit: *

MIT

• plugin
• cron
• cakephp
• scheduler

README

Installation

You can install this plugin into your CakePHP application using composer.

The recommended way to install composer packages is:

composer halftome/scheduler

Setup the database with migrations:

bin/cake migrations migrate -p Scheduler

Usage

The scheduler will only work if it is invoked, and will only be as precise as the interval it is invoked with. For an example, here is an example cron job using 1min (the shortest allowed interval on cron) as the interval:

* * * * * cd /path/to/app && bin/cake Scheduler.Run

Here is an example configuration to run 2 tasks:

// For example in your bootstrap.php
Configure::write('Scheduler.jobs', [
    'Newsletters' => [
        'interval' => '2 weeks',
    ],
    'CleanUp' => [
        'interval' => '15 minutes', // every 15min
        'command' => 'CleanUpDatabase clean',
        'extra' => [
            'foo' => 'bar',
        ],
        'timeout' => '15 minutes', // if task has not finished after 15min it will be aborted
    ],
    'QuotaCheck' => [
        'interval' => '6 hours',
    ],
]);