event-band / symfony-bundle
Symfony Bundle for EventBand
Installs: 51 599
Dependents: 1
Suggesters: 0
Security: 0
Stars: 8
Watchers: 3
Forks: 1
Open Issues: 3
Requires
- php: >=7.0
- event-band/band-framework: ~2.0 >=2.2.2
- symfony/console: ~2.1 | ~3.0 | ~4.0
- symfony/event-dispatcher: ~2.1 | ~3.0 | ~4.0
- symfony/framework-bundle: ~2.7 | ~3.2 | ~4.0
Requires (Dev)
- event-band/amqplib-transport: dev-master
- event-band/jms-serializer: dev-master
- jms/aop-bundle: 1.*
- jms/serializer-bundle: 2.3.*@dev
- phpunit/phpunit: ~6.0.0
- symfony/console: 2.3.0 | ~3.0 | ~4.0
- symfony/process: 2.3.* | ~3.0 | ~4.0
Suggests
- event-band/amqplib-transport: Use amqp transport with amqp-lib
- event-band/jms-serializer: Serialize events with jms (jms/serializer-bundle is required)
- event-band/pecl-amqp-transport: Use amqp transport with pecl amqp extension
- jmikola/wildcard-event-dispatcher-bundle: Simple publisher event configuration with wildcards
- jms/aop-bundle: Required for amqp publication data collect
- jms/serializer-bundle: Required to use with event-band/jms-serializer
This package is not auto-updated.
Last update: 2021-01-25 08:51:32 UTC
README
Symfony2 Bundle for EventBand framework
Quick start
Adding event-band to a symfony2 project
Run the following commands:
$ composer require "event-band/symfony-bundle:~1.0" $ composer require "event-band/amqplib-transport:~1.0"
Simple configuration
Creating an event
Create an event, extending the EventBand\Adapter\Symfony\SerializableSymfonyEvent
<?php namespace Acme\EventBundle\Event; use EventBand\Adapter\Symfony\SerializableSymfonyEvent; class EchoEvent extends SerializableSymfonyEvent { /** * @var string **/ protected $message; public function __construct($message) { $this->message = $message; } public funciton getMessage() { return $this->message; } protected function toSerializableArray() { $array = parent::toSerializableArray(); $array['message'] = $this->message; return $array; } protected function fromUnserializedArray(array $data) { parent::fromUnserializedArray($data); $this->message = $data['message']; } }
Creating a listener
Then create a listener
<?php namespace Acme\EventBundle\Event; class EchoEventListener { public function onEchoEvent(EchoEvent $event) { // don't do such things on production echo $event->getMessage(); echo "\n"; } }
And register listener in services.xml
<service id="acme.event_bundle.event.event_listener" class="Acme\EventBundle\EchoEventListener"> <tag name="kernel.event_listener" event="event.echo" method="onEchoEvent"/> </service>
Configuring bands
Add the following lines to your config.yml
event_band: publishers: acme.echo.event.publisher: events: ["event.echo"] transport: amqp: exchange: acme.echo.event.exchange consumers: acme.echo.event: ~
Adding band information to listener to make it asynchronous
Add parameter band
with name of consumer to event listener tag to show which consumer it belongs to.
<service id="acme.event_bundle.event.event_listener" class="Acme\EventBundle\EchoEventListener"> <tag name="kernel.event_listener" event="event.echo" method="onEchoEvent" band="acme.echo.event"/> </service>
Creating AMQP config
This step is not required, but it's very useful to have this config.
Under the event_band
space add the following lines to your config.yml
transports: amqp: driver: amqplib connections: default: exchanges: acme.echo.event.exchange: ~ queues: acme.echo.event: bind: acme.echo.event.exchange: ['event.echo']
Now you can call app/console event-band:setup amqp:default
command and all the exchanges, queues and bindings will be
automatically created/altered.
Using asynchronous event
Somewhere in your code use event dispatcher to dispatch the EchoEvent as you usually do.
$dispatcher = $this->getContainer()->get('event_dispatcher'); $dispatcher->dispatch('event.echo', new EchoEvent('Hi, guys!'));
When you run this code, event will be pushed to the acme.echo.event queue.
Now run console command event-band:dispatch
with the name of your consumer - acme.echo.event
.
sh$ app/cosole event-band:dispatch acme.echo.event
Hi, guys!
... Profit.
Using JMSSerializer
Adding dependencies
Run composer require "event-band/jms-serializer:~1.0"
command
Creating an event
<?php namespace Acme\EventBundle\Event; class EchoEvent implements \EventBand\Event { /** * @var array * @JMS\Serializer\Annotation\Type("array") */ private $data; public function __construct($message) { $this->date['message'] = $message; } public function getMessage() { return $this->data['message']; } }
Config
Add the following lines under 'event_band' section in your config.yml
serializers: serializer: jms: format: json
All the other settings are similar.