README

Async job queue for the ez-php framework — database and Redis drivers, a Worker, and a queue:work console command.

Requirements

PHP 8.5+
ext-pdo
ez-php/contracts 0.*
ez-php/console 0.*
ext-redis (Redis driver only)

Installation

composer require ez-php/queue

Setup

$app->register(\EzPhp\Queue\QueueServiceProvider::class);

Add the worker command to the CLI:

$app->registerCommand(\EzPhp\Queue\Console\WorkCommand::class);

Add config/queue.php to your application:

return [
    'driver' => env('QUEUE_DRIVER', 'database'),  // 'database' | 'redis'
    'redis'  => [
        'host'     => env('REDIS_HOST', '127.0.0.1'),
        'port'     => (int) env('REDIS_PORT', 6379),
        'database' => (int) env('REDIS_DATABASE', 0),
    ],
];

Defining Jobs

use EzPhp\Queue\Job;

final class SendWelcomeEmail extends Job
{
    protected string $queue    = 'emails';
    protected int    $maxTries = 5;

    public function __construct(private readonly string $email) {}

    public function handle(): void
    {
        // send the email ...
    }

    public function fail(\Throwable $exception): void
    {
        // log or notify on permanent failure
    }
}

Dispatching Jobs

use EzPhp\Contracts\QueueInterface;

$queue = $app->make(QueueInterface::class);
$queue->push(new SendWelcomeEmail('alice@example.com'));

Delay a job by setting $delay (seconds):

final class ProcessReport extends Job
{
    protected int $delay = 60; // available after 60 seconds
    // ...
}

Note: The Redis driver does not enforce $delay. Use the database driver for delayed job delivery.

Running the Worker

php ez queue:work                  # process 'default' queue, sleep 3s on empty
php ez queue:work emails           # process 'emails' queue
php ez queue:work emails --sleep=5 # custom sleep interval
php ez queue:work --max-jobs=100   # stop after 100 jobs (useful for cron-based workers)

Drivers

Database Driver (default)

Stores jobs in a jobs table and failed jobs in failed_jobs. Both tables are created automatically. Requires a configured DatabaseInterface in the container.

Supports delayed delivery via available_at column.

Redis Driver

Uses ext-redis. Jobs are pushed to queues:{name} (RPUSH) and consumed via LPOP (FIFO). Failed jobs are appended to queues:failed:{name}.

Delayed delivery is not enforced — jobs are queued immediately regardless of $delay.

Classes

Class	Description
`Job`	Abstract base class for all jobs
`Worker`	Pops and executes jobs; handles retries and permanent failures
`QueueServiceProvider`	Registers `QueueInterface` and `Worker` with the DI container
`Driver\DatabaseDriver`	PDO-backed driver with atomic pop and delayed delivery
`Driver\RedisDriver`	Redis-backed driver via ext-redis
`Console\WorkCommand`	`queue:work` CLI command
`QueueException`	Base exception for queue errors

Setup (standalone development)

cp .env.example .env
./start.sh

ez-php / queue

Maintainers

Package info

Statistics

Security