PHP Luminova: Defining Cron Services and Scheduling Task for Execution

Last updated: 2024-12-26 08:30:14

Luminova Cron Scheduling provides a robust framework for defining and managing cron jobs in your application.It includes various methods to specify execution intervals (e.g., seconds, minutes, days), logging, and handling completion or failure events.

Defining a Cron Service

To schedule specific services for execution in a cron job, use the schedule method provided in the App\Config\Cron class. This method allows you to define the command controller class and the corresponding method to execute using the service method of the Core Cron Tasks Manager.

Example

This guide will introduce you to the key methods and how to use them to create a comprehensive cron job setup.

// /app/Config/Cron.php
namespace App\Config;

use Luminova\Core\CoreCronTasks;

final class Cron extends CoreCronTasks
{
    /**
     * Define and schedule tasks for cron execution.
     */
    protected function schedule(): void
    {
        // Define the path to store cron logs
        $logPath = root('/writeable/log/');

        // Schedule the first service
        $this->service('\App\Controllers\ServiceOneCommand::fooMethod')
            ->seconds(5)
            ->output($logPath . 'cron-one.log');

        // Schedule another service
        $this->service('\App\Controllers\ServiceTwoCommand::barMethod')
            ->seconds(5)
            ->output($logPath . 'cron-two.log');
    }
}

In this example, the dailyBackup method from the DailyCommand class is scheduled to run every day with log level set to 'info'.

<?php
$this->service('\App\Controllers\Cli\DailyCommand::dailyBackup')
    ->days()
    ->log('info');

Logging Output

You can specify the log output file for the service using the output method.

<?php
$this->service('\App\Controllers\Cli\DailyCommand::dailyBackup')
    ->days()
    ->output('path/to/log/daily/output/file.log');

Handling Job Completion

The onComplete method allows you to define actions to take when a job completes successfully.

<?php
$this->service('\App\Controllers\Cli\DailyCommand::dailyBackup')
    ->days()
    ->onComplete(static function(array $task){
        // Code to execute upon successful completion of the task
    });

Handling Job Failure

The onFailure method allows you to define actions to take when a job fails to execute.

<?php
$this->service('\App\Controllers\Cli\DailyCommand::dailyBackup')
    ->days()
    ->onFailure(static function(array $task){
        // Code to execute upon failure of the task
    });

Pinging URLs

You can configure the service to ping specific URLs upon job completion or failure.

On Completion

<?php
$this->service('\App\Controllers\Cli\DailyCommand::dailyBackup')
    ->days()
    ->pingOnComplete('https://example.com/ping/daily/success');

On Failure

<?php
$this->service('\App\Controllers\Cli\DailyCommand::dailyBackup')
    ->days()
    ->pingOnFailure('https://example.com/ping/daily/failure');

Adding Descriptions

Use the description method to add a description to your cron job, which can be helpful for documentation and debugging purposes.

<?php
$this->service('\App\Controllers\Cli\DailyCommand::dailyBackup')
    ->days()
    ->description('This is my daily command description');

Full Example

Here is a full example that demonstrates all available methods, to learn more about the method see Core Cron Tasks Documentation.

<?php
$this->service('\App\Controllers\Cli\DailyCommand::dailyBackup')
    ->seconds()
    ->minutes()
    ->hours()
    ->days()
    ->weeks()
    ->months()
    ->years()
    ->cronTime('* * * * *')
    ->pingOnComplete('https://example.com/ping/daily/success')
    ->pingOnFailure('https://example.com/ping/daily/failure')
    ->onComplete(function(array $task): void {
        // Code to execute upon successful completion of the task
    })
    ->onFailure(function(array $task): void {
        // Code to execute upon failure of the task
    })
    ->output('path/to/log/daily/output/file.log')
    ->log('info')
    ->description('This is my daily command description');

Note: This is an example of all configuration methods, you cannot use all the execution time methods together in one service scheduling.

Next » Executing Cron Tasks

Luminova Framework

Version