yaroslawww/laravel-pdf-builder

Wrapper for snappy and fpdi pdf generators.

2.1.1 2023-03-09 16:17 UTC

Requires

• php: ^8.1
• barryvdh/laravel-snappy: ^1.0
• illuminate/support: ^9.0|^10.0
• setasign/fpdf: ^1.8
• setasign/fpdi: ^2.3

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.14
• orchestra/testbench: ^8.0
• phpunit/phpunit: ^10.0
• psalm/plugin-laravel: ^2.8
• vimeo/psalm: ^5.7

MIT

• Yaroslav Georgitsa

• qrcode
• laravel

README

Wrapper for snappy and fpdi pdf generators. Allow quickly create different templates in laravel for MVP or production.

Installation

Install the package via composer:

composer require yaroslawww/laravel-pdf-builder

Optionally you can publish the config file with:

php artisan vendor:publish --provider="LPDFBuilder\ServiceProvider" --tag="config"

Usage

Using snappy html builder

<?php

use LPDFBuilder\Generation\AbstractDocumentFromHtml;

class UserCertificate extends AbstractDocumentFromHtml
{
    protected User $user;

    public function __construct(User $user)
    {
        $this->user = $user;
    }

    public function viewName(): string
    {
        return 'certificates.user.body';
    }

    public function headerViewName(): ?string
    {
        return 'certificates.layout.header';
    }

    public function footerViewName(): ?string
    {
        return 'certificates.layout.footer';
    }

    public function viewData(): array
    {
        return [ 'user' => $this->user, ];
    }
}

Using fpdi builder

Raw example

<?php

use LPDFBuilder\Generation\AbstractDocumentFromImage;

class UserCertificate extends AbstractDocumentFromImage
{
    protected User $user;

    public function __construct(User $user)
    {
        $this->user = $user;
    }

    protected function generate(): Fpdi
    {
        $pdf = new Fpdi();

        $pdf->SetAutoPageBreak(false);
        $pdf->AddPage('L', [85.6, 53]);

        $pdf->SetFont('Arial', 'B', 9);
        $pdf->SetTextColor(0, 0, 0);
        $pdf->SetXY(3, 2);
        $pdf->Cell(79.6, 3, 'Name:', 0, 1, 'L');

        $pdf->SetFont('Arial', 'B', 10);
        $pdf->SetTextColor(1, 67, 92);
        $pdf->SetXY(3, 6);
        $pdf->Cell(79.6, 3, Str::limit($this->user->name, 30, ''), 0, 1, 'C');

        return $pdf;
    }
}

From template

<?php

use LPDFBuilder\Generation\AbstractDocumentFromTemplate;

class UserCertificate extends AbstractDocumentFromTemplate
{
    protected ?string $sourceTemplateDisk = 'pfd_templates';
    protected ?string $sourceTemplateName = 'example.pdf';
    protected int $templatePageWidth      = 100;
    protected int $templatePageHeight     = 297;
    
    protected User $user;

    public function __construct(User $user)
    {
        $this->user = $user;
    }

    protected function applyContent(Fpdi $pdf, int $page = 1): Fpdi
    {
        $pdf->SetFont('Arial', 'B', 14);
        $pdf->SetTextColor(51, 51, 51);
        switch ($page) {
            case 1:
                $pdf->SetXY(5, 40);
                $pdf->Cell(90, 10, 'Test name', 0, 1, 'C');
                break;
            case 2:
                $pdf->SetXY(5, 40);
                $pdf->Cell(90, 10, 'Other page data', 0, 1, 'L');
                break;
        }
        
        return $pdf;
    }
}

Code usage

class CertificateController extends \App\Http\Controllers\Controller {

    function showCertificate(\Illuminate\Http\Request $request) {
        return (new UserCertificate($request->user))->inline();
    }
    
    function showCertificate(\Illuminate\Http\Request $request) {
        return (new UserCertificate($request->user))->download();
    }
  
    function saveCertificate(\Illuminate\Http\Request $request) {
        (new UserCertificate($request->user))->save();
        
        //...
    }
    
    function sendInMail(\Illuminate\Http\Request $request) {
        $message = (new MailMessage)
            ->subject('User certificate.')
            ->greeting('Hi!')
            ->greeting('Certificate created.')
            ->attach((new UserCertificate($request->user))->temporalFile());
        
        return $message;
    }
}

Credits

•