dominaentregatotal/php-bull-scheduler

PHP library to schedule Redis jobs for the NodeJS Bull Redis queue

v1.1.2 2024-08-20 22:55 UTC

Requires

• php: >=5.5.0 || >=7.0
• ext-json: *
• predis/predis: ^1.1
• psr/log: ^1.1
• ramsey/uuid: ^3.8
• vierbergenlars/php-semver: ^3.0

Requires (Dev)

• ext-ctype: *
• ext-phar: *
• clean/phpdoc-md: ^0.14
• phpunit/phpunit: ^4.8 || ^6.3

Suggests

• ext-redis: *

MIT

• DominaEntregaTotal

• redis
• queue
• nodejs
• php
• scheduler
• bull

README

PHP library to schedule jobs for the NodeJS Bull Redis queue.

Requirements

• PHP >= 5.5.0
• PHP JSON extension
• Redis >= 2.8.18

Installation

Install via composer: composer require dominaentregatotal/php-bull-scheduler

Usage

This library operates under the namspace DominaEntregaTotal\BullScheduler and uses Predis under the hood.

<?php

require_once 'vendor/autoload.php';

use DominaEntregaTotal\BullScheduler\Queue;

// You can specify any value for Redis that Predis considers valid for the first parameter of Predis\Client
$queue = new Queue('name-queue', 'tcp://localhost:6379');
$queue2 = new Queue('name-queue', ['redis' => ['host' => 'localhost', 'port' => 6379]]);
$queue3 = new Queue('other-queue', new Predis\Client());

$job_id = $queue->add(['data' => 'value']);

// with process name and options
$job_id = $queue->add('name-process', [
                            'key' => 'value',
                        ], [
                            'attempts'  => 3, // try 3 attemps
                            'delay'     => 1000, // delay 1 second in miliseconds
                        ]);

Caveats

• This library has been tested with Bull v3.6.0. No other versions have been tested, so use at your own risk with other versions.
• This library only handles scheduling (adding new jobs) and will never handle job processing of any form, including job statuses.

License

The code for PHP Bull Scheduler is distributed under the terms of the MIT license (see LICENSE).