goksagun/scheduler-bundle

Scheduled task bundle

Scheduler Bundle

Command scheduler allows you to fluently and expressively define your command schedule within application itself. When using the scheduler, only a single Cron entry is needed on your server. Your task schedule is defined in the scheduler.yaml file or Schedule annotation or database. When using the scheduler, you only need to add the following Cron entry to your server:, _(*1)

* * * * * php /path-to-your-project/bin/console scheduler:run >> /dev/null 2>&1

This Cron will call the command scheduler every minute. When the scheduler:run command is executed, application will evaluate your scheduled tasks and runs the tasks that are due. If you want to run task(s) as asynchronously call the command scheduler with async flag scheduler:run --async., _(*2)

Installation

Make sure Composer is installed globally, as explained in the installation chapter of the Composer documentation., _(*3)

Applications that use Symfony Flex

Open a command console, enter your project directory and execute:, _(*4)

$ composer require goksagun/scheduler-bundle

Applications that don't use Symfony Flex

Step 1: Download the Bundle

Open a command console, enter your project directory and execute the following command to download the latest stable version of this bundle:, _(*5)

$ composer require goksagun/scheduler-bundle

Step 2: Enable the Bundle

Then, enable the bundle by adding it to the list of registered bundles in the config/bundles.php file of your project:, _(*6)

// config/bundles.php

return [
    // ...
    Goksagun\SchedulerBundle\SchedulerBundle::class => ['all' => true],
];

Then, add console commands to scheduler yaml file scheduler.yaml into config/packages directory:, _(*7)

scheduler:
    enabled: true
    async: ~
    log: ~
    tasks:
         - { name: command:name argument --option, expression: "* * * * *" }
         - { name: another-command:name, expression: "@hourly" }

Or use attribute:, _(*8)

use Goksagun\SchedulerBundle\Attribute\Schedule;
use Symfony\Component\Console\Command\Command;

#[Schedule(name: 'command:name argument --option', expression: '*\/10 * * * *')]
class AttributedCommand extends Command
{
    // 
}

Or use annotation:, _(*9)

use Goksagun\SchedulerBundle\Annotation\Schedule;
use Symfony\Component\Console\Command\Command;

/**
 * @Schedule(name="command:name argument --option", expression="*\/10 * * * *")
 */
class AnnotatedCommand extends Command
{
    // 
}

Or add task(s) to database, you can use scheduler:add command to add a task to database:, _(*10)

php bin/console scheduler:add 'command:name argument --option' '@daily'

If you want to edit task you can use scheduler:edit command:, _(*11)

php bin/console scheduler:edit [id] 'command:name argument --no-option' '@hourly'

If you want to delete task you can use scheduler:delete command:, _(*12)

php bin/console scheduler:delete [id]

If you want to list tasks you can use scheduler:list command:, _(*13)

php bin/console scheduler:list

Step 4: Add the Bundle log table schema (optional)

Then, if you want to track scheduled task(s) add the bundle log table schema and store executed task(s) to db:, _(*14)

php bin/console doctrine:schema:update --force