Laravel PDF

https://spatie.be/docs/laravel-pdf/v2/
Admin
Laravel PDF is a package that provides a simple, driver-based way to create PDF files in Laravel...
Tokens:18,583
Snippets:290
Trust Score:9.9
Update:2 months ago
Show doc for...
Tokens:
Raw
### Install the PHP wrapper

Source: https://spatie.be/docs/laravel-pdf/v2/drivers/using-the-weasyprint-driver

Install the required PHP package via Composer.

```bash
composer require pontedilana/php-weasyprint
```

--------------------------------

### Install Chrome package

Source: https://spatie.be/docs/laravel-pdf/v2/drivers/using-the-chrome-driver

Install the required dependency via Composer.

```bash
composer require chrome-php/chrome
```

--------------------------------

### Install and Configure WeasyPrint Driver

Source: https://spatie.be/docs/laravel-pdf/v2/installation-setup

Install the PHP wrapper via Composer and set the driver in your .env file.

```bash
composer require pontedilana/php-weasyprint
```

```env
LARAVEL_PDF_DRIVER=weasyprint
```

--------------------------------

### Start Gotenberg instance

Source: https://spatie.be/docs/laravel-pdf/v2/requirements

Run a local Gotenberg instance using Docker.

```bash
docker run --rm -p 3000:3000 gotenberg/gotenberg:8
```

--------------------------------

### Install Browsershot driver

Source: https://spatie.be/docs/laravel-pdf/v2/installation-setup

Install the Browsershot package to enable the default PDF generation driver.

```bash
composer require spatie/browsershot
```

--------------------------------

### Start Gotenberg with Docker

Source: https://spatie.be/docs/laravel-pdf/v2/drivers/using-the-gotenberg-driver

Run a Gotenberg instance using the command line or docker-compose.

```bash
docker run --rm -p 3000:3000 gotenberg/gotenberg:8
```

```yaml
services:
  gotenberg:
    image: gotenberg/gotenberg:8
    ports:
      - "3000:3000"
```

--------------------------------

### Install and Configure DOMPDF Driver

Source: https://spatie.be/docs/laravel-pdf/v2/installation-setup

Install the DOMPDF package and set the driver in your .env file.

```bash
composer require dompdf/dompdf
```

```env
LARAVEL_PDF_DRIVER=dompdf
```

--------------------------------

### Install encryption dependency

Source: https://spatie.be/docs/laravel-pdf/v2/basic-usage/protecting-pdfs-with-a-password

Install the required package to enable PDF encryption features.

```bash
composer require tecnickcom/tc-lib-pdf-encrypt
```

--------------------------------

### Example Footer View CSS

Source: https://spatie.be/docs/laravel-pdf/v2/basic-usage/formatting-pdfs

CSS styling for a footer view template.

```css
footer {
    font-size: 12px;
}

  This is the footer
```

--------------------------------

### Install Laravel PDF package

Source: https://spatie.be/docs/laravel-pdf/v2/installation-setup

Use Composer to add the package to your Laravel project.

```bash
composer require spatie/laravel-pdf
```

--------------------------------

### Install DOMPDF driver dependency

Source: https://spatie.be/docs/laravel-pdf/v2/requirements

Install the required dompdf package for the DOMPDF driver.

```bash
composer require dompdf/dompdf
```

--------------------------------

### Pdf::assertBrowsershot()

Source: https://spatie.be/docs/laravel-pdf/v2/basic-usage/testing-pdfs

Verifies Browsershot configuration without starting Chrome.

```APIDOC
## Pdf::assertBrowsershot(callable $callback)

### Description
Verifies that the underlying Browsershot instance was configured correctly. The callback receives a `Spatie\Browsershot\Browsershot` instance.
```

--------------------------------

### Define Header or Footer HTML

Source: https://spatie.be/docs/laravel-pdf/v2/drivers/using-the-gotenberg-driver

Example of a complete HTML document structure required for Gotenberg headers and footers.

```html
<html>
<style>
p { font-size: 10px; }
</style>
<body>
    Page <span class="pageNumber"></span> of <span class="totalPages"></span>
</body>
</html>
```

--------------------------------

### Fake PDF generation in tests

Source: https://spatie.be/docs/laravel-pdf/v2/basic-usage/testing-pdfs

Call the fake method on the Pdf facade within a test setup to prevent actual PDF generation and improve test performance.

```php
// in your test

use Spatie\LaravelPdf\Facades\Pdf;

beforeEach(function () {
    Pdf::fake();
});
```

--------------------------------

### Configure WeasyPrint settings

Source: https://spatie.be/docs/laravel-pdf/v2/drivers/using-the-weasyprint-driver

Define the binary path and timeout in the configuration file.

```php
'weasyprint' => [
    'binary' => env('LARAVEL_PDF_WEASYPRINT_BINARY', 'weasyprint'),
    'timeout' => 10,
],
```

--------------------------------

### Configure the driver in .env

Source: https://spatie.be/docs/laravel-pdf/v2/drivers/using-the-weasyprint-driver

Set the PDF driver to WeasyPrint in your environment file.

```text
LARAVEL_PDF_DRIVER=weasyprint
```

--------------------------------

### Configuring Queue Settings

Source: https://spatie.be/docs/laravel-pdf/v2/basic-usage/queued-pdf-generation

Specify connection and queue details directly or via chained methods.

```php
Pdf::view('pdfs.invoice', $data)
    ->saveQueued('invoice.pdf', connection: 'redis', queue: 'pdfs');
```

```php
Pdf::view('pdfs.invoice', $data)
    ->saveQueued('invoice.pdf')
    ->onQueue('pdfs')
    ->onConnection('redis')
    ->delay(now()->addMinutes(5));
```

--------------------------------

### Configure Gotenberg Environment Variables

Source: https://spatie.be/docs/laravel-pdf/v2/drivers/using-the-gotenberg-driver

Set the driver and URL in your .env file to enable the Gotenberg driver.

```text
LARAVEL_PDF_DRIVER=gotenberg
GOTENBERG_URL=http://localhost:3000
```

--------------------------------

### Publish package configuration

Source: https://spatie.be/docs/laravel-pdf/v2/installation-setup

Run the artisan command to publish the package configuration file to your application.

```bash
php artisan vendor:publish --tag=pdf-config
```

--------------------------------

### Selecting a PDF Driver

Source: https://spatie.be/docs/laravel-pdf/v2/drivers/configuration

Set the driver option in the configuration file to choose the backend engine for PDF generation.

```php
'driver' => env('LARAVEL_PDF_DRIVER', 'browsershot'),
```

--------------------------------

### Configure Cloudflare driver environment variables

Source: https://spatie.be/docs/laravel-pdf/v2/drivers/using-the-cloudflare-driver

Add these credentials to your .env file to enable the Cloudflare driver.

```text
LARAVEL_PDF_DRIVER=cloudflare
CLOUDFLARE_API_TOKEN=your-api-token
CLOUDFLARE_ACCOUNT_ID=your-account-id
```

--------------------------------

### Configure Chrome driver environment variables

Source: https://spatie.be/docs/laravel-pdf/v2/drivers/using-the-chrome-driver

Set the driver and optional binary path in the .env file.

```bash
LARAVEL_PDF_DRIVER=chrome
```

```bash
LARAVEL_PDF_CHROME_BINARY=/usr/bin/google-chrome-stable
```

--------------------------------

### Configure global PDF defaults

Source: https://spatie.be/docs/laravel-pdf/v2/basic-usage/setting-defaults

Use the default method on the Pdf facade within a service provider's boot method to set application-wide PDF settings.

```php
use Spatie\LaravelPdf\Facades\Pdf;
use Spatie\LaravelPdf\Enums\Format;

// in a service provider

Pdf::default()
    ->headerView('pdf.header')
    ->format(Format::A3);
```

--------------------------------

### Environment Configuration

Source: https://spatie.be/docs/laravel-pdf/v2/drivers/configuration

Environment variables for configuring Browsershot, Cloudflare, Chrome, Gotenberg, WeasyPrint, and DOMPDF drivers.

```text
# Driver selection
LARAVEL_PDF_DRIVER=browsershot

# Browsershot settings
LARAVEL_PDF_NODE_BINARY=/usr/local/bin/node
LARAVEL_PDF_NPM_BINARY=/usr/local/bin/npm
LARAVEL_PDF_INCLUDE_PATH=/usr/local/bin
LARAVEL_PDF_CHROME_PATH=/usr/bin/google-chrome-stable
LARAVEL_PDF_NODE_MODULES_PATH=/path/to/node_modules
LARAVEL_PDF_BIN_PATH=/usr/local/bin
LARAVEL_PDF_TEMP_PATH=/tmp
LARAVEL_PDF_WRITE_OPTIONS_TO_FILE=true
LARAVEL_PDF_NO_SANDBOX=true

# Cloudflare settings
CLOUDFLARE_API_TOKEN=your-api-token
CLOUDFLARE_ACCOUNT_ID=your-account-id

# Chrome driver settings
LARAVEL_PDF_CHROME_BINARY=/usr/bin/google-chrome-stable
LARAVEL_PDF_CHROME_NO_SANDBOX=false
LARAVEL_PDF_CHROME_STARTUP_TIMEOUT=30
LARAVEL_PDF_CHROME_TIMEOUT=30000
LARAVEL_PDF_CHROME_OPERATION_TIMEOUT=5000
LARAVEL_PDF_CHROME_USER_DATA_DIR=/tmp/chrome-profile

# Gotenberg settings
GOTENBERG_URL=http://localhost:3000

# WeasyPrint settings
LARAVEL_PDF_WEASYPRINT_BINARY=/usr/local/bin/weasyprint

# DOMPDF settings
LARAVEL_PDF_DOMPDF_REMOTE_ENABLED=false
LARAVEL_PDF_DOMPDF_CHROOT=/path/to/chroot
```

--------------------------------

### Waiting for the readiness flag

Source: https://spatie.be/docs/laravel-pdf/v2/advanced-usage/waiting-for-readiness

Use the waitUntilReady method on the Pdf builder to pause capture until the window.pdfReady flag is true.

```php
use Spatie\LaravelPdf\Facades\Pdf;

Pdf::view('pdf.report', ['report' => $report])
    ->waitUntilReady()
    ->save('report.pdf');
```

--------------------------------

### Download PDF from Controller

Source: https://spatie.be/docs/laravel-pdf/v2/advanced-usage/using-tailwind

Use the pdf helper function to render a view as a PDF and trigger a download response.

```php
namespace App\Http\Controllers;

use function Spatie\LaravelPdf\Support\pdf;

class DownloadInvoiceController
{
    public function __invoke()
    {
        return pdf('pdf.invoice', [
            'invoiceNumber' => '1234',
            'customerName' => 'Grumpy Cat',
        ]);
    }
}
```

--------------------------------

### Queue PDF generation

Source: https://spatie.be/docs/laravel-pdf/v2/introduction

Generate a PDF in the background and execute a callback upon completion.

```php
use Spatie\LaravelPdf\Facades\Pdf;

Pdf::view('pdfs.invoice', ['invoice' => $invoice])
    ->format('a4')
    ->saveQueued('invoice.pdf')
    ->then(fn (string $path, ?string $diskName) => Mail::to($user)->send(new InvoiceMail($path)));
```

--------------------------------

### Assert Browsershot configuration

Source: https://spatie.be/docs/laravel-pdf/v2/basic-usage/testing-pdfs

Verify Browsershot customizations applied via withBrowsershot without launching Chrome. Use the invade helper to access protected properties if necessary.

```php
use Spatie\Browsershot\Browsershot;
use Spatie\LaravelPdf\Facades\Pdf;

Pdf::view('invoice')
    ->withBrowsershot(function (Browsershot $browsershot) {
        $browsershot->setRemoteInstance('127.0.0.1', 9222);
    })
    ->save('invoice.pdf');

Pdf::assertBrowsershot(function (Browsershot $browsershot) {
    return invade($browsershot)->additionalOptions['remoteInstanceUrl'] === 'http://127.0.0.1:9222';
});
```

--------------------------------

### Using a custom macro

Source: https://spatie.be/docs/laravel-pdf/v2/advanced-usage/extending-with-macros

Invoke the newly defined macro as a method on the Pdf facade.

```php
use Spatie\LaravelPdf\Facades\Pdf;

Pdf::view('invoice')
    ->withCustomHeader('Invoice #123')
    ->save('invoice.pdf');
```

--------------------------------

### Configure a custom encrypter

Source: https://spatie.be/docs/laravel-pdf/v2/basic-usage/protecting-pdfs-with-a-password

Register a custom encryption class in the configuration file and implement the required contract.

```php
// config/laravel-pdf.php

'encrypter' => App\\\Pdf\\\MyEncrypter::class,
```

```php
namespace App\\\Pdf;

use Spatie\\\LaravelPdf\\\Encryption\\\PdfEncrypter;
use Spatie\\\LaravelPdf\\\Encryption\\\PdfEncryption;

class MyEncrypter implements PdfEncrypter
{
    public function encrypt(string $pdf, PdfEncryption $encryption): string
    {
        // return the encrypted PDF
    }

    public function decrypt(string $pdf, string $password): string
    {
        // return the decrypted PDF
    }
}
```

--------------------------------

### Configure Browsershot driver

Source: https://spatie.be/docs/laravel-pdf/v2/drivers/configuration

Defines paths and operational settings for the Browsershot driver.

```php
'browsershot' => [
    'node_binary' => env('LARAVEL_PDF_NODE_BINARY'),
    'npm_binary' => env('LARAVEL_PDF_NPM_BINARY'),
    'include_path' => env('LARAVEL_PDF_INCLUDE_PATH'),
    'chrome_path' => env('LARAVEL_PDF_CHROME_PATH'),
    'node_modules_path' => env('LARAVEL_PDF_NODE_MODULES_PATH'),
    'bin_path' => env('LARAVEL_PDF_BIN_PATH'),
    'temp_path' => env('LARAVEL_PDF_TEMP_PATH'),
    'write_options_to_file' => env('LARAVEL_PDF_WRITE_OPTIONS_TO_FILE', true),
    'no_sandbox' => env('LARAVEL_PDF_NO_SANDBOX', false),
],
```

--------------------------------

### Configure Page Margins

Source: https://spatie.be/docs/laravel-pdf/v2/basic-usage/formatting-pdfs

Set margins in millimeters by default, or specify a custom unit using the fifth parameter.

```php
use Spatie\LaravelPdf\Facades\Pdf;

Pdf::view('pdf.invoice', ['invoice' => $invoice])
    ->margins($top, $right, $bottom, $left)
    ->save('/some/directory/invoice-april-2022.pdf');
```

```php
use Spatie\LaravelPdf\Facades\Pdf;
use Spatie\LaravelPdf\Enums\Unit;

Pdf::view('pdf.invoice', ['invoice' => $invoice])
    ->margins($top, $right, $bottom, $left, Unit::Pixel)
    ->save('/some/directory/invoice-april-2022.pdf');
```

--------------------------------

### Configure DOMPDF driver

Source: https://spatie.be/docs/laravel-pdf/v2/drivers/using-the-dompdf-driver

Set the driver in the .env file to enable DOMPDF.

```text
LARAVEL_PDF_DRIVER=dompdf
```

--------------------------------

### Use a custom driver

Source: https://spatie.be/docs/laravel-pdf/v2/drivers/custom-drivers

Apply the registered driver to a specific PDF generation task or set it as the default driver.

```php
use Spatie\LaravelPdf\Facades\Pdf;

Pdf::view('pdfs.invoice', ['invoice' => $invoice])
    ->driver('weasyprint')
    ->save('invoice.pdf');
```

```php
use App\Pdf\Drivers\WeasyPrintDriver;
use Spatie\LaravelPdf\Drivers\PdfDriver;

$this->app->singleton(PdfDriver::class, function () {
    return new WeasyPrintDriver(config('laravel-pdf.weasyprint', []));
});
```

--------------------------------

### Runtime Driver Switching

Source: https://spatie.be/docs/laravel-pdf/v2/drivers/configuration

Switch between configured PDF drivers on a per-PDF basis using the driver method.

```php
use Spatie\LaravelPdf\Facades\Pdf;

// Use the Cloudflare driver for this specific PDF
Pdf::view('invoice', $data)
    ->driver('cloudflare')
    ->save('invoice.pdf');

// Use the default driver from config
Pdf::view('invoice', $data)
    ->save('invoice.pdf');
```

--------------------------------

### Implement custom cache contract

Source: https://spatie.be/docs/laravel-pdf/v2/advanced-usage/caching-pdfs

Create a class implementing the PdfCache contract to define custom storage or expiration logic.

```php
namespace App\Support;

use Closure;
use Spatie\LaravelPdf\Caching\PdfCache;

class MyPdfCache implements PdfCache
{
    public function remember(string $fingerprint, ?string $key, ?int $ttl, Closure $generate): string
    {
        // Return the cached PDF content, generating and storing it when needed.
    }
}
```

```php
'cache' => [
    'class' => App\Support\MyPdfCache::class,
],
```

--------------------------------

### Configure Chrome driver in .env

Source: https://spatie.be/docs/laravel-pdf/v2/installation-setup

Set the driver environment variable to enable the Chrome driver.

```text
LARAVEL_PDF_DRIVER=chrome
```

--------------------------------

### Return a PDF response in a controller

Source: https://spatie.be/docs/laravel-pdf/v2/basic-usage/responding-with-pdfs

Use the pdf() helper to render a view as a PDF. By default, the PDF is displayed inline in the browser.

```php
use function Spatie\LaravelPdf\Support\pdf;

class DownloadInvoiceController
{
    public function __invoke(Invoice $invoice)
    {
        return pdf()
            ->view('pdf.invoice', compact('invoice'))
            ->name('invoice-2023-04-10.pdf');
    }
}
```

--------------------------------

### Generate PDF with Gotenberg

Source: https://spatie.be/docs/laravel-pdf/v2/drivers/using-the-gotenberg-driver

Standard usage of the Pdf facade after configuring the Gotenberg driver.

```php
use Spatie\LaravelPdf\Facades\Pdf;

Pdf::view('pdfs.invoice', ['invoice' => $invoice])
    ->format('a4')
    ->save('invoice.pdf');
```

--------------------------------

### Global Browsershot Configuration

Source: https://spatie.be/docs/laravel-pdf/v2/drivers/customizing-browsershot

Set default Chrome arguments globally within a service provider to handle local assets or bypass security restrictions.

```php
// typically, in a service provider

Pdf::default()->withBrowsershot(function (Browsershot $browsershot) {
    $browsershot->setOption('args', [
        '--disable-web-security',
        '--allow-file-access-from-files',
    ]);
});
```

--------------------------------

### Signalling readiness in JavaScript

Source: https://spatie.be/docs/laravel-pdf/v2/advanced-usage/waiting-for-readiness

Set the window.pdfReady flag to true once your asynchronous content or charts have finished rendering.

```javascript
    renderChart('#chart').then(() => {
        window.pdfReady = true;
    });
```

--------------------------------

### Configure automatic PDF caching

Source: https://spatie.be/docs/laravel-pdf/v2/advanced-usage/caching-pdfs

Enable automatic caching globally via the configuration file or environment variables.

```php
'cache' => [
    'automatic' => env('LARAVEL_PDF_CACHE_AUTOMATIC', true),
],
```

--------------------------------

### Rendering a PDF with a footer

Source: https://spatie.be/docs/laravel-pdf/v2/advanced-usage/creating-pdfs-with-multiple-pages

Pass the footer view to the footerView method. Note that this requires specific drivers like Browsershot, Cloudflare, or Chrome.

```php
Pdf::view('view-with-multiple-pages')->footerView('footer-view')->save($path);
```

--------------------------------

### Basic Queued PDF Generation

Source: https://spatie.be/docs/laravel-pdf/v2/basic-usage/queued-pdf-generation

Dispatches a PDF generation job to the background queue after rendering the view.

```php
use Spatie\LaravelPdf\Facades\Pdf;

Pdf::view('pdfs.invoice', ['invoice' => $invoice])
    ->format('a4')
    ->saveQueued('invoice.pdf');
```

--------------------------------

### Wait for Readiness Signal

Source: https://spatie.be/docs/laravel-pdf/v2/drivers/using-the-gotenberg-driver

Defer PDF capture until a JavaScript readiness signal is triggered.

```php
use Spatie\LaravelPdf\Facades\Pdf;

Pdf::view('pdfs.report', ['report' => $report])
    ->waitUntilReady()
    ->save('report.pdf');
```

--------------------------------

### Implement the PdfDriver interface

Source: https://spatie.be/docs/laravel-pdf/v2/drivers/custom-drivers

Create a custom driver class by implementing the PdfDriver interface and defining the generatePdf and savePdf methods.

```php
namespace App\Pdf\Drivers;

use Spatie\LaravelPdf\Drivers\PdfDriver;
use Spatie\LaravelPdf\PdfOptions;

class WeasyPrintDriver implements PdfDriver
{
    public function __construct(protected array $config = [])
    {
    }

    public function generatePdf(
        string $html,
        ?string $headerHtml,
        ?string $footerHtml,
        PdfOptions $options,
    ): string {
        // Generate and return the PDF content as a string
    }

    public function savePdf(
        string $html,
        ?string $headerHtml,
        ?string $footerHtml,
        PdfOptions $options,
        string $path,
    ): void {
        // Generate the PDF and save it to the given path
    }
}
```

--------------------------------

### Using a custom readiness expression

Source: https://spatie.be/docs/laravel-pdf/v2/advanced-usage/waiting-for-readiness

Pass a custom JavaScript expression to waitUntilReady to define specific conditions for readiness.

```php
Pdf::view('pdf.report')
    ->waitUntilReady('window.charts.every(chart => chart.rendered)')
    ->save('report.pdf');
```

--------------------------------

### Handling Queued PDF Callbacks

Source: https://spatie.be/docs/laravel-pdf/v2/basic-usage/queued-pdf-generation

React to job completion or failure using then() and catch() methods.

```php
Pdf::view('pdfs.invoice', ['invoice' => $invoice])
    ->saveQueued('invoice.pdf')
    ->then(fn (string $path, ?string $diskName) => Mail::to($user)->send(new InvoiceMail($path)))
    ->catch(fn (Throwable $e) => Log::error('PDF generation failed', ['error' => $e->getMessage()]));
```

```php
->then(function (string $path, ?string $diskName) {
    $contents = $diskName
        ? Storage::disk($diskName)->get($path)
        : file_get_contents($path);
})
```

--------------------------------

### Set Lambda as Default Driver

Source: https://spatie.be/docs/laravel-pdf/v2/drivers/generating-pdfs-on-aws-lambda

Configure the PDF driver to use Lambda by default within a service provider.

```php
// typically, in a service provider

Pdf::default()->onLambda();
```

--------------------------------

### Configure Cloudflare Browser Rendering API

Source: https://spatie.be/docs/laravel-pdf/v2/drivers/configuration

Sets the API credentials required for Cloudflare browser rendering.

```php
'cloudflare' => [
    'api_token' => env('CLOUDFLARE_API_TOKEN'),
    'account_id' => env('CLOUDFLARE_ACCOUNT_ID'),
],
```

--------------------------------

### Test PDF generation

Source: https://spatie.be/docs/laravel-pdf/v2/introduction

Use the built-in testing helpers to fake PDF generation and assert responses.

```php
use Spatie\LaravelPdf\Facades\Pdf;

it('can render an invoice', function () {
    Pdf::fake();

    $invoice = Invoice::factory()->create();

    $this->get(route('download-invoice', $invoice))
        ->assertOk();

    Pdf::assertRespondedWithPdf(function (PdfBuilder $pdf) {
        return $pdf->contains('test');
    });
});
```

--------------------------------

### Return a PDF as a controller response

Source: https://spatie.be/docs/laravel-pdf/v2/introduction

Return a generated PDF directly from a controller method.

```php
use Spatie\LaravelPdf\Facades\Pdf;

class DownloadInvoiceController
{
    public function __invoke(Invoice $invoice)
    {
        return Pdf::view('pdfs.invoice', ['invoice' => $invoice])
            ->format('a4')
            ->name('your-invoice.pdf');
    }
}
```

--------------------------------

### Chrome driver configuration

Source: https://spatie.be/docs/laravel-pdf/v2/drivers/using-the-chrome-driver

Configuration array for config/laravel-pdf.php to customize Chrome driver behavior.

```php
'chrome' => [
    'chrome_binary' => env('LARAVEL_PDF_CHROME_BINARY'),
    'no_sandbox' => env('LARAVEL_PDF_CHROME_NO_SANDBOX', false),
    'startup_timeout' => env('LARAVEL_PDF_CHROME_STARTUP_TIMEOUT', 30),
    'timeout' => env('LARAVEL_PDF_CHROME_TIMEOUT', 30000),
    'operation_timeout' => env('LARAVEL_PDF_CHROME_OPERATION_TIMEOUT', 5000),
    'user_data_dir' => env('LARAVEL_PDF_CHROME_USER_DATA_DIR'),
    'custom_flags' => [],
    'env_variables' => [],
],
```

--------------------------------

### Configure cache settings

Source: https://spatie.be/docs/laravel-pdf/v2/advanced-usage/caching-pdfs

Define cache behavior including store, prefix, and TTL in the laravel-pdf configuration file.

```php
'cache' => [
    'class' => Spatie\LaravelPdf\Caching\DefaultPdfCache::class,
    'automatic' => env('LARAVEL_PDF_CACHE_AUTOMATIC', false),
    'store' => env('LARAVEL_PDF_CACHE_STORE'),
    'prefix' => 'laravel-pdf',
    'ttl' => env('LARAVEL_PDF_CACHE_TTL', 60 * 60 * 24),
],
```

--------------------------------

### Force a PDF download

Source: https://spatie.be/docs/laravel-pdf/v2/basic-usage/responding-with-pdfs

Chain the download() method to the pdf() helper to force the browser to download the generated PDF file.

```php
use function Spatie\LaravelPdf\Support\pdf;

class DownloadInvoiceController
{
    public function __invoke(Invoice $invoice)
    {
        return pdf()
            ->view('pdf.invoice', compact('invoice'))
            ->name('invoice-2023-04-10.pdf')
            ->download();
    }
}
```

--------------------------------

### Configuring PDF Backgrounds

Source: https://spatie.be/docs/laravel-pdf/v2/basic-usage/formatting-pdfs

Control background rendering using CSS print-color-adjust or the Browsershot transparentBackground method.

```css
    html {
        -webkit-print-color-adjust: exact;
    }
```

```php
Pdf::view('test')
    ->withBrowsershot(function (Browsershot $browsershot) {
        $browsershot->transparentBackground();
    })
    ->save($this->targetPath);
```

--------------------------------

### Assert PDF View

Source: https://spatie.be/docs/laravel-pdf/v2/basic-usage/testing-pdfs

Verify that a PDF was generated using a specific view.

```php
Pdf::assertViewIs('pdf.invoice');
```

--------------------------------

### Testing Queued PDFs

Source: https://spatie.be/docs/laravel-pdf/v2/basic-usage/queued-pdf-generation

Use Pdf::fake() to assert that PDF generation jobs were queued correctly.

```php
use Spatie\LaravelPdf\Facades\Pdf;
use Spatie\LaravelPdf\PdfBuilder;

Pdf::fake();

// ... your code that queues a PDF ...

Pdf::assertQueued('invoice.pdf');

// Or use a callable for more detailed assertions:
Pdf::assertQueued(function (PdfBuilder $pdf, string $path) {
    return $path === 'invoice.pdf' && $pdf->contains('Total');
});

// Assert nothing was queued:
Pdf::assertNotQueued();

// Assert a specific path was not queued:
Pdf::assertNotQueued('other.pdf');
```

--------------------------------

### Package configuration file content

Source: https://spatie.be/docs/laravel-pdf/v2/installation-setup

The default configuration structure for the Laravel PDF package, including settings for Browsershot, Cloudflare, Dompdf, Weasyprint, and Chrome.

```php
return [
    'driver' => env('LARAVEL_PDF_DRIVER', 'browsershot'),

    'browsershot' => [
        'node_binary' => env('LARAVEL_PDF_NODE_BINARY'),
        'npm_binary' => env('LARAVEL_PDF_NPM_BINARY'),
        'include_path' => env('LARAVEL_PDF_INCLUDE_PATH'),
        'chrome_path' => env('LARAVEL_PDF_CHROME_PATH'),
        'node_modules_path' => env('LARAVEL_PDF_NODE_MODULES_PATH'),
        'bin_path' => env('LARAVEL_PDF_BIN_PATH'),
        'temp_path' => env('LARAVEL_PDF_TEMP_PATH'),
        'write_options_to_file' => env('LARAVEL_PDF_WRITE_OPTIONS_TO_FILE', false),
        'no_sandbox' => env('LARAVEL_PDF_NO_SANDBOX', false),
    ],

    'cloudflare' => [
        'api_token' => env('CLOUDFLARE_API_TOKEN'),
        'account_id' => env('CLOUDFLARE_ACCOUNT_ID'),
    ],

    'dompdf' => [
        'is_remote_enabled' => env('LARAVEL_PDF_DOMPDF_REMOTE_ENABLED', false),
        'chroot' => env('LARAVEL_PDF_DOMPDF_CHROOT'),
    ],

    'weasyprint' => [
        'binary' => env('LARAVEL_PDF_WEASYPRINT_BINARY', 'weasyprint'),
        'timeout' => 10,
    ],

    'chrome' => [
        'chrome_binary' => env('LARAVEL_PDF_CHROME_BINARY'),
        'no_sandbox' => env('LARAVEL_PDF_CHROME_NO_SANDBOX', false),
        'startup_timeout' => env('LARAVEL_PDF_CHROME_STARTUP_TIMEOUT', 30),
        'timeout' => env('LARAVEL_PDF_CHROME_TIMEOUT', 30000),
        'operation_timeout' => env('LARAVEL_PDF_CHROME_OPERATION_TIMEOUT', 5000),
        'user_data_dir' => env('LARAVEL_PDF_CHROME_USER_DATA_DIR'),
        'custom_flags' => [],
        'env_variables' => [],
    ],
];
```

--------------------------------

### Set PDF Header and Footer with HTML strings

Source: https://spatie.be/docs/laravel-pdf/v2/basic-usage/formatting-pdfs

Use headerHtml and footerHtml to pass raw HTML strings directly for headers and footers.

```php
use Spatie\LaravelPdf\Facades\Pdf;

Pdf::view('pdf.invoice', ['invoice' => $invoice])
    ->headerHtml('My header')
    ->footerHtml('My footer')
    ->save('/some/directory/invoice-april-2022.pdf');
```

--------------------------------

### Align Header and Footer with Content

Source: https://spatie.be/docs/laravel-pdf/v2/basic-usage/formatting-pdfs

Apply padding to the body to align headers and footers with the main content margins.

```css
    body {
        margin: 0;
        padding: 0 0.39in;
    }
```

--------------------------------

### Encrypt a PDF with owner password and permissions

Source: https://spatie.be/docs/laravel-pdf/v2/basic-usage/protecting-pdfs-with-a-password

Set an owner password and restrict specific document actions like printing or copying.

```php
use Spatie\\\LaravelPdf\\\Enums\\\Permission;
use Spatie\\\LaravelPdf\\\Facades\\\Pdf;

Pdf::view('pdf.invoice', ['invoice' => $invoice])
    ->encrypt(
        userPassword: 'open-sesame',
        ownerPassword: 'owner-secret',
        permissions: [Permission::Print, Permission::Copy],
    )
    ->save('/some/directory/invoice.pdf');
```

--------------------------------

### Assert Queued PDF

Source: https://spatie.be/docs/laravel-pdf/v2/basic-usage/testing-pdfs

Verify that a PDF was queued for generation, optionally using a callable for complex assertions.

```php
Pdf::assertQueued('invoice.pdf');
```

```php
use Spatie\LaravelPdf\PdfBuilder;

Pdf::assertQueued(function (PdfBuilder $pdf, string $path) {
    return $path === 'invoice.pdf' && $pdf->contains('Total');
});
```

--------------------------------

### Assert PDF response

Source: https://spatie.be/docs/laravel-pdf/v2/basic-usage/testing-pdfs

Verify that a PDF was generated and returned as a download response in a route.

```php
use Spatie\LaravelPdf\Facades\Pdf;

Route::get('download-invoice', function () {
    return pdf('pdf.invoice')->download('invoice-for-april-2022.pdf');
});
```

```php
use Spatie\LaravelPdf\Facades\Pdf;
use Spatie\LaravelPdf\PdfBuilder;

it('can download an invoice', function () {
    $this
        ->get('download-invoice')
        ->assertOk();

    Pdf::assertRespondedWithPdf(function (PdfBuilder $pdf) {
        return $pdf->downloadName === 'invoice-for-april-2022.pdf'
            && $pdf->isDownload()
            && str_contains($pdf->html, 'Your total for April is $10.00');
    });
});
```

--------------------------------

### Cache PDF with Browsershot customization

Source: https://spatie.be/docs/laravel-pdf/v2/advanced-usage/caching-pdfs

Provide an explicit cache key when using withBrowsershot to ensure uniqueness.

```php
Pdf::view('pdf.invoice', ['invoice' => $invoice])
    ->withBrowsershot(fn ($browsershot) => $browsershot->setRemoteInstance('127.0.0.1', 9222))
    ->cache(key: "invoice-{$invoice->id}")
    ->save('invoice.pdf');
```

--------------------------------

### Generate PDF using the default Cloudflare driver

Source: https://spatie.be/docs/laravel-pdf/v2/drivers/using-the-cloudflare-driver

Once configured globally, existing PDF generation code will automatically use the Cloudflare driver.

```php
use Spatie\LaravelPdf\Facades\Pdf;

// This will use Cloudflare — no code changes needed
Pdf::view('pdfs.invoice', ['invoice' => $invoice])
    ->format('a4')
    ->save('invoice.pdf');
```

--------------------------------

### Generate PDF on AWS Lambda

Source: https://spatie.be/docs/laravel-pdf/v2/drivers/generating-pdfs-on-aws-lambda

Use the onLambda method to execute PDF generation via AWS Lambda.

```php
Pdf::view('pdf.invoice', $data)
    ->onLambda()
    ->save('invoice.pdf');
```

--------------------------------

### Saving a PDF to an S3 disk

Source: https://spatie.be/docs/laravel-pdf/v2/basic-usage/saving-pdfs-to-disks

Use the disk() method to specify the target filesystem disk before calling save().

```php
use Spatie\LaravelPdf\Facades\Pdf;

Pdf::view('invoice')
   ->disk('s3')
   ->save('invoice-april-2022.pdf');
```

--------------------------------

### Assert PDF Not Queued

Source: https://spatie.be/docs/laravel-pdf/v2/basic-usage/testing-pdfs

Verify that no PDFs or a specific PDF path were not queued.

```php
// Assert nothing was queued
Pdf::assertNotQueued();

// Assert a specific path was not queued
Pdf::assertNotQueued('other.pdf');
```

--------------------------------

### Select Page Ranges

Source: https://spatie.be/docs/laravel-pdf/v2/basic-usage/formatting-pdfs

Specify which pages to include in the output. This is not supported by the DOMPDF driver.

```php
use Spatie\LaravelPdf\Facades\Pdf;

Pdf::view('pdf.report', ['report' => $report])
    ->pageRanges('1-3, 5')
    ->save('/some/directory/report.pdf');
```

--------------------------------

### Configure Margins for Header and Footer

Source: https://spatie.be/docs/laravel-pdf/v2/basic-usage/formatting-pdfs

Adjust top and bottom margins to ensure headers and footers do not overlap main content.

```php
use Spatie\LaravelPdf\Enums\Unit;

Pdf::view('pdf.invoice', $data)
    ->margins(0.9, 0.39, 0.6, 0.39, Unit::Inch)
    ->headerView('pdf.header', $data)
    ->footerView('pdf.footer', $data)
    ->save('/some/directory/invoice.pdf');
```

--------------------------------

### Generate PDF from HTML String

Source: https://spatie.be/docs/laravel-pdf/v2/basic-usage/creating-pdfs

Use the Pdf::html method to convert a raw string of HTML into a PDF file.

```php
use Spatie\LaravelPdf\Facades\Pdf;

Pdf::html('Hello world!!')->save('/some/directory/invoice.pdf');
```

--------------------------------

### Register a custom driver

Source: https://spatie.be/docs/laravel-pdf/v2/drivers/custom-drivers

Register the custom driver as a singleton within a Laravel service provider.

```php
namespace App\Providers;

use App\Pdf\Drivers\WeasyPrintDriver;
use Illuminate\Support\ServiceProvider;

class PdfServiceProvider extends ServiceProvider
{
    public function register(): void
    {
        $this->app->singleton('laravel-pdf.driver.weasyprint', function () {
            return new WeasyPrintDriver(config('laravel-pdf.weasyprint', []));
        });
    }
}
```

--------------------------------

### Configure Gotenberg API URL

Source: https://spatie.be/docs/laravel-pdf/v2/drivers/configuration

Sets the base URL for the Gotenberg service.

```php
'gotenberg' => [
    'url' => env('GOTENBERG_URL', 'http://localhost:3000'),
],
```

--------------------------------

### Save a PDF from a Blade view

Source: https://spatie.be/docs/laravel-pdf/v2/introduction

Render a Blade view and save the output as a PDF file.

```php
use Spatie\LaravelPdf\Facades\Pdf;

Pdf::view('pdfs.invoice', ['invoice' => $invoice])
    ->format('a4')
    ->save('invoice.pdf')
```

--------------------------------

### Set PDF Metadata

Source: https://spatie.be/docs/laravel-pdf/v2/basic-usage/formatting-pdfs

Define document properties like title, author, and creation date. Metadata is supported by all drivers.

```php
use Spatie\LaravelPdf\Facades\Pdf;

Pdf::view('pdf.invoice', ['invoice' => $invoice])
    ->meta(
        title: 'Invoice #123',
        author: 'Acme Corp',
        subject: 'Monthly invoice',
        keywords: 'invoice, acme, april',
        creator: 'My Application',
    )
    ->save('/some/directory/invoice.pdf');
```

```php
use Spatie\LaravelPdf\Facades\Pdf;

Pdf::view('pdf.invoice', ['invoice' => $invoice])
    ->meta(title: 'Invoice #123', creationDate: now())
    ->save('/some/directory/invoice.pdf');
```

--------------------------------

### Debugging PDF Builder

Source: https://spatie.be/docs/laravel-pdf/v2/basic-usage/formatting-pdfs

Inspect the current state of the PDF builder by calling dump or dd during the chain.

```php
use Spatie\LaravelPdf\Facades\Pdf;

Pdf::view('pdf.invoice', ['invoice' => $invoice])
    ->format('a4')
    ->landscape()
    ->dump() // dumps the builder state and continues
    ->save('/some/directory/invoice.pdf');
```

--------------------------------

### Assert PDF Saved Path

Source: https://spatie.be/docs/laravel-pdf/v2/basic-usage/testing-pdfs

Verify that a PDF was saved to the expected storage path.

```php
Pdf::assertSaved(storage_path('invoices/invoice.pdf'));
```

--------------------------------

### Use WeasyPrint for a specific PDF

Source: https://spatie.be/docs/laravel-pdf/v2/drivers/using-the-weasyprint-driver

Override the default driver for a single PDF generation call.

```php
use Spatie\LaravelPdf\Facades\Pdf;

Pdf::view('pdfs.invoice', ['invoice' => $invoice])
    ->driver('weasyprint')
    ->format('a4')
    ->save('invoice.pdf');
```

--------------------------------

### Adding a custom macro to PdfBuilder

Source: https://spatie.be/docs/laravel-pdf/v2/advanced-usage/extending-with-macros

Register custom methods on the PdfBuilder class within the boot method of a service provider.

```php
use Spatie\LaravelPdf\PdfBuilder;

class AppServiceProvider extends ServiceProvider
{
    public function boot()
    {
        PdfBuilder::macro('withCustomHeader', function (string $title) {
            $this->headerHtml = "{$title}";

            return $this;
        });
    }
}
```

--------------------------------

### Calculate Header and Footer Width

Source: https://spatie.be/docs/laravel-pdf/v2/basic-usage/formatting-pdfs

Use calc to adjust width for headers and footers to prevent overflow.

```css
.header {
    width: calc(100% - 0.78in); /* left margin plus right margin */
}
```

--------------------------------

### Pdf::fake()

Source: https://spatie.be/docs/laravel-pdf/v2/basic-usage/testing-pdfs

Fakes the PDF generation process to speed up tests.

```APIDOC
## Pdf::fake()

### Description
Call this method to fake PDF generation in your tests. This prevents actual PDF generation and allows for assertions on the PDF builder instance.

### Usage
```php
use Spatie\LaravelPdf\Facades\Pdf;

beforeEach(function () {
    Pdf::fake();
});
```
```

--------------------------------

### Saving Queued PDFs to Disk

Source: https://spatie.be/docs/laravel-pdf/v2/basic-usage/queued-pdf-generation

Save generated PDFs to a specific storage disk.

```php
Pdf::view('pdfs.invoice', $data)
    ->disk('s3')
    ->saveQueued('invoices/invoice.pdf')
    ->then(function (string $path, ?string $diskName) {
        $url = Storage::disk($diskName)->url($path);
        // ...
    });
```

--------------------------------

### Customizing the PDF Job Class

Source: https://spatie.be/docs/laravel-pdf/v2/basic-usage/queued-pdf-generation

Override the default job class in configuration and extend it to customize job behavior.

```php
'job' => \App\Jobs\GeneratePdfJob::class,
```

```php
namespace App\Jobs;

use Spatie\LaravelPdf\Jobs\GeneratePdfJob as BaseJob;

class GeneratePdfJob extends BaseJob
{
    public int $tries = 3;

    public int $timeout = 120;

    public int $backoff = 30;
}
```

--------------------------------

### Pdf::assertRespondedWithPdf()

Source: https://spatie.be/docs/laravel-pdf/v2/basic-usage/testing-pdfs

Asserts that a PDF was generated and returned as a response.

```APIDOC
## Pdf::assertRespondedWithPdf(callable $callback)

### Description
Asserts that a PDF was generated and returned as a download response. The callback receives the `PdfBuilder` instance to verify properties like download name or content.
```

--------------------------------

### Set PDF Header and Footer with Views

Source: https://spatie.be/docs/laravel-pdf/v2/basic-usage/formatting-pdfs

Use headerView and footerView to define custom Blade templates for PDF headers and footers.

```php
use Spatie\LaravelPdf\Facades\Pdf;

Pdf::view('pdf.invoice', ['invoice' => $invoice])
    ->headerView('pdf.invoice.header')
    ->footerView('pdf.invoice.footer')
    ->save('/some/directory/invoice-april-2022.pdf');
```

--------------------------------

### Generate PDF from Blade View

Source: https://spatie.be/docs/laravel-pdf/v2/basic-usage/creating-pdfs

Use the Pdf::view method to render a Blade template directly to a PDF file.

```php
use Spatie\LaravelPdf\Facades\Pdf;

Pdf::view('pdf.invoice')->save('/some/directory/invoice.pdf');
```

```php
use Spatie\LaravelPdf\Facades\Pdf;

Pdf::view('pdf.invoice', ['invoice' => $invoice])
    ->save('/some/directory/invoice.pdf');
```

--------------------------------

### Use Cloudflare driver for a specific PDF

Source: https://spatie.be/docs/laravel-pdf/v2/drivers/using-the-cloudflare-driver

Override the default driver for a single request by chaining the driver method.

```php
use Spatie\LaravelPdf\Facades\Pdf;

Pdf::view('pdfs.invoice', ['invoice' => $invoice])
    ->driver('cloudflare')
    ->format('a4')
    ->save('invoice.pdf');
```

--------------------------------

### Set PDF Paper Format

Source: https://spatie.be/docs/laravel-pdf/v2/basic-usage/formatting-pdfs

Use the format method to specify a standard paper size. You can pass a Format enum or a string.

```php
use Spatie\LaravelPdf\Facades\Pdf;
use Spatie\LaravelPdf\Enums\Format;

Pdf::view('pdf.invoice', ['invoice' => $invoice])
    ->format(Format::A3) // or you can pass a string like 'a3'
    ->save('/some/directory/invoice-april-2022.pdf');
```

--------------------------------

### Assert PDF View Data

Source: https://spatie.be/docs/laravel-pdf/v2/basic-usage/testing-pdfs

Verify that the PDF view was passed specific data keys or values.

```php
Pdf::assertViewHas('invoice');
```

```php
Pdf::assertViewHas('invoice', $invoice);
```

--------------------------------

### Configure DOMPDF driver

Source: https://spatie.be/docs/laravel-pdf/v2/drivers/configuration

Sets remote resource access and chroot path for DOMPDF.

```php
'dompdf' => [
    'is_remote_enabled' => env('LARAVEL_PDF_DOMPDF_REMOTE_ENABLED', false),
    'chroot' => env('LARAVEL_PDF_DOMPDF_CHROOT'),
],
```

--------------------------------

### Encrypt a PDF with a user password

Source: https://spatie.be/docs/laravel-pdf/v2/basic-usage/protecting-pdfs-with-a-password

Apply a user password to a generated PDF to restrict access.

```php
use Spatie\\\LaravelPdf\\\Facades\\\Pdf;

Pdf::view('pdf.invoice', ['invoice' => $invoice])
    ->encrypt(userPassword: 'open-sesame')
    ->save('/some/directory/invoice.pdf');
```

--------------------------------

### Set Header and Footer Font Size

Source: https://spatie.be/docs/laravel-pdf/v2/basic-usage/formatting-pdfs

Explicitly define font-size in header/footer CSS to avoid default rendering issues.

```css
    html {
        font-size: 16px;
    }
```

--------------------------------

### Set custom cache key

Source: https://spatie.be/docs/laravel-pdf/v2/advanced-usage/caching-pdfs

Provide a stable identifier as the second argument to the cache method for manual key control.

```php
Pdf::view('pdf.invoice', ['invoice' => $invoice])
    ->cache(key: "invoice-{$invoice->id}")
    ->save('invoice.pdf');
```

--------------------------------

### Per-PDF Browsershot Customization

Source: https://spatie.be/docs/laravel-pdf/v2/drivers/customizing-browsershot

Use the withBrowsershot method to modify the Browsershot instance for a specific PDF generation task.

```php
use Spatie\LaravelPdf\Facades\Pdf;
use Spatie\Browsershot\Browsershot;

Pdf::view('test')
    ->withBrowsershot(function (Browsershot $browsershot) {
        $browsershot->scale(0.5);
    })
    ->save($this->targetPath);
```

--------------------------------

### Assert PDF metadata

Source: https://spatie.be/docs/laravel-pdf/v2/basic-usage/testing-pdfs

Inspect the metadata property on the PdfBuilder instance to verify PDF metadata.

```php
use Spatie\LaravelPdf\Facades\Pdf;
use Spatie\LaravelPdf\PdfBuilder;

Pdf::assertSaved(function (PdfBuilder $pdf) {
    return $pdf->metadata->title === 'Invoice #123'
        && $pdf->metadata->author === 'Acme Corp';
});
```

--------------------------------

### Use DOMPDF for specific PDFs

Source: https://spatie.be/docs/laravel-pdf/v2/drivers/using-the-dompdf-driver

Override the default driver for a specific PDF generation task.

```php
use Spatie\LaravelPdf\Facades\Pdf;

Pdf::view('pdfs.invoice', ['invoice' => $invoice])
    ->driver('dompdf')
    ->format('a4')
    ->save('invoice.pdf');
```

--------------------------------

### Tailwind-styled Blade view for PDF

Source: https://spatie.be/docs/laravel-pdf/v2/advanced-usage/using-tailwind

A sample Blade template using Tailwind CSS classes to structure a PDF invoice.

```html

    Invoice

            Your Company Name

            Invoice
            Date: 01/05/2023
            Invoice #: {{ $invoiceNumber }}

        Bill To:
        {{ $customerName }}
        123 Main St.
        Anytown, USA 12345
        johndoe@example.com

            Description
            Quantity
            Price
            Total

            Product 1
            1
            $100.00
            $100.00

            Product 2
            2
            $50.00
            $100.00

            Product 3
            3
            $75.00
            $225.00

        Subtotal:
        $425.00

        Tax:
        $25.50

        Total:
        $450.50

        Payment is due within 30 days. Late payments are subject to fees.
        Please make checks payable to Your Company Name and mail to:
        123 Main St., Anytown, USA 12345


```

--------------------------------

### Use Chrome driver for specific PDF

Source: https://spatie.be/docs/laravel-pdf/v2/drivers/using-the-chrome-driver

Override the default driver for a single PDF generation call.

```php
use Spatie\LaravelPdf\Facades\Pdf;

Pdf::view('pdfs.invoice', ['invoice' => $invoice])
    ->driver('chrome')
    ->format('a4')
    ->save('invoice.pdf');
```

--------------------------------

### Handle decryption exceptions

Source: https://spatie.be/docs/laravel-pdf/v2/basic-usage/protecting-pdfs-with-a-password

Catch errors when attempting to decrypt a PDF with an incorrect password.

```php
use Spatie\\\LaravelPdf\\\Exceptions\\\CouldNotDecryptPdf;
use Spatie\\\LaravelPdf\\\Facades\\\Pdf;

try {
    $decrypted = Pdf::decrypt('/some/directory/invoice.pdf', $password);
} catch (CouldNotDecryptPdf $exception) {
    // The password was incorrect, or the PDF could not be decrypted.
}
```

--------------------------------

### Assert PDF Content

Source: https://spatie.be/docs/laravel-pdf/v2/basic-usage/testing-pdfs

Verify that the generated PDF contains specific text or a list of strings.

```php
Pdf::assertSee('Your total for April is $10.00');
```

```php
Pdf::assertSee([
    'Your total for April is $10.00', 
    'Your total for May is $20.00',
]);
```

--------------------------------

### Conditional PDF Formatting

Source: https://spatie.be/docs/laravel-pdf/v2/basic-usage/formatting-pdfs

Apply formatting options conditionally using the when and unless methods on the Pdf builder.

```php
use Spatie\LaravelPdf\Facades\Pdf;

Pdf::view('pdf.invoice', ['invoice' => $invoice])
    ->format('a4')
    ->when($invoice->isLandscape(), fn ($pdf) => $pdf->landscape())
    ->when($invoice->hasLetterhead(), function ($pdf) use ($invoice) {
        $pdf->headerView('pdf.letterhead', ['company' => $invoice->company]);
    })
    ->save('/some/directory/invoice.pdf');
```

```php
use Spatie\LaravelPdf\Facades\Pdf;

Pdf::view('pdf.report', ['report' => $report])
    ->unless($report->isCompact(), fn ($pdf) => $pdf->margins(20, 15, 20, 15))
    ->save('/some/directory/report.pdf');
```

--------------------------------

### Rendering a multi-page PDF

Source: https://spatie.be/docs/laravel-pdf/v2/advanced-usage/creating-pdfs-with-multiple-pages

Use the Pdf::view method to render the view containing page breaks.

```php
Pdf::view('view-with-multiple-pages')->save($path);
```

--------------------------------

### Set Custom Paper Size

Source: https://spatie.be/docs/laravel-pdf/v2/basic-usage/formatting-pdfs

Use the paperSize method to define custom dimensions instead of standard formats.

```php
use Spatie\LaravelPdf\Facades\Pdf;

Pdf::view('pdf.receipt', ['order' => $order])
    ->paperSize(57, 500, 'mm')
    ->save('/some/directory/receipt-12345.pdf');
```
Tokens:
Raw