cronox/cake-cron-jobs

CakePHP3 Plugin to create jobs for CRON

1.1.0 2019-06-13 08:56 UTC

Requires

• php: ^7.2
• cakephp/cakephp: ^3.4

Requires (Dev)

• symplify/easy-coding-standard: ^4.0

MIT

• Michał Jagodziński

• cron
• cakephp
• cakephp3
• cron jobs

README

Installation

Composer

composer require cronox/cake-cron-jobs

Load the Plugin

Ensure the Plugin is loaded in your config/bootstrap.php file

Plugin::load('Cronox/CronJobs');

Database

Init the database table by using cakephp's migrations

bin/cake migrations migrate --plugin Cronox/CronJobs

Example

To add method \App\Lib\Mailer::sendMail('[e-mail]','Message text') to cron queue:

try {
    CronJobHelper::create(\App\Lib\Mailer::class, 'sendMail', ['[e-mail]','Message text']);
} catch (\Exception $exception) {
    throw $exception;
}

To run queue by cron add following line to crontab:

bin/cake cronox/cron_jobs.cron_jobs

Example output:

➜  www ✗ bin/cake cronox/cron_jobs.cron_jobs
Found 1 jobs.
Running job #5 App\Lib\Mailer::sendMail
Job is completed correctly
➜  www ✗ 

Grouped tasks

try {
    $groupEmailCode = 'Email';
    $groupSMSCode = 'SMS';
    CronJobHelper::create(\App\Lib\Mailer::class, 'sendMail', ['[e-mail]','Message text'], $groupEmailCode);
    CronJobHelper::create(\App\Lib\SmsApi::class, 'sendSMS', ['321654987','Message text'], $groupSMSCode);
} catch (\Exception $exception) {
    throw $exception;
}

To run grouped tasks by cron add following commands to crontab:

bin/cake cronox/cron_jobs.cron_jobs Email
bin/cake cronox/cron_jobs.cron_jobs SMS