TaskRabbitMqBundle

Waiting for symfony/symfony#23315 to implement new approach with built-in Amqp & Worker components.

Installation

For Symfony Framework >= 3.0

Require the bundle and its dependencies with composer:

$ composer require yceruto/task-rabbitmq-bundle:dev-master

Register the bundle:

// app/AppKernel.php

public function registerBundles()
{
    $bundles = array(
        new Yceruto\TaskRabbitMqBundle\TaskRabbitMqBundle(),
    );
}

Configuration

task_rabbit_mq:
    task_class: AppBundle\Entity\Task
    rabbit_mq:
        url: 'amqp://symfony:rabbit@127.0.0.1:5672/%2fdemo?lazy=1'

<?php
// src/AppBundle/Entity/Task.php

namespace AppBundle\Entity;

use Yceruto\TaskRabbitMqBundle\Model\Task as BaseTask;
use Doctrine\ORM\Mapping as ORM;

/**
 * @ORM\Entity
 * @ORM\Table(name="task_rabbit_mq")
 */
class Task extends BaseTask
{
    /**
     * @ORM\Id
     * @ORM\Column(type="integer")
     * @ORM\GeneratedValue(strategy="AUTO")
     */
    protected $id;

    public function __construct()
    {
        parent::__construct();
        // your own logic
    }
}

Usage

Defines the Worker and register it as service

class SendEmailWorker implements WorkerInterface
{
    private $mailer;

    public function __construct(\Swift_Mailer $mailer) 
    {
        $this->mailer = $mailer;
    }

    /**
     * @param array $job
     *
     * @return mixed|void
     */
    public function execute($job)
    {
        $message = (new \Swift_Message('Hello Email'))
            ->setFrom('me@example.com')
            ->setTo($job['email'])
            ->setBody('...', 'text/html')
            ->attach(Swift_Attachment::fromPath($job['attachment']))
        ;
        
        $this->mailer->send($message);
    }
}

services:
    AppBundle\Worker\SendEmailWorker:
        class: AppBundle\Job\SendEmailWorker
        arguments: ['@mailer']
        tags:
            - { name: task_rabbitmq.worker }

Assigning task to the Worker

$taskManager = $this->get('task_rabbit_mq.manager');
$taskAssigner = $this->get('task_rabbit_mq.assigner');

$task = $taskManager->createTask()
    ->setName('Delivering Monthly Reports')
    ->addJobData(array('email' => 'john@gmail.com', 'attachment' => 'path/to/report.pdf'))
    ->addJobData(array('email' => 'jane@gmail.com', 'attachment' => 'path/to/statements.docx'))
    //...
;

$taskManager->updateTask($task);

// this will send all jobs to RabbitMq server and the worker starts to execute each job.
$taskAssigner->assign($task, SendEmailWorker::class);

License

This software is published under the MIT License