symfony-bundles/event-queue-bundle

Symfony EventQueue Bundle

SymfonyBundlesEventQueueBundle

, _(*1)

![Build Status][testing-image] [][scrutinizer-code-quality-link] [][code-coverage-link] , _(*2)

Installation

• Require the bundle with composer:

``` bash composer require symfony-bundles/event-queue-bundle, <sub>(*3)</sub>

* Enable the bundle in the kernel:

``` php
public function registerBundles()
{
    $bundles = [
        // ...
        new SymfonyBundles\EventQueueBundle\SymfonyBundlesEventQueueBundle(),
        // ...
    ];
    ...
}

• Configure the EventQueue bundle in your config.yml.

Defaults configuration:, <sub>(*4)</sub>

``` yml sb_event_queue: service_name: 'event_queue' default_name: 'event:default' storage_path: '%kernel.cache_dir%/event-queue-daemon.%s.pid', <sub>(*5)</sub>

* Configure the redis client in your config.yml. Read more about [RedisBundle configuration][redis-bundle-link].

How to use
----------

Add an event to the queue:

``` php
$dispatcher = $this->get('sb_event_queue');

$dispatcher->on(MyEvent::class, date('Y-m-d H:i:s'), 'Example message');

Your event class must implement SymfonyBundles\EventQueueBundle\EventInterface (or extending SymfonyBundles\EventQueueBundle\Event class) and having constant NAME with the event name. For example:, <sub>(*6)</sub>

``` php namespace AppBundle\Event;, <sub>(*7)</sub>

use SymfonyBundles\EventQueueBundle\Event;, <sub>(*8)</sub>

class MyEvent extends Event { const NAME = 'event.example';, <sub>(*9)</sub>

private $time;
private $message;

public function __construct($time, $message)
{
    $this->time = $time;
    $this->message = $message;
}

public function getTime()
{
    return $this->time;
}

public function getMessage()
{
    return $this->message;
}

}, <sub>(*10)</sub>

Creating an Event Listener.
The most common way to listen to an event is to register an event listener:

``` php
namespace AppBundle\EventListener;

use AppBundle\Event\MyEvent;

class MyListener
{
    public function onEventExample(MyEvent $event)
    {
        $event->getTime();
        $event->getMessage();

        // and we are doing something...
    }
}

Now that the class is created, you just need to register it as a service and notify Symfony that it is a "listener":, <sub>(*11)</sub>

``` yml services: app.my_listener: class: AppBundle\EventListener\MyListener tags: - { name: kernel.event_listener, event: event.example }, <sub>(*12)</sub>

Execution (dispatching) of all events from the queue:

``` php
while ($dispatcher->count()) {
    $dispatcher->dispatch();
}

You can separate the events by section, specifying in event manager the needed section., <sub>(*13)</sub>

``` php $dispatcher->setName('email.notifications');, <sub>(*14)</sub>

$dispatcher->on(EmailNotifyEvent::class, 'Subject', 'Message Body', ['john@domain.com', 'alex@domain.com']); $dispatcher->on(EmailNotifyEvent::class, 'Another subject', 'Another message Body', ['demo@domain.com']);, <sub>(*15)</sub>

$dispatcher->setName('database.reindex');, <sub>(*16)</sub>

$dispatcher->on(DatabaseReindexEvent::class, 'users'); $dispatcher->on(DatabaseReindexEvent::class, 'orders'); $dispatcher->on(DatabaseReindexEvent::class, 'products');, <sub>(*17)</sub>

In this example, will be executed only an events from the section `email.notifications`:

``` php
$dispatcher->setName('email.notifications');

while ($dispatcher->count()) {
    $dispatcher->dispatch();
}

Console commands:, <sub>(*18)</sub>

• event:queue:dispatch
• event:queue:daemon:start
• event:queue:daemon:stop

In what situations is useful to apply the queue of events:, <sub>(*19)</sub>

• When sending email messages
• Parsing websites
• and in other cases, when the execution time of process is very long, and the response from the server must be returned immediately.