README

RabbitMQ client library for PHP supporting event publishing, order request/reply, and workflow orchestration with progress tracking. Built on the AMQP extension.

Installation

composer require ipedis/rabbit-client

Requires the ext-amqp PHP extension.

Quick Start

Publish an event

use Ipedis\Rabbit\Event\EventDispatcher;

class MyDispatcher
{
    use EventDispatcher;

    protected function getSignatureKey(): string
    {
        return 'your-secret';
    }
}

$dispatcher = new MyDispatcher(/* connection config */);
$payload = EventMessagePayload::build('v1.admin.publication.was-exported', [
    'publication' => ['sid' => 42],
]);
$dispatcher->dispatch($payload);

Submit an order and wait for reply

use Ipedis\Rabbit\Order\Manager;

class MyManager
{
    use Manager;
}

$manager = new MyManager(/* connection config */);
$payload = OrderMessagePayload::build('v1.admin.publication.generate', ['data' => '...']);

$manager->publish($payload, function (ReplyMessagePayload $reply) {
    echo $reply->getBody(); // Worker result
});

$manager->run(); // Blocks until reply received

Key Concepts

Channel Naming

All channels follow the pattern v<version>.<service>.<aggregate>.<action>:

v1.admin.publication.generate
v1.admin.publication.was-exported

Workflow Example

use Ipedis\Rabbit\Workflow\Workflow;
use Ipedis\Rabbit\Workflow\Group;

$workflow = new Workflow(function (Group $group) {
    $group->add(new Task('step-1', $payload1));
    $group->add(new Task('step-2', $payload2));
})
->then(function (Group $group) {
    $group->add(new Task('step-3', $payload3)); // Runs after group 1 completes
});

$progress = $workflow->getProgressBag();
$progress->getPercentage()->getCompleted(); // 0.0 - 100.0
$progress->getStatus();                      // pending|running|success|failed

Dependencies

This library depends on ipedis/http-signature for signed HTTP recovery endpoints.

Compatibility

Required extensions: amqp, json

Local Development

Requires Docker.

make up        # Start container
make install   # Install dependencies
make qa        # Run full QA suite (rector + pint + phpstan + tests)

Available targets:

Disclaimer

This package is maintained by Ipedis. It is provided as-is under the terms of its license.