Laravel PDF

https://github.com/spatie/laravel-pdf
Admin
A package that simplifies PDF creation in Laravel applications by rendering Blade views using...
Tokens:64,626
Snippets:530
Trust Score:10
License:MIT
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Install package via Composer

Source: https://github.com/spatie/laravel-pdf/blob/main/docs/installation-setup.md

Install the spatie/laravel-pdf package using Composer.

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

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

### Install WeasyPrint PHP wrapper

Source: https://github.com/spatie/laravel-pdf/blob/main/docs/installation-setup.md

Install the pontedilana/php-weasyprint package for the WeasyPrint driver.

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

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

### Install poppler-utils via Homebrew

Source: https://github.com/spatie/laravel-pdf/blob/main/README.md

Install the pdftotext CLI from poppler-utils using Homebrew, a prerequisite for the tests. More info is in the spatie/pdf-to-text readme.

```bash
brew install poppler-utils
```

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

### Install Chrome driver package

Source: https://github.com/spatie/laravel-pdf/blob/main/docs/installation-setup.md

Install the chrome-php/chrome package for the Chrome driver.

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

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

### Start Gotenberg with Docker

Source: https://github.com/spatie/laravel-pdf/blob/main/docs/drivers/using-the-gotenberg-driver.md

Runs a Gotenberg container on port 3000 using the gotenberg/gotenberg:8 image.

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

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

### Install Laravel Boost skill

Source: https://github.com/spatie/laravel-pdf/blob/main/README.md

Run this Artisan command after installing the package to register the Laravel Boost skill, which helps AI agents generate correct PDF code.

```bash
php artisan boost:install
```

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

### Run the test suite

Source: https://github.com/spatie/laravel-pdf/blob/main/README.md

Execute the package's test suite with Composer after installing Puppeteer and pdftotext.

```bash
composer test
```

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

### Install DOMPDF driver package

Source: https://github.com/spatie/laravel-pdf/blob/main/docs/installation-setup.md

Install the dompdf/dompdf package for the DOMPDF driver.

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

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

### Install tecnickcom/tc-lib-pdf-encrypt package

Source: https://github.com/spatie/laravel-pdf/blob/main/docs/basic-usage/protecting-pdfs-with-a-password.md

Required package for PDF encryption. Install via Composer before using the `encrypt` method.

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

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

### Install Browsershot explicitly

Source: https://github.com/spatie/laravel-pdf/blob/main/UPGRADING.md

In v2, spatie/browsershot is a suggested dependency. Run this command to require it explicitly. If skipped, a CouldNotGeneratePdf exception is thrown when generating PDFs.

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

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

### Asserting Browsershot customization

Source: https://github.com/spatie/laravel-pdf/blob/main/docs/basic-usage/testing-pdfs.md

Example showing how to use assertBrowsershot to verify Browsershot configuration applied via withBrowsershot, using spatie/invade to read a protected property.

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

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

### Use WeasyPrint driver for a specific PDF

Source: https://github.com/spatie/laravel-pdf/blob/main/docs/drivers/using-the-weasyprint-driver.md

Example of using the driver method to switch to WeasyPrint for a specific PDF while keeping another driver as default.

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

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

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

### Install Puppeteer globally

Source: https://github.com/spatie/laravel-pdf/blob/main/README.md

Install Puppeteer globally via npm, as required for running the test suite. Refer to Browsershot requirements for details.

```bash
npm -g i puppeteer
```

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

### Example footer view with CSS

Source: https://github.com/spatie/laravel-pdf/blob/main/docs/basic-usage/formatting-pdfs.md

An example footer view that includes its own CSS because the header and footer do not use the main view's CSS. This footer sets a font size and displays the footer text.

```html
<style>
footer {
    font-size: 12px;
}
</style>

<footer>
  This is the footer
</footer>
```

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

### Generate PDF with Cloudflare driver (default)

Source: https://github.com/spatie/laravel-pdf/blob/main/docs/drivers/using-the-cloudflare-driver.md

This example shows how to generate a PDF using the Cloudflare driver without any code changes, as long as the driver is set in the environment. It uses the Pdf facade to render a view and save it.

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

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

### Use driver per-PDF

Source: https://github.com/spatie/laravel-pdf/blob/main/docs/drivers/custom-drivers.md

Once registered, you can use the driver on a per-PDF basis by calling the driver method on the Pdf facade. This example uses the 'weasyprint' driver to save a view as 'invoice.pdf'.

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

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

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

### Route returning a PDF download

Source: https://github.com/spatie/laravel-pdf/blob/main/docs/basic-usage/testing-pdfs.md

Example route that generates a PDF from a view and returns it as a download named 'invoice-for-april-2022.pdf'.

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

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

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

### Register driver as singleton

Source: https://github.com/spatie/laravel-pdf/blob/main/docs/drivers/custom-drivers.md

Register your custom driver as a singleton in a service provider. The example binds 'laravel-pdf.driver.weasyprint' to a new WeasyPrintDriver instance using configuration from 'laravel-pdf.weasyprint'.

```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', []));
        });
    }
}
```

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

### Use the custom macro on Pdf facade

Source: https://github.com/spatie/laravel-pdf/blob/main/docs/advanced-usage/extending-with-macros.md

After defining the macro, call it like any other method on the PdfBuilder. This example uses the Pdf facade to render a view, apply the custom header, and save the PDF.

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

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

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

### Generate a PDF on AWS Lambda with onLambda()

Source: https://github.com/spatie/laravel-pdf/blob/main/docs/drivers/generating-pdfs-on-aws-lambda.md

Use the onLambda() method on the Pdf facade to generate a PDF on AWS Lambda. Requires hammerstone/sidecar and wnx/sidecar-browsershot to be installed.

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

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

### Set default PDF options in a service provider

Source: https://github.com/spatie/laravel-pdf/blob/main/docs/basic-usage/setting-defaults.md

Use the `default` method on the `Pdf` facade to set default options for all PDFs. Typically placed in the `boot` method of a service provider. This example sets a header view and A3 format.

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

// in a service provider

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

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

### Save PDF to s3 disk with disk() method

Source: https://github.com/spatie/laravel-pdf/blob/main/docs/basic-usage/saving-pdfs-to-disks.md

Use the disk() method on the Pdf facade to specify the target disk, then call save() to store the PDF. This example saves a view-rendered PDF to the 's3' disk.

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

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

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

### Set transparent background with Browsershot

Source: https://github.com/spatie/laravel-pdf/blob/main/docs/basic-usage/formatting-pdfs.md

Alternatively, you can set a transparent background using Browsershot. This example shows how to call `transparentBackground()` on the Browsershot instance.

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

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

### Set margins

Source: https://github.com/spatie/laravel-pdf/blob/main/resources/boost/skills/laravel-pdf/SKILL.md

Use the margins() method to set custom margins with a unit. The example uses millimeters.

```php
Pdf::view('pdf.invoice', $data)
    ->margins(top: 15, right: 10, bottom: 15, left: 10, unit: 'mm')
    ->save('invoice.pdf');
```

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

### Add a macro to PdfBuilder in service provider boot method

Source: https://github.com/spatie/laravel-pdf/blob/main/docs/advanced-usage/extending-with-macros.md

Define a custom method on the PdfBuilder class using Laravel's macro. This example adds a 'withCustomHeader' method that sets the header HTML and returns the builder instance for chaining.

```php
use Spatie\LaravelPdf\PdfBuilder;

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

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

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

### Replace getBrowsershot() with withBrowsershot()

Source: https://github.com/spatie/laravel-pdf/blob/main/UPGRADING.md

The getBrowsershot() method is removed in v2. Use withBrowsershot() to customize the Browsershot instance. The before and after examples show the migration.

```php
// Before (v1)
$browsershot = Pdf::view('invoice', $data)->getBrowsershot();
$browsershot->scale(0.5);
$browsershot->save('invoice.pdf');
```

```php
// After (v2)
Pdf::view('invoice', $data)
    ->withBrowsershot(function (Browsershot $browsershot) {
        $browsershot->scale(0.5);
    })
    ->save('invoice.pdf');
```

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

### Testing queued PDFs with Pdf::fake()

Source: https://github.com/spatie/laravel-pdf/blob/main/docs/basic-usage/queued-pdf-generation.md

Use Pdf::fake() to assert that PDFs were queued. Includes examples for assertQueued with a path or callable, and assertNotQueued with or without a path.

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

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

### Update tests that inspect Browsershot internals

Source: https://github.com/spatie/laravel-pdf/blob/main/UPGRADING.md

Tests using getBrowsershot() with invade() must create a BrowsershotDriver instance directly. The before and after examples show the new approach.

```php
// Before (v1)
$browsershot = Pdf::view('test')->getBrowsershot();
expect(invade($browsershot)->nodeBinary)->toBe('/test/node');
```

```php
// After (v2)
use Spatie\LaravelPdf\Drivers\BrowsershotDriver;
use Spatie\LaravelPdf\PdfOptions;

$driver = new BrowsershotDriver(config('laravel-pdf.browsershot'));
$browsershot = invade($driver)->buildBrowsershot('test', null, null, new PdfOptions);
expect(invade($browsershot)->nodeBinary)->toBe('/test/node');
```

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

### Fake PDF generation in tests

Source: https://github.com/spatie/laravel-pdf/blob/main/docs/basic-usage/testing-pdfs.md

Call Pdf::fake() in a beforeEach hook to fake PDF generation, making tests faster. No Chrome is started and no remote request is made.

```php
// in your test

use Spatie\LaravelPdf\Facades\Pdf;

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

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

### Set header and footer HTML with headerHtml and footerHtml

Source: https://github.com/spatie/laravel-pdf/blob/main/docs/basic-usage/formatting-pdfs.md

Use the headerHtml and footerHtml methods to set raw HTML for the header and footer. This example saves a PDF with an invoice view and inline HTML for header and footer.

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

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

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

### Bind driver as default

Source: https://github.com/spatie/laravel-pdf/blob/main/docs/drivers/custom-drivers.md

To make the driver the default, bind it to the PdfDriver interface in your service provider. This example binds PdfDriver::class to a new WeasyPrintDriver instance.

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

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

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

### Conditional formatting with `when`

Source: https://github.com/spatie/laravel-pdf/blob/main/docs/basic-usage/formatting-pdfs.md

Use the `when` method to apply formatting options conditionally without breaking the method chain. In this example, the PDF is set to landscape if the invoice is landscape, and a header view is added if the invoice has a letterhead.

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

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

### Set margins to make room for header and footer

Source: https://github.com/spatie/laravel-pdf/blob/main/docs/basic-usage/formatting-pdfs.md

Increase marginTop and marginBottom to avoid overlap between the header/footer and main content. This example sets margins in inches using the Unit enum.

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

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

### Set header and footer views with headerView and footerView

Source: https://github.com/spatie/laravel-pdf/blob/main/docs/basic-usage/formatting-pdfs.md

Use the headerView and footerView methods to set HTML for the header and footer from Blade views. This example saves a PDF with an invoice view and header/footer views.

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

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

### Set default Chrome flags for all PDFs

Source: https://github.com/spatie/laravel-pdf/blob/main/docs/drivers/customizing-browsershot.md

Set default Browsershot options for all PDFs, typically in a service provider. This example disables web security and allows file access from files, which is needed when templates reference local assets or bypass CORS.

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

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

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

### Using chained methods for queue configuration

Source: https://github.com/spatie/laravel-pdf/blob/main/docs/basic-usage/queued-pdf-generation.md

Use onQueue(), onConnection(), and delay() methods for full control, proxied to Laravel's PendingDispatch.

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

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

### Generate PDF with defaults and override format

Source: https://github.com/spatie/laravel-pdf/blob/main/docs/basic-usage/setting-defaults.md

Shows how to generate a PDF using the defaults (A3) and how to override the default format to A4 for a specific PDF.

```php
// this PDF will use the defaults: it will be rendered in A3 format

Pdf::html('<h1>Hello world</h1>')
    ->save('my-a3-pdf.pdf')

// here we override the default: this PDF will be rendered in A4 format

Pdf::html('<h1>Hello world</h1>')
   ->format(Format::A4)
   ->save('my-a4-pdf.pdf')
```

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

### JavaScript execution example: Blade view and rendering code

Source: https://github.com/spatie/laravel-pdf/blob/main/docs/basic-usage/creating-pdfs.md

When using a browser-based driver (Browsershot, Cloudflare, or Chrome), JavaScript in the HTML is executed. This example shows a Blade view with a script that sets content, and the PHP code that renders it to a PDF. The DomPDF driver does not support JavaScript.

```blade
<div id="target"></div>

<script>
    document.getElementById('target').innerHTML = 'hello';
</script>
```

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

Pdf::view('your-view')->save($pathToPdf);
```

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

### Pdf::fake()

Source: https://github.com/spatie/laravel-pdf/blob/main/resources/boost/skills/laravel-pdf/SKILL.md

Fake PDF generation in tests. Must be called in beforeEach or similar setup.

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

### Description
Fake PDF generation in tests. Must be called in beforeEach or similar setup.

### Method
fake

### Parameters
None

### Request Example
```php
use Spatie\LaravelPdf\Facades\Pdf;

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

### Response
No return value.
```

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

### Wait for readiness with waitUntilReady()

Source: https://github.com/spatie/laravel-pdf/blob/main/docs/advanced-usage/waiting-for-readiness.md

Call waitUntilReady() on the builder to capture the PDF only after window.pdfReady === true.

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

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

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

### Switch PDF driver at runtime with driver()

Source: https://github.com/spatie/laravel-pdf/blob/main/docs/drivers/configuration.md

Use the driver method to select a specific driver for a single PDF, such as 'cloudflare', or fall back to the default driver from config.

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

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

### Asserting PDF metadata

Source: https://github.com/spatie/laravel-pdf/blob/main/docs/basic-usage/testing-pdfs.md

Example using assertSaved to verify PDF metadata properties such as title and author.

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

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

### WeasyPrint driver configuration

Source: https://github.com/spatie/laravel-pdf/blob/main/docs/drivers/configuration.md

Configure the WeasyPrint driver options. Binary defaults to 'weasyprint' found via $PATH, and timeout defaults to 10 seconds.

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

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

### Add header and footer with raw HTML

Source: https://github.com/spatie/laravel-pdf/blob/main/resources/boost/skills/laravel-pdf/SKILL.md

Use headerHtml() and footerHtml() to add header and footer from raw HTML strings.

```php
Pdf::view('pdf.invoice', $data)
    ->headerHtml('<div>Header</div>')
    ->footerHtml('<div>Footer</div>')
    ->save('invoice.pdf');
```

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

### Publish the Laravel PDF configuration file

Source: https://github.com/spatie/laravel-pdf/blob/main/docs/drivers/configuration.md

Run this artisan command to publish the package's configuration file to config/laravel-pdf.php.

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

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

### Set window.pdfReady in Blade view

Source: https://github.com/spatie/laravel-pdf/blob/main/docs/advanced-usage/waiting-for-readiness.md

In your Blade view, set window.pdfReady to true once the page is ready to be captured. This example renders a chart and then sets the flag.

```blade
<canvas id="chart"></canvas>

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

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

### Queue PDF generation with saveQueued and callbacks

Source: https://github.com/spatie/laravel-pdf/blob/main/resources/boost/skills/laravel-pdf/SKILL.md

Dispatch PDF generation to a background queue. The `then` callback receives the path and disk name (null for local saves). The `catch` callback handles errors.

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

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

### Pdf::disk()

Source: https://github.com/spatie/laravel-pdf/blob/main/resources/boost/skills/laravel-pdf/SKILL.md

Set the disk for saving the PDF.

```APIDOC
## Pdf::disk()

### Description
Set the disk for saving the PDF.

### Method
disk

### Parameters
- **disk** (string) - Required - The disk name.

### Request Example
```php
Pdf::view('pdf.invoice', $data)
    ->disk('s3')
    ->saveQueued('invoices/invoice.pdf');
```

### Response
Returns the PDF builder instance for chaining.
```

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

### Debugging with `dump`

Source: https://github.com/spatie/laravel-pdf/blob/main/docs/basic-usage/formatting-pdfs.md

Call `dump` on the builder to inspect its current state. The dump outputs the builder state and continues the chain, allowing you to see the state before saving.

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

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

### Return an inlined PDF with pdf() helper

Source: https://github.com/spatie/laravel-pdf/blob/main/docs/basic-usage/responding-with-pdfs.md

Creates a PDF from a view and returns it inlined in the browser. The name() method sets the default filename when the user downloads it. Always name your PDFs as recommended.

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

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

### Blade view with @pageBreak directive

Source: https://github.com/spatie/laravel-pdf/blob/main/docs/advanced-usage/creating-pdfs-with-multiple-pages.md

Use @pageBreak in a Blade view to force a new page in the PDF. The example shows two divs separated by @pageBreak, resulting in two pages.

```blade
<div>
    Page 1
</div>

@pageBreak

<div>
    Page 2
</div>
```

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

### Simple assertions for PDF views

Source: https://github.com/spatie/laravel-pdf/blob/main/resources/boost/skills/laravel-pdf/SKILL.md

Use Pdf::assertViewIs, Pdf::assertSee, Pdf::assertViewHas, and Pdf::assertSaved for quick checks on the PDF view and content.

```php
Pdf::assertViewIs('pdf.invoice');
Pdf::assertSee('Your total is $10.00');
Pdf::assertViewHas('invoice', $invoice);
Pdf::assertSaved(storage_path('invoices/invoice.pdf'));
```

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

### Configure queue and connection for saveQueued

Source: https://github.com/spatie/laravel-pdf/blob/main/resources/boost/skills/laravel-pdf/SKILL.md

Set the queue connection and queue name either via named arguments or by chaining methods. The chained methods also allow a delay.

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

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

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

### Configure Browsershot driver paths

Source: https://github.com/spatie/laravel-pdf/blob/main/docs/drivers/configuration.md

Configure paths to Node.js, npm, Chrome, and other binaries used by the Browsershot driver. All options are environment-driven with defaults for write_options_to_file and no_sandbox.

```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),
],
```

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

### Return a PDF as a controller response

Source: https://github.com/spatie/laravel-pdf/blob/main/README.md

Shows a controller that returns a PDF response using the Pdf facade. The PDF is rendered from the 'pdfs.invoice' view, formatted as 'a4', and named 'your-invoice.pdf'.

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

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

### Add horizontal padding to align header/footer with margins

Source: https://github.com/spatie/laravel-pdf/blob/main/docs/basic-usage/formatting-pdfs.md

The header and footer span the full page width, so add matching horizontal padding to align them with your content. This example uses padding of 0.39in to match left and right margins.

```html
<style>
    body {
        margin: 0;
        padding: 0 0.39in;
    }
</style>
```

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

### Configure Gotenberg driver in .env

Source: https://github.com/spatie/laravel-pdf/blob/main/docs/drivers/using-the-gotenberg-driver.md

Sets the PDF driver to gotenberg and specifies the Gotenberg URL.

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

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

### Render view with footerView

Source: https://github.com/spatie/laravel-pdf/blob/main/docs/advanced-usage/creating-pdfs-with-multiple-pages.md

Render a view with a footer using the footerView method. The footer will appear on each page with page numbers.

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

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

### Gotenberg driver configuration

Source: https://github.com/spatie/laravel-pdf/blob/main/docs/drivers/configuration.md

Configure the Gotenberg API URL. Defaults to http://localhost:3000.

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

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

### Encrypt PDF with owner password and permissions

Source: https://github.com/spatie/laravel-pdf/blob/main/docs/basic-usage/protecting-pdfs-with-a-password.md

Set an owner password and restrict reader permissions using `Permission` cases. Only the permissions passed are granted; if none are passed, all permissions are granted and the password only controls opening.

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

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

### Gotenberg driver environment configuration

Source: https://github.com/spatie/laravel-pdf/blob/main/docs/installation-setup.md

Set the LARAVEL_PDF_DRIVER to gotenberg and provide the Gotenberg URL. Optionally include authentication credentials if set up.

```env
LARAVEL_PDF_DRIVER=gotenberg
GOTENBERG_URL=http://your-host:your-port
# If you set up authentication, add these lines too:
GOTENBERG_USERNAME=username
GOTENBERG_PASSWORD=password
```

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

### then()

Source: https://github.com/spatie/laravel-pdf/blob/main/docs/basic-usage/queued-pdf-generation.md

Registers a callback to be executed when the queued PDF job succeeds. The callback receives the path and disk name.

```APIDOC
## then()

### Description
Registers a callback to be executed when the queued PDF job succeeds. The callback receives the path and disk name.

### Method
then

### Parameters
- **callback** (callable) - Required - A function that receives (string $path, ?string $diskName).

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

### Response
Returns the PendingDispatch instance for chaining.
```

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

### Generate PDF with Gotenberg driver

Source: https://github.com/spatie/laravel-pdf/blob/main/docs/drivers/using-the-gotenberg-driver.md

Uses the Pdf facade to render a view and save as PDF with A4 format.

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

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

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

### Controller to download PDF invoice

Source: https://github.com/spatie/laravel-pdf/blob/main/docs/advanced-usage/using-tailwind.md

A controller that uses the pdf() helper from Spatie\LaravelPdf\Support to render the 'pdf.invoice' view with invoice data and return the PDF as a download.

```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',
        ]);
    }
}
```

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

### Custom PdfCache implementation

Source: https://github.com/spatie/laravel-pdf/blob/main/docs/advanced-usage/caching-pdfs.md

Create a class implementing Spatie\LaravelPdf\Caching\PdfCache to customize keying, storage, and expiration.

```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.
    }
}
```

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

### Environment variables for PDF generation

Source: https://github.com/spatie/laravel-pdf/blob/main/docs/drivers/configuration.md

Environment variables to configure PDF generation. Includes driver selection, Browsershot settings, Cloudflare credentials, Chrome driver settings, Gotenberg URL, WeasyPrint binary, and DOMPDF settings.

```env
# 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
```

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

### Chrome driver configuration

Source: https://github.com/spatie/laravel-pdf/blob/main/docs/drivers/configuration.md

Configure the Chrome driver options. Includes environment variable defaults for binary path, sandbox, timeouts, user data directory, custom flags, and environment variables.

```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' => [],
],
```

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

### Set landscape orientation with the landscape method

Source: https://github.com/spatie/laravel-pdf/blob/main/docs/basic-usage/formatting-pdfs.md

Use the `landscape` method to generate a PDF in landscape orientation. The default is portrait.

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

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

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

### Set PDF creation date with meta method

Source: https://github.com/spatie/laravel-pdf/blob/main/docs/basic-usage/formatting-pdfs.md

Use the `meta` method with the `creationDate` parameter to set the PDF creation date. Accepts a `DateTimeInterface` instance (such as a Carbon date) or a raw PDF date string. Works with all drivers.

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

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

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

### Chaining then() and catch() callbacks

Source: https://github.com/spatie/laravel-pdf/blob/main/docs/basic-usage/queued-pdf-generation.md

React to the queued job's success or failure by chaining then() and catch() callbacks. The then callback receives the saved path and disk name (or null for local saves), while catch receives the exception.

```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);
})
```

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

### Queue PDF generation and send email on completion

Source: https://github.com/spatie/laravel-pdf/blob/main/docs/introduction.md

Queues PDF generation for background processing. After saving, the 'then' callback sends an email with the generated file path and disk name.

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

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

### Update config file with driver and new sections

Source: https://github.com/spatie/laravel-pdf/blob/main/UPGRADING.md

Add the 'driver' key and 'cloudflare' and 'dompdf' sections to the published config file. The driver defaults to 'browsershot' via the LARAVEL_PDF_DRIVER environment variable.

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

    'browsershot' => [
        // ... your existing browsershot config
    ],

    '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'),
    ],
];
```

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

### Implement PdfDriver interface

Source: https://github.com/spatie/laravel-pdf/blob/main/docs/drivers/custom-drivers.md

A driver must implement the Spatie\LaravelPdf\Drivers\PdfDriver interface. The generatePdf method returns PDF content as a string, while savePdf saves to a given path. The PdfOptions object provides access to formatting options like format, paperSize, margins, and orientation.

```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
    }
}
```

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

### Cache with withBrowsershot() and explicit key

Source: https://github.com/spatie/laravel-pdf/blob/main/docs/advanced-usage/caching-pdfs.md

When using withBrowsershot(), caching throws an exception unless an explicit key is provided. Pass a unique key to take responsibility.

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

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

### Wait for JavaScript readiness

Source: https://github.com/spatie/laravel-pdf/blob/main/docs/drivers/using-the-gotenberg-driver.md

Defers PDF capture until the view signals readiness, with a 30-second default timeout.

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

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

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

### Create PDF from HTML string

Source: https://github.com/spatie/laravel-pdf/blob/main/docs/basic-usage/creating-pdfs.md

Use Pdf::html() to generate a PDF from a raw HTML string and save it to a file.

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

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

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

### Return PDF inline from controller

Source: https://github.com/spatie/laravel-pdf/blob/main/resources/boost/skills/laravel-pdf/SKILL.md

Use the pdf() helper to return a PDF as an inline response from a controller. The PDF is inlined in the browser by default.

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

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

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

### Set Chrome binary path in .env

Source: https://github.com/spatie/laravel-pdf/blob/main/docs/drivers/using-the-chrome-driver.md

If Chrome cannot be auto-discovered, set the LARAVEL_PDF_CHROME_BINARY environment variable to the path of the Chrome executable.

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

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

### Assert a PDF response was returned

Source: https://github.com/spatie/laravel-pdf/blob/main/resources/boost/skills/laravel-pdf/SKILL.md

Use Pdf::assertRespondedWithPdf to verify a PDF response was returned with the expected download name and download flag.

```php
Pdf::assertRespondedWithPdf(function (PdfBuilder $pdf) {
    return $pdf->isDownload()
        && $pdf->downloadName === 'invoice.pdf';
});
```

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

### Chrome driver environment configuration

Source: https://github.com/spatie/laravel-pdf/blob/main/docs/installation-setup.md

Set the LARAVEL_PDF_DRIVER to chrome in the .env file.

```env
LARAVEL_PDF_DRIVER=chrome
```

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

### Force PDF download from controller

Source: https://github.com/spatie/laravel-pdf/blob/main/resources/boost/skills/laravel-pdf/SKILL.md

Use the download() method to force a PDF download instead of inline display.

```php
return pdf()
    ->view('pdf.invoice', compact('invoice'))
    ->name('invoice.pdf')
    ->download();
```

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

### Render a Blade view to a PDF and save it

Source: https://github.com/spatie/laravel-pdf/blob/main/README.md

Uses the Pdf facade to render the 'pdfs.invoice' view with the given data, sets the page format to 'a4', and saves the PDF to 'invoice.pdf'.

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

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

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

### Set custom paper size with the paperSize method

Source: https://github.com/spatie/laravel-pdf/blob/main/docs/basic-usage/formatting-pdfs.md

Use the `paperSize` method to define a custom paper size in millimeters (or other units) when standardized formats are not suitable.

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

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

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

### Implement custom PdfEncrypter class

Source: https://github.com/spatie/laravel-pdf/blob/main/docs/basic-usage/protecting-pdfs-with-a-password.md

Implement the `Spatie\LaravelPdf\Encryption\PdfEncrypter` contract to use a different encryption strategy, such as a `qpdf` binary or commercial library. The `encrypt` method receives the PDF string and `PdfEncryption` object, and the `decrypt` method receives the PDF string and password.

```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
    }
}
```

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

### Set page margins with custom unit (pixels)

Source: https://github.com/spatie/laravel-pdf/blob/main/docs/basic-usage/formatting-pdfs.md

Use the margins method with a fifth parameter to specify a custom unit, such as Unit::Pixel. The unit is millimeters by default.

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

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

### Cache a PDF render with cache()

Source: https://github.com/spatie/laravel-pdf/blob/main/docs/advanced-usage/caching-pdfs.md

Call cache() on the builder to cache the rendered PDF. The first render is stored, and subsequent identical renders are served from cache. Applies to all output methods.

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

Pdf::view('pdf.invoice', ['invoice' => $invoice])
    ->cache()
    ->download('invoice.pdf');
```

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

### Set the PDF driver option

Source: https://github.com/spatie/laravel-pdf/blob/main/docs/drivers/configuration.md

The 'driver' option selects the PDF generation backend. Supported values are browsershot, chrome, cloudflare, dompdf, gotenberg, and weasyprint.

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

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

### Saving to a disk with disk()

Source: https://github.com/spatie/laravel-pdf/blob/main/docs/basic-usage/queued-pdf-generation.md

When using disk(), the queued job saves the PDF to the specified disk. The then callback can retrieve the file URL from the 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);
        // ...
    });
```

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

### WeasyPrint driver environment configuration

Source: https://github.com/spatie/laravel-pdf/blob/main/docs/installation-setup.md

Set the LARAVEL_PDF_DRIVER to weasyprint in the .env file.

```env
LARAVEL_PDF_DRIVER=weasyprint
```

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

### Configure Cloudflare Browser Rendering API credentials

Source: https://github.com/spatie/laravel-pdf/blob/main/docs/drivers/configuration.md

Configure the Cloudflare Browser Rendering API credentials using the api_token and account_id options.

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

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

### Pdf::driver()

Source: https://github.com/spatie/laravel-pdf/blob/main/docs/drivers/configuration.md

Switches the driver used for a specific PDF instance. Accepts a driver name string and returns the PDF instance for chaining.

```APIDOC
## Pdf::driver()

### Description
Switches the driver used for a specific PDF instance. Accepts a driver name string and returns the PDF instance for chaining.

### Method
`driver`

### Signature
`Pdf::view($view, $data)->driver(string $driver)`

### Parameters
- **driver** (string) - Required - The name of the driver to use (e.g., 'cloudflare').

### Return Value
Returns the PDF instance for method chaining.

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

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

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

### Assert queued PDFs

Source: https://github.com/spatie/laravel-pdf/blob/main/resources/boost/skills/laravel-pdf/SKILL.md

Use Pdf::assertQueued and Pdf::assertNotQueued to verify queued PDF jobs. The closure form allows checking the path.

```php
Pdf::assertQueued('invoice.pdf');
Pdf::assertQueued(fn (PdfBuilder $pdf, string $path) => $path === 'invoice.pdf');
Pdf::assertNotQueued();
```

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

### Configure custom encrypter in config file

Source: https://github.com/spatie/laravel-pdf/blob/main/docs/basic-usage/protecting-pdfs-with-a-password.md

Point the `encrypter` config key to your custom class that implements the `PdfEncrypter` contract.

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

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

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

### Pdf::onConnection()

Source: https://github.com/spatie/laravel-pdf/blob/main/resources/boost/skills/laravel-pdf/SKILL.md

Set the queue connection for a queued PDF job.

```APIDOC
## Pdf::onConnection()

### Description
Set the queue connection for a queued PDF job.

### Method
onConnection

### Parameters
- **connection** (string) - Required - The queue connection name.

### Request Example
```php
Pdf::view('pdf.invoice', $data)
    ->saveQueued('invoice.pdf')
    ->onConnection('redis');
```

### Response
Returns the job instance for chaining.
```

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

### Use Cloudflare driver for a specific PDF

Source: https://github.com/spatie/laravel-pdf/blob/main/docs/drivers/using-the-cloudflare-driver.md

Use the driver method to switch to Cloudflare for a specific PDF while keeping Browsershot as the default. Requires Cloudflare credentials to be configured in config/laravel-pdf.php or .env.

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

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