linio/queue

Abstracts work queues, used to distribute time-consuming tasks among multiple workers.

3.0.0 2020-01-06 14:45 UTC

Requires

• php: ^7.4
• linio/util: ^3.0
• php-amqplib/php-amqplib: ^2.11
• psr/log: ^1.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^2.16
• phpstan/phpstan: ^0.12
• phpunit/phpunit: ^8.5

BSD-3-Clause

• queue
• rabbitmq
• rabbit
• distributed
• linio

README

Linio Queue abstracts work queues, used to distribute time-consuming tasks among multiple workers.

Install

The recommended way to install Linio Queue is through composer.

{
    "require": {
        "linio/queue": "~3.0"
    }
}

Tests

To run the test suite, you need install the dependencies via composer, then run PHPUnit.

$ composer install
$ phpunit

Usage

The library is very easy to use: first, you have to register the service. For Silex, a service provider is included. Just register it:

<?php

use Linio\Component\Queue\QueueService;
use Linio\Component\Queue\Adapter;

$queue = new QueueService();
$queue->setAdapter(new Adapter\RabbitAdapter([
    'host' => 'localhost',
    'port' => 5672,
    'username' => 'guest',
    'password' => 'guest',
    'vhost' => '/'
]));

In order to create a work queue, you must extend the abstract class Job:

<?php

use Linio\Component\Queue\Job;

class HelloWorldJob extends Job
{
    public function perform()
    {
        echo sprintf("Hello %s!\n", $this->payload);
        $this->finish();
    }
}

Note that you must always finish() a job to remove it from the queue. You can also fail() jobs. Now, in order to publish messages to a work queue:

<?php

use Linio\Component\Queue\QueueService;

$queue = new QueueService();
$queue->add(new HelloWorldJob('John')); // "John" is the payload

And to consume messages from the work queue:

<?php

use Linio\Component\Queue\QueueService;

$queue = new QueueService();
$queue->perform(new HelloWorldJob());