extensions.md

layout	parent	title	nav_order
default	Client	Extensions	6

{% include support.md %}

Client extensions.

There is an ability to hook into sending process. You have to create an extension class that implements Enqueue\Client\ExtensionInterface interface. For example, TimestampMessageExtension extension adds timestamps every message before sending it to MQ.

<?php
namespace Acme;

use Enqueue\Client\ExtensionInterface;
use Enqueue\Client\Message;

class TimestampMessageExtension implements ExtensionInterface
{
    public function onPreSend($topic, Message $message)
    {
        if ($message->getTimestamp()) {
            $message->setTimestamp(time());
        }
    }

    public function onPostSend($topic, Message $message)
    {

    }
}

Symfony

To use the extension in Symfony, you have to register it as a container service with a special tag.

# config/services.yaml

services:
  timestamp_message_extension:
    class: Acme\TimestampMessageExtension
    tags:
      - { name: 'enqueue.client.extension' }

You can add priority attribute with a number. The higher value you set the earlier the extension is called.

back to index