Skip to content

Tâches de file

La classe GeneratePdfJob fournit une tâche de file prête à l'emploi pour décharger la génération PDF vers des workers en arrière-plan. Elle accepte un callback de construction, écrit le résultat vers un chemin donné et supporte les hooks de succès/échec, la logique de relance et l'envoi par lots.

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

Envoi basique

Passez un callback qui reçoit un Document frais et un chemin de sortie :

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');

La tâche résout un Document depuis le conteneur, le passe à votre callback, puis écrit la sortie.

Paramètres du constructeur

ParamètreTypeDescription
callbackClosure(Document): voidConstructeur qui remplit le PDF
outputPathstringChemin de destination (absolu, ou relatif à la racine du disque)
disk?stringDisque de système de fichiers Laravel (défaut : null pour fichier local)
onSuccess?Closure(string): voidAppelé avec le chemin de sortie en cas de succès
onFailure?Closure(Throwable): voidAppelé avec l'exception en cas d'échec

Callbacks de succès et échec

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');

Logique de relance

La configuration de relance Laravel standard est supportée :

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]);

Les valeurs de relance par défaut peuvent être définies dans config/tcpdf-next.php sous la clé queue.

Configuration de connexion de file

Router les tâches PDF vers une connexion dédiée :

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

Génération PDF par lots

Utilisez Bus::batch() pour générer plusieurs PDF en parallèle :

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();

Prochaines étapes

  • Facade Pdf — Créer des documents utilisés par le callback de tâche
  • Réponses HTTP — Servir les PDF générés aux utilisateurs
  • Configuration — Connexion de file et valeurs par défaut de relance

Distribué sous licence LGPL-3.0-or-later.