README

About

phpsoftbox/queue — компонент очередей и воркера для PhpSoftBox. Включает минимальный контракт очереди, модель job, in-memory очередь и адаптер для работы с БД.

Ключевые свойства:

• контракт QueueInterface
• модель QueueJob с попытками
• Worker с ретраями и обработкой ошибок
• DatabaseDriver для использования БД через компонент Database
• поддержка приоритета и отложенной доступности (available_datetime)
• поддержка mutex-ключей на job для ограничения параллельных запусков
• запись задач, исчерпавших попытки, через FailedJobStoreInterface
• прогресс выполнения через ProgressAwareInterface / ProgressStoreInterface
• события жизненного цикла воркера: before, after, onStatusChange
• поддержка отмены для задач с флагом is_cancellable

Quick Start

use PhpSoftBox\Queue\Drivers\InMemoryDriver;
use PhpSoftBox\Queue\ProgressAwareInterface;
use PhpSoftBox\Queue\QueueJob;
use PhpSoftBox\Queue\Worker;

$queue = new InMemoryDriver();
$queue->push(
    QueueJob::fromPayload(['type' => 'email', 'id' => 10])
        ->withMutex('tenant:1:company:15:import', 7200),
);

$worker = new Worker($queue, maxAttempts: 3);
$worker->run(function (mixed $payload, QueueJob $job, ProgressAwareInterface $progress): void {
    $progress->setTotal(100);
    $progress->increment();
    // обработка задания
});

Очередь в БД:

use PhpSoftBox\Database\Configurator\DatabaseFactory;
use PhpSoftBox\Database\Connection\ConnectionManager;
use PhpSoftBox\Queue\Drivers\DatabaseDriver;
use PhpSoftBox\Queue\DatabaseQueueSchema;

$factory = new DatabaseFactory([
    'connections' => [
        'default' => 'main',
        'main' => [
            'read' => ['dsn' => 'sqlite:///:memory:'],
            'write' => ['dsn' => 'sqlite:///:memory:'],
        ],
    ],
]);

$queue = new DatabaseDriver(new ConnectionManager($factory), new DatabaseQueueSchema(), 'main');

Оглавление

• Документация
• About
• Quick Start
• Worker
• InMemory Queue
• Database Queue
• CLI
• DI
• Progress