Skip to content

Queue Jobs

A classe GeneratePdfJob fornece um job enfileirável pronto para uso que transfere a geração de PDF para workers em background. Ela aceita um callback builder, grava o resultado em um caminho fornecido e suporta hooks de sucesso/falha, lógica de retry e despacho em lote.

php
use Yeeefang\TcpdfNext\Laravel\Jobs\GeneratePdfJob;

Despacho Básico

Passe um callback que recebe um Document novo e um caminho de saída:

php
use Yeeefang\TcpdfNext\Core\Document;

GeneratePdfJob::dispatch(
    callback: function (Document $pdf) {
        $pdf->setTitle('Monthly Report')
            ->addPage()
            ->setFont('Helvetica', '', 12)
            ->cell(0, 10, 'Generated asynchronously');
    },
    outputPath: storage_path('reports/monthly.pdf'),
)->onQueue('pdf-generation');

O job resolve um Document do container, o passa para seu callback e então grava a saída.

Parâmetros do Construtor

ParâmetroTipoDescrição
callbackClosure(Document): voidBuilder que popula o PDF
outputPathstringCaminho de destino (absoluto, ou relativo à raiz do disco)
disk?stringDisco de filesystem do Laravel (padrão: null para arquivo local)
onSuccess?Closure(string): voidChamado com o caminho de saída em caso de sucesso
onFailure?Closure(Throwable): voidChamado com a exceção em caso de falha

Callbacks de Sucesso e Falha

php
GeneratePdfJob::dispatch(
    callback: function (Document $pdf) {
        $pdf->setTitle('Contract')
            ->addPage()
            ->setFont('Helvetica', 'B', 14)
            ->cell(0, 10, 'Service Agreement');
    },
    outputPath: 'contracts/SA-0042.pdf',
    disk: 's3',
    onSuccess: function (string $path) {
        Notification::send($user, new ContractReady($path));
    },
    onFailure: function (Throwable $e) {
        Log::error('Contract PDF failed', ['error' => $e->getMessage()]);
    },
)->onQueue('pdf-generation');

Lógica de Retry

A configuração padrão de retry do Laravel é suportada:

php
GeneratePdfJob::dispatch(
    callback: fn (Document $pdf) => $pdf->addPage()->cell(0, 10, 'Retry demo'),
    outputPath: storage_path('reports/demo.pdf'),
)
->onQueue('pdf-generation')
->tries(3)
->backoff([10, 30, 60]);

Os valores padrão de retry podem ser definidos em config/tcpdf-next.php sob a chave queue.

Configuração de Conexão da Fila

Direcione jobs de PDF para uma conexão dedicada:

php
GeneratePdfJob::dispatch(
    callback: fn (Document $pdf) => $pdf->addPage()->cell(0, 10, 'Hello'),
    outputPath: storage_path('output.pdf'),
)
->onConnection('redis')
->onQueue('pdf-generation')
->afterCommit();

Geração de PDF em Lote

Use Bus::batch() para gerar múltiplos PDFs em paralelo:

php
use Illuminate\Support\Facades\Bus;

$jobs = $invoices->map(fn (Invoice $inv) =>
    new GeneratePdfJob(
        callback: function (Document $pdf) use ($inv) {
            $pdf->setTitle("Invoice #{$inv->number}")
                ->addPage()
                ->setFont('Helvetica', 'B', 14)
                ->cell(0, 10, "Invoice #{$inv->number}");
        },
        outputPath: "invoices/{$inv->number}.pdf",
        disk: 'local',
    )
);

Bus::batch($jobs)
    ->name('Monthly Invoice Batch')
    ->onQueue('pdf-generation')
    ->allowFailures()
    ->then(fn () => Notification::send($admin, new BatchComplete()))
    ->catch(fn () => Log::warning('Some invoice PDFs failed'))
    ->dispatch();

Próximos Passos

Distribuído sob a licença LGPL-3.0-or-later.