PHPackages                             socloz/event-queue-bundle - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Queues & Workers](/categories/queues)
4. /
5. socloz/event-queue-bundle

ActiveLibrary[Queues & Workers](/categories/queues)

socloz/event-queue-bundle
=========================

A Symfony2 bundle that enable asynchonous execution of event listeners.

429.1k[1 PRs](https://github.com/SoCloz/SoclozEventQueueBundle/pulls)PHP

Since Dec 30Pushed 6y ago15 watchersCompare

[ Source](https://github.com/SoCloz/SoclozEventQueueBundle)[ Packagist](https://packagist.org/packages/socloz/event-queue-bundle)[ RSS](/packages/socloz-event-queue-bundle/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependenciesVersions (2)Used By (0)

SoclozEventQueueBundle
======================

[](#soclozeventqueuebundle)

A Symfony2 bundle that enable asynchonous execution of event listeners.

As long as some conditions are met, no code changes are required for an application to use the bundle.

The bundle is made of two parts : a listener and a worker.

The *listener* :

- is registered for the configured event, with maximum priority,
- stops propagation of those events,
- sends the serialized events to the queue.

The *worker* :

- builds the list of application listeners for the configured event,
- listens to the queue and deserializes received events,
- executes the listeners.

Dependencies
------------

[](#dependencies)

- `beanstalk` - other queues can be added

Setup
-----

[](#setup)

- enable the bundle,
- install Socket\_Beanstalk () in your vendors directory and configure autoload

```
$loader->registerPrefixes(array(
    [...]
    'Socket_'          => __DIR__.'/../vendor/beanstalk/src',
));
```

- configure the service

```
socloz_event_queue:
    queue_type: beanstalkd
    forward: [ my.event.name, my.event.name ]
    serialize: mongoodm
    beanstalkd:
        host: 127.0.0.1
        tube: event_queue
```

Other possible configuration options (with default values) :

```
socloz_event_queue:
    beanstalkd:
        port: 11300
        persistent: true
        timeout: 1
```

- start the worker (a process management daemon, like supervisord is recommended) :

```
$ app/console socloz:event_queue:worker [stop_after]
```

If used, `stop_after` enables to worker to stop after a certain number of seconds (warning : the test is done *after* a job has been executed).

Serializers
-----------

[](#serializers)

Events need to be serialized before being sent. Objects coming from the ORM/ODM usually cannot be serialized/deserialized using PHP builtin classes, therefore the bundle uses dedicated serializers.

For now, 2 basic serializers exist :

- Mandango (`serialize: mandango`),
- MongoDB ODM (`serialize: mongoodm`).

They assume :

- that a `getId` method exists for ORM/ODM objects,
- that all objects having a `getId` method come from the ORM/ODM,
- that objects have been saved before dispatching the event (the remote listener instantiates objects from the DB),
- that events can be created using the constructor without other method calls,
- that constructor parameters have the same name as class attributes.

I did not have time/wasn't able to find a solution for those. Feel free to contribute better serializers !

`ReflectionClass::newInstanceWithoutConstructor` would help, but has only be added in 5.4. Class specific serializers, built during warm-up, would also improve performance if you need to forward a lot of events.

Example event class :

```