glooby/task-bundle

Scheduling of tasks for symfony made simple

task-bundle

, _(*1)

Provides a simple framework to manage scheduling and execution of tasks Symfony application., _(*2)

Prerequisite

This bundle requires cron to be installed on the server to be able to execute scheduled tasks, _(*3)

Installation

Add the glooby/task-bundle package to your require section in the composer.json file., _(*4)

``` bash $ composer require glooby/task-bundle ~3.0, <sub>(*5)</sub>

Add the GloobyTaskBundle to your application's kernel:

``` php
<?php
public function registerBundles()
{
    $bundles = [
        // ...
        new Glooby\TaskBundle\GloobyTaskBundle(),
        // ...
    ];
    ...
}

Create this file /etc/cron.d/glooby_scheduler_run, <sub>(*6)</sub>

``` bash * * * * * nginx cd /path/to/project && php bin/console scheduler:run --env=prod &> /dev/null 2>&1, <sub>(*7)</sub>

Documentation
-----------------

### Create a executable Task

To setup a new runnable task you should follow these steps

#### Implement the TaskInterface

example: src/Glooby/Api/TaskBundle/Task/PingTask.php

```php

    class PingTask implements TaskInterface
    {
        /**
         * @inheritdoc
         */
        public function run(array $params = [])
        {
            return 'pong';
        }
    }

Add a service for your task, <sub>(*8)</sub>

services:
    glooby_task.ping:
        class: Glooby\TaskBundle\Task\PingTask

Try and run the task trough cli

    $ bin/console task:run glooby_task.ping

    "pong"

Setup Scheduled task

To setup a new schedule you should follow the steps below, <sub>(*9)</sub>

Make your service runnable

Follow the steps in [Create a executable Task](#Create a executable Task), <sub>(*10)</sub>

Tag your service

By tagging your service with the glooby.scheduled_task tag it will be treated as a scheduled task, <sub>(*11)</sub>

example:, <sub>(*12)</sub>

src/Glooby/Api/TaskBundle/Resources/config/services.yml, <sub>(*13)</sub>

services:
    glooby_task.ping:
        class: Glooby\TaskBundle\Task\PingTask
        tags:
            - { name: glooby.scheduled_task }

Annotate your class

Annotate your class with this annotation: Glooby\TaskBundle\Annotation\Schedule, <sub>(*14)</sub>

Parameters

interval

The first parameter to the annotation is defaulted to the interval parameter. In this parameter you configure the interval that the service should be executed., <sub>(*15)</sub>

The interval is a string of five or optional six subexpressions that describe details of the schedule. The syntax is based on the Linux cron daemon definition., <sub>(*16)</sub>

    *    *    *    *    *    *
    -    -    -    -    -    -
    |    |    |    |    |    |
    |    |    |    |    |    + year [optional]
    |    |    |    |    +----- day of week (0 - 7) (Sunday=0 or 7)
    |    |    |    +---------- month (1 - 12)
    |    |    +--------------- day of month (1 - 31)
    |    +-------------------- hour (0 - 23)
    +------------------------- min (0 - 59)

This is the only required parameter, <sub>(*17)</sub>

use Glooby\TaskBundle\Annotation\Schedule;

/**
 * @Schedule("* * * * *")
 */
class PingTask implements TaskInterface
{

Here you have several shortcuts that you can use instead for most common use cases, <sub>(*18)</sub>

use Glooby\TaskBundle\Annotation\Schedule;

/**
 * @Schedule("@hourly")
 */
class PingTask implements TaskInterface
{

params

The params that should be used when calling, <sub>(*19)</sub>

use Glooby\TaskBundle\Annotation\Schedule;

/**
* @Schedule("@weekly", params={"wash": true, "flush": 500})
*/
class CityImporter implements TaskInterface
{

active

Phe active parameter tells if the schedule should be active or not, default=true, <sub>(*20)</sub>

use Glooby\TaskBundle\Annotation\Schedule;

/**
* @Schedule("*/6", active=false)
*/
class PingTask implements TaskInterface
{

Sync schedules to the database, this has to be run after each update

bin/console scheduler:run

Running the Tests

Install the dependencies:, <sub>(*21)</sub>

``` bash $ script/bootstrap, <sub>(*22)</sub>

Then, run the test suite:

``` bash
$ script/test

Contributing

See CONTRIBUTING file., <sub>(*23)</sub>

License

This bundle is released under the MIT license. See the complete license in the bundle: LICENSE.md, <sub>(*24)</sub>

www.glooby.com www.glooby.se, <sub>(*25)</sub>