thomasvargiu/zf-messenger

This package is abandoned and no longer maintained. The author suggests using the thomasvargiu/laminas-messenger package instead.

ZF factories to use the Symfony Messenger in ZF2 and expressive applications

0.2.0 2019-11-28 16:45 UTC

Requires

• php: ^7.1
• psr/container: ^1.0
• symfony/event-dispatcher: ^4.3 || ^5.0
• symfony/messenger: ^4.4 || ^5.0
• zendframework/zend-servicemanager: ^3.0

Requires (Dev)

• doctrine/dbal: ^2.7
• doctrine/orm: ^2.4
• facile-it/facile-coding-standard: ^0.3.1
• friendsofphp/php-cs-fixer: ^2.16
• phpstan/phpstan: ^0.11.19
• phpunit/phpunit: ^7.5 || ^8.4
• psr/cache: ^1.0
• psr/log: ^1.1
• vimeo/psalm: ^3.6
• zendframework/zend-config-aggregator: ^1.1

Suggests

• doctrine/dbal: To use doctrine transport
• doctrine/orm: To use doctrine ORM middlewares
• psr/cache-implementation: To use stop workers command

Conflicts

• container-interop/container-interop: <1.2

MIT

• Thomas Vargiu

• symfony
• zend
• module
• message
• AMQP
• messaging
• factory
• Messenger
• bus
• Service Bus
• expressive
• symfony messenger

README

Archived Project

This project is abandoned. You should use thomasvargiu/laminas-messenger.

ZF factories to use the Symfony Messenger in ZF2 and expressive applications

Usage

You need to add console commands to your application. The following command services are already configured for you:

• Symfony\Component\Messenger\Command\ConsumeMessagesCommand
• Symfony\Component\Messenger\Command\SetupTransportsCommand
• Symfony\Component\Messenger\Command\FailedMessagesRemoveCommand
• Symfony\Component\Messenger\Command\FailedMessagesRetryCommand
• Symfony\Component\Messenger\Command\FailedMessagesShowCommand
• Symfony\Component\Messenger\Command\StopWorkersCommand (see note below)

To use the Symfony\Component\Messenger\Command\StopWorkersCommand command you should set a CacheItemPoolInterface implementation (see below).

A default message bus is already configured for you with the following service name: messenger.bus.default. You can read the Symfony documentation to know how to use it.

Configuration

This is an example configuration:

use TMV\Messenger\Factory;
use Symfony\Component\Messenger;

return [
    'dependencies' => [
        'factories' => [
            'messenger.bus.foo' => [Factory\MessageBusFactory::class, 'messenger.bus.foo'], // the name must be the same as the bus configuration key
            'messenger.transport.async' => [Factory\Transport\TransportFactory::class, 'messenger.transport.async'], // the name must be the same as the transport configuration key
        ],
    ],
    'messenger' => [
        'failure_transport' => null, // your failure transport service name (optional)
        'logger' => null, // your custom logger service name (optional)
        'default_serializer' => SFMessenger\Transport\Serialization\PhpSerializer::class, // default messenger serializer, it should be a service name
        'cache_pool_for_restart_signal' => null, // CacheItemPoolInterface service name implementation if you want to use stop workers command
        'transport_factories' => [
            // here you can add your custom transport factories services
        ],
        'buses' => [
            'messenger.bus.foo' => [ // bus service name, it should be registered as a service with the same name
                'default_middleware' => true, // if you want to include default middleware (default: true)
                'middleware' => [ // your custom middleware service names
                    My\FooMiddleware::class,
                ],
                'allow_no_handler' => false, // allow no handlers (default: false)
                'handlers' => [ // your handlers
                    My\FooMessageType::class => [
                        My\FooMessageHandler::class,
                    ],
                ],
                'routes' => [
                    My\FooMessageType::class => ['messenger.transport.async'], // route message types to this transport
                ],
            ],
        ],
        'transports' => [
            'messenger.transport.async' => [
                'dsn' => 'amqp://guest:guest@rabbitmq:5672',
                'serializer' => Messenger\Transport\Serialization\PhpSerializer::class, // custom serializer service
                'options' => [
                    'exchange' => [
                        'name' => 'messenger_events',
                    ],
                    'queues' => [
                        'messenger_events' => [],
                    ],
                ],
                'retry_strategy' => [
                    'max_retries' => 3,
                    'delay' => 1000,
                    'multiplier' => 2,
                    'max_delay' => 0,
                ],
            ],
        ],
    ],
];