lordsimal/cakephp-scheduler

Scheduler plugin for CakePHP

1.1.1 2024-11-17 08:52 UTC

Requires

• php: ^8.1
• cakephp/cakephp: ^5.0
• dragonmantank/cron-expression: ^3.3

Requires (Dev)

• cakephp/cakephp-codesniffer: ^5.0
• mockery/mockery: ^1.6
• phpunit/phpunit: ^10.5.5 || ^11.1.3

MIT

• Kevin Pfeifer

README

What can this plugin do?

This tool allows you to move all your cron jobs from being server configured via crontab to being app controlled in your CakePHP application (and plugins).

Requirements

• PHP 8.1+
• CakePHP 5.0+

Installation

composer require lordsimal/cakephp-scheduler

Loading plugin

In Application.php

public function bootstrap()
{
    parent::bootstrap();

    $this->addPlugin(\CakeScheduler\CakeSchedulerPlugin::class);
}

Or use the cake CLI.

bin/cake plugin load CakeScheduler

Usage

Defining a schedule

Either your app or your plugin need to implement the CakeSchedulerInterface which will add the schedule(Scheduler &$scheduler) method.

<?php
 
namespace App;

use App\Command\MyAppCommand;
use App\Command\OtherAppCommand;
use Cake\Http\BaseApplication;
use CakeScheduler\CakeSchedulerInterface;
use CakeScheduler\Scheduler\Scheduler;

class Application extends BaseApplication implements CakeSchedulerInterface
{
    public function schedule(Scheduler &$scheduler): void
    {
        $scheduler->execute(MyAppCommand::class)->daily();
        $scheduler->execute(OtherAppCommand::class, ['somearg', '--myoption=someoption'])->daily();
    }
}

with the ->execute() method you define which Command should be executed.

Each ->execute() method will return a \CakeScheduler\Scheduler\Event instance which is used to tell the scheduler when the command should be executed.

Available frequencies

Also see the EventTest for all the available options

List all scheduled events

bin/cake schedule:view

Running the Scheduler

You still need the following entry in your crontab

* * * * * cd /path-to-your-project && bin/cake schedule:run >> /dev/null 2>&1

Credit where credit is due

This plugin is heavily inspired by the Laravel Task Scheduling Feature

License

The plugin is available as open source under the terms of the MIT License.