Scheduler

The scheduler runs recurring tasks, like clean-ups, reports and imports, from a single cron job. You define the tasks in PHP instead of adding a cron entry for each one.

The cron job#

Add one cron job that runs every minute. In cPanel, use Cron Jobs → Once Per Minute:

* * * * * php /home/USER/my-site/flo schedule:run >> /dev/null 2>&1

If your host's default php is a different version, use the full path it gives you, such as /usr/local/bin/ea-php83. Every minute, schedule:run starts the tasks that are due and exits.

Defining tasks#

Tasks live in config/schedule.php:

<?php
use FloCMS\CLI\Scheduling\Schedule;

return static function (Schedule $schedule): void {
    $schedule->defaults(); // api:gc, log rotation, stale upload cleanup

    $schedule->command('reports:send', ['--weekly'])->weeklyOn(1, '08:00');
    $schedule->command('backup:run')->dailyAt('02:30')->environments('production');
    $schedule->call(static fn () => touch(__DIR__ . '/../storage/heartbeat'), 'heartbeat')->everyFiveMinutes();
    $schedule->command('feeds:import')->cron('*/20 6-22 * * mon-fri')->timezone('Asia/Baghdad');
};

• command('name', [arguments]) runs a php flo command, your own included. See writing commands.
• call($function, 'name') runs a PHP function. The name identifies it in the log and in --task.

Frequencies#

More options#

How tasks run#

• No overlaps. A task that's still running isn't started again, unless you call allowOverlapping().
• In-process. Tasks run inside the schedule:run process, so shared hosts without proc_open work.
• Results go to storage/logs/schedule.log.

php flo schedule:list                     # each task with its next run and last result
php flo schedule:run --task="heartbeat"   # run one task now, whether it's due or not

Built-in tasks#

$schedule->defaults() adds three tasks. Without a config/schedule.php, these are the only tasks:

To change one of them, leave out defaults() and add the tasks yourself:

$schedule->command('api:gc', ['--database'])->dailyAt('04:00');
$schedule->rotateLogs(20 * 1024 * 1024, 10)->dailyAt('03:20');      // 20 MB, keep 10
$schedule->cleanDirectory('storage/uploads/.chunks', 48)->hourly();  // older than 48 hours