goksagun/scheduler-bundle

Scheduled task bundle

Installs: 1 434

Dependents: 0

Suggesters: 0

Stars: 1

Watchers: 2

Forks: 0

Open Issues: 0

Type:symfony-bundle

v0.4.7 2019-05-16 10:51 UTC

README

68747470733a2f2f7472617669732d63692e6f72672f676f6b736167756e2f7363686564756c65722d62756e646c652e7376673f6272616e63683d6d6173746572

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.yml file or Schedule annotation or database. When using the scheduler, you only need to add the following Cron entry to your server:

* * * * * 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.

Installation

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:

$ composer require goksagun/scheduler-bundle

This command requires you to have Composer installed globally, as explained in the installation chapter of the Composer documentation.

Step 2: Enable the Bundle (for symfony version 2, 3)

Then, enable the bundle by adding it to the list of registered bundles in the app/AppKernel.php file of your project:

<?php
// app/AppKernel.php

// ...
class AppKernel extends Kernel
{
    public function registerBundles()
    {
        $bundles = array(
            // ...
            new Goksagun\SchedulerBundle\SchedulerBundle(),
        );

        // ...
    }

    // ...
}

Step 3: Add the Bundle config file (for symfony version 2, 3)

Then, add the bundle configuration yml file scheduler.yml into app/config directory:

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

Import new config file to config.yml into app/config directory:

imports:
    ...
    - { resource: scheduler.yml }

Or use annotation:

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:

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

If you want to edit task you can use scheduler:edit command:

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

If you want to list tasks you can use scheduler:list command:

$ 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:

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