Laravel DomPDF

https://github.com/barryvdh/laravel-dompdf
Admin
Laravel DomPDF is a Laravel wrapper for the DomPDF HTML to PDF converter, enabling easy generation...
Tokens:34,600
Snippets:250
Trust Score:9.8
License:MIT
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Install package via Composer

Source: https://github.com/barryvdh/laravel-dompdf/blob/master/readme.md

Run this command in your terminal to install the package and its dependencies.

```shell
composer require barryvdh/laravel-dompdf
```

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

### output() usage with loadView

Source: https://github.com/barryvdh/laravel-dompdf/blob/master/_autodocs/api-reference/pdf.md

Example showing how to render a view to PDF and get the raw PDF string, then send it via email.

```php
$pdf = Pdf::loadView('mail.attachment', $data);
$bytes = $pdf->output();            // raw PDF string
Mail::to($user)->send(new InvoiceMail($bytes));
```

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

### output() error handling with warnings

Source: https://github.com/barryvdh/laravel-dompdf/blob/master/_autodocs/api-reference/pdf.md

Example showing how to catch exceptions when warnings are enabled, logging the error message.

```php
// Error handling when warnings are enabled
$pdf = Pdf::loadHTML($html)->setWarnings(true);
try {
    $bytes = $pdf->output();
} catch (\Exception $e) {
    Log::error('PDF render failed', ['warnings' => $e->getMessage()]);
}
```

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

### Define legacy configuration settings

Source: https://github.com/barryvdh/laravel-dompdf/blob/master/_autodocs/configuration.md

Example of setting legacy configuration values via the 'defines' key in config/dompdf.php.

```php
// Legacy defines style via your own ConfigProvider / config/dompdf.php
'defines' => [
    'DOMPDF_DPI' => 150,
    'DOMPDF_DEFAULT_FONT' => 'sans-serif',
],
```

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

### setEncryption() usage example

Source: https://github.com/barryvdh/laravel-dompdf/blob/master/_autodocs/api-reference/pdf.md

Example of using setEncryption to protect a PDF with user and owner passwords.

```php
$pdf = Pdf::loadView('pdf.confidential', $data);
$pdf->setEncryption('user-pass', 'owner-pass');
return $pdf->download('confidential.pdf');
```

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

### setOptions() usage with mergeWithDefaults

Source: https://github.com/barryvdh/laravel-dompdf/blob/master/_autodocs/api-reference/pdf.md

Example showing how to keep default options (like font_dir, chroot) and override selectively by passing true as the second argument.

```php
// Keep defaults (font_dir, chroot, ...) and override selectively
Pdf::loadHTML($html)->setOptions(['dpi' => 150], true)->download('x.pdf');
```

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

### Enable PDF/A globally

Source: https://github.com/barryvdh/laravel-dompdf/blob/master/_autodocs/configuration.md

Example of enabling PDF/A globally within the config/dompdf.php file.

```php
// Global PDF/A enabled from config
// config/dompdf.php
return [
    'pdfa' => [
        'enabled' => true,
    ],
    // ...
];
```

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

### Set remote assets for trusted hosts

Source: https://github.com/barryvdh/laravel-dompdf/blob/master/_autodocs/configuration.md

Example of enabling remote assets and restricting them to specific trusted hosts using Pdf::setOption.

```php
// Enable remote assets only for trusted hosts
return Pdf::setOption([
    'isRemoteEnabled' => true,
    'allowedRemoteHosts' => ['example.com'],
])->loadView('pdf.report', $data)->download('report.pdf');
```

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

### Catching render warnings

Source: https://github.com/barryvdh/laravel-dompdf/blob/master/_autodocs/errors.md

Example of catching global Exception when rendering with warnings enabled.

```php
try {
    $bytes = Pdf::loadHTML($html)->setWarnings(true)->output();
} catch (\Exception $e) {
    Log::warning('DOMPDF warnings: ' . $e->getMessage());
}
```

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

### setOption() usage examples

Source: https://github.com/barryvdh/laravel-dompdf/blob/master/_autodocs/api-reference/pdf.md

Examples of using setOption() with an array of options and with a string key. The array form sets multiple options at once, while the string form sets a single option. Dompdf Options::set accepts both snake_case and camelCase option keys.

```php
return Pdf::setOption(['dpi' => 150, 'defaultFont' => 'sans-serif'])
    ->loadView('pdf.invoice', $data)
    ->download('invoice.pdf');
```

```php
// Equivalent string/key form
Pdf::loadHTML($html)->setOption('isRemoteEnabled', true);
```

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

### Chaining forwarded methods

Source: https://github.com/barryvdh/laravel-dompdf/blob/master/_autodocs/api-reference/pdf.md

Example of using forwarded methods like setPaper() which return the wrapper instance to allow for method chaining.

```php
// setPaper() is forwarded to Dompdf and returns the wrapper for chaining
return Pdf::loadHTML($html)
    ->setPaper('a4', 'landscape')
    ->setWarnings(false)
    ->save('myfile.pdf');
```

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

### Download PDF from Blade View

Source: https://github.com/barryvdh/laravel-dompdf/blob/master/resources/boost/skills/laravel-dompdf/references/example.md

This example demonstrates creating a controller method to download a PDF generated from a Blade view. The view file is located at resources/views/pdf/invoice.blade.php.

```php
<?php

namespace App\Http\Controllers;

use Barryvdh\DomPDF\Facade\Pdf;
use Illuminate\Http\Response;

class InvoiceController
{
    public function download(): Response
    {
        $invoice = [
            'number' => 'INV-1001',
            'customer' => 'Acme Ltd.',
            'total' => 199.99,
        ];

        return Pdf::loadView('pdf.invoice', [
            'invoice' => $invoice,
        ])->download('invoice.pdf');
    }
}
```

```blade
<!doctype html>
<html>
<head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
    <style>
        body { font-family: DejaVu Sans, sans-serif; }
        .total { font-weight: bold; }
    </style>
</head>
<body>
    <h1>Invoice {{ $invoice['number'] }}</h1>

    <p>Customer: {{ $invoice['customer'] }}</p>
    <p class="total">Total: ${{ number_format($invoice['total'], 2) }}</p>
</body>
</html>
```

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

### Catching CPDF-only feature errors

Source: https://github.com/barryvdh/laravel-dompdf/blob/master/_autodocs/errors.md

Example of handling the RuntimeException when using features that require the CPDF backend.

```php
try {
    $pdf->addEmbeddedFile($xmlPath, 'factur-x.xml');
} catch (\RuntimeException $e) {
    // "Embedded files are only supported when using CPDF"
}
```

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

### setAdditionalXmpRdf() usage example

Source: https://github.com/barryvdh/laravel-dompdf/blob/master/_autodocs/api-reference/pdf.md

Example of using setAdditionalXmpRdf to include Factur-X metadata in a generated PDF.

```php
$pdf = Pdf::loadView('invoice', $data)->setPdfA();
$pdf->setAdditionalXmpRdf(
    '<rdf:Description rdf:about=""
        xmlns:fx="urn:factur-x:pdfa:CrossIndustryDocument:invoice:1p0#">
        <fx:DocumentType>INVOICE</fx:DocumentType>
        <fx:DocumentFileName>factur-x.xml</fx:DocumentFileName>
        <fx:Version>1.0</fx:Version>
        <fx:ConformanceLevel>BASIC</fx:ConformanceLevel>
    </rdf:Description>'
);
return $pdf->download('invoice.pdf');
```

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

### Catching public path resolution errors

Source: https://github.com/barryvdh/laravel-dompdf/blob/master/_autodocs/errors.md

Example of how to catch the RuntimeException when resolving the dompdf wrapper.

```php
// consumer catching
try {
    $pdf = app()->make('dompdf.wrapper');
} catch (\RuntimeException $e) {
    // fix config('dompdf.public_path') or the public directory
}
```

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

### boot() configuration publishing

Source: https://github.com/barryvdh/laravel-dompdf/blob/master/_autodocs/api-reference/service-provider.md

Publishes the configuration file when not running under Lumen.

```php
$this->publishes([$configPath => config_path('dompdf.php')], 'config');
```

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

### boot() method definition

Source: https://github.com/barryvdh/laravel-dompdf/blob/master/_autodocs/api-reference/service-provider.md

Defines the boot method signature.

```php
public function boot(): void
```

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

### Using named arguments with Facade

Source: https://github.com/barryvdh/laravel-dompdf/blob/master/_autodocs/api-reference/facade-pdf.md

Shows how to pass named arguments to the loadView and download methods via the facade.

```php
// Named arguments work through the facade
return Pdf::loadView(view: 'pdf.report', data: ['title' => 'Monthly'])
    ->download(filename: 'report.pdf');
```

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

### Basic PDF generation with Facade

Source: https://github.com/barryvdh/laravel-dompdf/blob/master/_autodocs/api-reference/facade-pdf.md

Demonstrates loading a view or HTML string and triggering a download or stream response. The global alias \PDF can be used as an alternative to the facade import.

```php
use Barryvdh\DomPDF\Facade\Pdf;

// Basic view → download
return Pdf::loadView('pdf.invoice', compact('invoice'))->download('invoice.pdf');

// Global alias form without the use statement
return \PDF::loadHTML('<h1>Test</h1>')->stream();
```

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

### setPdfA() usage example

Source: https://github.com/barryvdh/laravel-dompdf/blob/master/_autodocs/api-reference/pdf.md

Example of using setPdfA() to generate and download a PDF/A-3b compliant invoice. Note that PDF/A requires all fonts to be embedded; core PDF fonts like Helvetica, Courier, and Times are not embedded and will cause validation failures.

```php
return Pdf::loadView('pdf.archive-invoice', compact('invoice'))
    ->setPdfA()
    ->download('archive-invoice.pdf');
```

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

### Generate PDF using Facade

Source: https://github.com/barryvdh/laravel-dompdf/blob/master/readme.md

Load a view and download the resulting PDF.

```php
use Barryvdh\DomPDF\Facade\Pdf;

$pdf = Pdf::loadView('pdf.invoice', $data);
return $pdf->download('invoice.pdf');
```

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

### ServiceProvider defer property

Source: https://github.com/barryvdh/laravel-dompdf/blob/master/_autodocs/api-reference/service-provider.md

Indicates that the provider is not deferred and runs immediately at boot time.

```php
/**
 * Indicates if loading of the provider is deferred.
 *
 * @var bool
 */
protected $defer = false;
```

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

### Pdf::loadView() and download()

Source: https://github.com/barryvdh/laravel-dompdf/blob/master/_autodocs/api-reference/facade-pdf.md

Loads a view and returns a PDF instance, then downloads the PDF as a file. The facade forwards the call to the underlying wrapper.

```APIDOC
## Pdf::loadView() and download()

### Description
Loads a view and returns a PDF instance, then downloads the PDF as a file. The facade forwards the call to the underlying wrapper.

### Method
Static method call via facade

### Endpoint
Pdf::loadView(view: string, data: array) : PDF
Pdf::download(filename: string) : Response

### Parameters
#### Method Parameters
- **view** (string) - Required - The view name to load.
- **data** (array) - Optional - Data to pass to the view.
- **filename** (string) - Required - The filename for the downloaded PDF.

### Request Example
```php
use Barryvdh\DomPDF\Facade\Pdf;

return Pdf::loadView('pdf.invoice', compact('invoice'))->download('invoice.pdf');
```

### Response
#### Success Response
Returns a PDF download response.

#### Response Example
```php
return Pdf::loadView('pdf.invoice', compact('invoice'))->download('invoice.pdf');
```
```

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

### Pdf::loadHTML(), setWarnings(), output() with error handling

Source: https://github.com/barryvdh/laravel-dompdf/blob/master/_autodocs/api-reference/facade-pdf.md

Shows how to handle exceptions thrown by the facade, including rendering warnings and unknown method calls.

```APIDOC
## Pdf::loadHTML(), setWarnings(), output() with error handling

### Description
Shows how to handle exceptions thrown by the facade, including rendering warnings and unknown method calls.

### Method
Static method call via facade

### Endpoint
Pdf::loadHTML(html: string) : PDF
Pdf::setWarnings(bool) : PDF
Pdf::output() : string

### Parameters
#### Method Parameters
- **html** (string) - Required - The HTML content to convert to PDF.
- **bool** (bool) - Required - Whether to enable warnings.

### Request Example
```php
use Barryvdh\DomPDF\Facade\Pdf;

try {
    $bytes = Pdf::loadHTML($html)->setWarnings(true)->output();
} catch (\Exception $e) {
    // render warnings (setWarnings(true)) or engine failures
}
```

### Response
#### Success Response
Returns the PDF content as a string (bytes).

#### Error Response
- **\Exception** - Thrown when rendering warnings or engine failures occur.
- **\UnexpectedValueException** - Thrown when an unknown method is called on the facade.

#### Response Example
```php
try {
    $bytes = Pdf::loadHTML($html)->setWarnings(true)->output();
} catch (\Exception $e) {
    // render warnings (setWarnings(true)) or engine failures
}
```
```

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

### Publishing the configuration file

Source: https://github.com/barryvdh/laravel-dompdf/blob/master/_autodocs/api-reference/service-provider.md

Run this artisan command to publish the package configuration file to your application's config directory.

```bash
php artisan vendor:publish --provider="Barryvdh\DomPDF\ServiceProvider"
```

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

### Chain PDF methods

Source: https://github.com/barryvdh/laravel-dompdf/blob/master/readme.md

Load a file, save it to a path, and stream the output.

```php
return Pdf::loadFile(public_path().'/myfile.html')->save('/path-to/my_stored_file.pdf')->stream('download.pdf');
```

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

### Available Facade Methods

Source: https://github.com/barryvdh/laravel-dompdf/blob/master/_autodocs/api-reference/facade-pdf.md

A list of @method annotations available through the PDF facade, mapping to the underlying PDF class methods.

```php
@method static BasePDF setBaseHost(string $baseHost)
@method static BasePDF setBasePath(string $basePath)
@method static BasePDF setCanvas(\Dompdf\Canvas $canvas)
@method static BasePDF setCallbacks(array<string, mixed> $callbacks)
@method static BasePDF setCss(\Dompdf\Css\Stylesheet $css)
@method static BasePDF setDefaultView(string $defaultView, array<string, mixed> $options)
@method static BasePDF setDom(\DOMDocument $dom)
@method static BasePDF setFontMetrics(\Dompdf\FontMetrics $fontMetrics)
@method static BasePDF setHttpContext(resource|array<string, mixed> $httpContext)
@method static BasePDF setPaper(string|float[] $paper, string $orientation = 'portrait')
@method static BasePDF setProtocol(string $protocol)
@method static BasePDF setTree(\Dompdf\Frame\FrameTree $tree)
@method static BasePDF setWarnings(bool $warnings)
@method static BasePDF setOption(array<string, mixed>|string $attribute, $value = null)
@method static BasePDF setOptions(array<string, mixed> $options)
@method static BasePDF loadView(string $view, array<string, mixed> $data = [], array<string, mixed> $mergeData = [], ?string $encoding = null)
@method static BasePDF loadHTML(string $string, ?string $encoding = null)
@method static BasePDF loadFile(string $file)
@method static BasePDF addInfo(array<string, string> $info)
@method static BasePDF setPdfA(bool $enabled = true)
@method static BasePDF addEmbeddedFile(string $filePath, string $name, string $description = '', string $mimeType = 'text/xml')
@method static BasePDF setAdditionalXmpRdf(string $xmpRdf)
@method static string output(array<string, int> $options = [])
@method static BasePDF save()
@method static \Illuminate\Http\Response download(string $filename = 'document.pdf')
@method static \Illuminate\Http\Response stream(string $filename = 'document.pdf')
```

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

### provides() return values

Source: https://github.com/barryvdh/laravel-dompdf/blob/master/_autodocs/api-reference/service-provider.md

Returns the array of binding names registered by the provider.

```php
return ['dompdf', 'dompdf.options', 'dompdf.wrapper'];
```

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

### Handling facade exceptions

Source: https://github.com/barryvdh/laravel-dompdf/blob/master/_autodocs/api-reference/facade-pdf.md

Illustrates catching exceptions during PDF generation, such as engine failures when warnings are enabled or calling non-existent methods.

```php
// Error handling: facade exceptions
use Barryvdh\DomPDF\Facade\Pdf;

try {
    $bytes = Pdf::loadHTML($html)->setWarnings(true)->output();
} catch (\Exception $e) {
    // render warnings (setWarnings(true)) or engine failures
}

// Unknown forwarded method name
try {
    Pdf::doesNotExist();
} catch (\UnexpectedValueException $e) {
    // "Method [doesNotExist] does not exist on PDF instance."
}
```

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

### Set PDF Options

Source: https://github.com/barryvdh/laravel-dompdf/blob/master/resources/boost/skills/laravel-dompdf/references/example.md

Configure global PDF settings like DPI and default fonts before loading the view.

```php
use Barryvdh\DomPDF\Facade\Pdf;

return Pdf::setOption([
        'dpi' => 150,
        'defaultFont' => 'DejaVu Sans',
    ])
    ->loadView('pdf.invoice', ['invoice' => $invoice])
    ->setPaper('a4', 'landscape')
    ->download('invoice.pdf');
```

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

### Facade application check

Source: https://github.com/barryvdh/laravel-dompdf/blob/master/_autodocs/errors.md

Internal check to ensure the facade application is booted before calling methods.

```php
if (! $app) {
    throw new RuntimeException('Facade application has not been set.');
}
```

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

### Resolving a wrapper instance

Source: https://github.com/barryvdh/laravel-dompdf/blob/master/_autodocs/api-reference/pdf.md

Shows how to obtain a PDF wrapper instance using the Pdf facade or the application container. This is the recommended way to create PDF instances instead of calling the constructor directly.

```APIDOC
## Resolving a wrapper instance

### Description
Demonstrates how to get a PDF wrapper instance through the facade or the app container. The facade is the common path for most usage.

### Usage Example
use Barryvdh\DomPDF\Facade\Pdf;

// Facade (the common path)
$pdf = Pdf::loadHTML('<h1>Test</h1>');

// App container: $pdf = app()->make('dompdf.wrapper');
```

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

### Pdf::loadView() with named arguments

Source: https://github.com/barryvdh/laravel-dompdf/blob/master/_autodocs/api-reference/facade-pdf.md

Demonstrates using named arguments with the facade methods, which are supported through PHP's named argument feature.

```APIDOC
## Pdf::loadView() with named arguments

### Description
Demonstrates using named arguments with the facade methods, which are supported through PHP's named argument feature.

### Method
Static method call via facade

### Endpoint
Pdf::loadView(view: string, data: array) : PDF
Pdf::download(filename: string) : Response

### Parameters
#### Method Parameters
- **view** (string) - Required - The view name to load.
- **data** (array) - Optional - Data to pass to the view.
- **filename** (string) - Required - The filename for the downloaded PDF.

### Request Example
```php
return Pdf::loadView(view: 'pdf.report', data: ['title' => 'Monthly'])
    ->download(filename: 'report.pdf');
```

### Response
#### Success Response
Returns a PDF download response.

#### Response Example
```php
return Pdf::loadView(view: 'pdf.report', data: ['title' => 'Monthly'])
    ->download(filename: 'report.pdf');
```
```

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

### Configure Lumen for Dompdf

Source: https://github.com/barryvdh/laravel-dompdf/blob/master/readme.md

Add this line to bootstrap/app.php to enable the configuration file.

```php
$app->configure('dompdf');
```

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

### Pdf::loadHTML() and stream()

Source: https://github.com/barryvdh/laravel-dompdf/blob/master/_autodocs/api-reference/facade-pdf.md

Loads an HTML string and returns a PDF instance, then streams the PDF to the browser. The facade forwards the call to the underlying wrapper.

```APIDOC
## Pdf::loadHTML() and stream()

### Description
Loads an HTML string and returns a PDF instance, then streams the PDF to the browser. The facade forwards the call to the underlying wrapper.

### Method
Static method call via facade

### Endpoint
Pdf::loadHTML(html: string) : PDF
Pdf::stream() : Response

### Parameters
#### Method Parameters
- **html** (string) - Required - The HTML content to convert to PDF.

### Request Example
```php
return \PDF::loadHTML('<h1>Test</h1>')->stream();
```

### Response
#### Success Response
Returns a PDF stream response.

#### Response Example
```php
return \PDF::loadHTML('<h1>Test</h1>')->stream();
```
```

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

### PDF::__construct(Dompdf $dompdf, ConfigRepository $config, Filesystem $files, ViewFactory $view)

Source: https://github.com/barryvdh/laravel-dompdf/blob/master/_autodocs/api-reference/pdf.md

Constructor for the PDF wrapper class. It initializes the wrapper with the underlying Dompdf engine, Laravel config, filesystem, and view factory. This is normally not called directly; instances are resolved via the facade or container.

```APIDOC
## Constructor

### Description
Initializes the PDF wrapper with the underlying Dompdf engine, Laravel config repository, filesystem, and view factory. Reads the 'dompdf.show_warnings' config value into the internal $showWarnings property.

### Signature
public function __construct(Dompdf $dompdf, ConfigRepository $config, Filesystem $files, ViewFactory $view)

### Parameters
- **$dompdf** (\Dompdf\Dompdf) - Required - Underlying Dompdf engine instance (bound as 'dompdf' in the container)
- **$config** (\Illuminate\Contracts\Config\Repository) - Required - Laravel config repository; reads 'dompdf.show_warnings' (default false) into $showWarnings
- **$files** (\Illuminate\Filesystem\Filesystem) - Required - Filesystem abstraction used by save() for local writes
- **$view** (\Illuminate\Contracts\View\Factory) - Required - View factory used by loadView()

### Return Type
PDF (instance)

### Throws
None.

### Notes
$showWarnings is initialized from config('dompdf.show_warnings', false). The normal construction path is the 'dompdf.wrapper' binding in the ServiceProvider, which passes $app['dompdf'], $app['config'], $app['files'] and $app['view'].
```

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

### output() method signature

Source: https://github.com/barryvdh/laravel-dompdf/blob/master/_autodocs/api-reference/pdf.md

Signature of the output() method. It accepts an optional array of output options, with 'compress' documented as 1|0. Returns the PDF as a string.

```php
public function output(array $options = []): string
```

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

### Generate PDF using App container

Source: https://github.com/barryvdh/laravel-dompdf/blob/master/readme.md

Use the App container to load HTML and stream the PDF.

```php
$pdf = App::make('dompdf.wrapper');
$pdf->loadHTML('<h1>Test</h1>');
return $pdf->stream();
```

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

### Resolving a PDF wrapper instance

Source: https://github.com/barryvdh/laravel-dompdf/blob/master/_autodocs/api-reference/pdf.md

Demonstrates the common usage of the Pdf facade to load HTML content. Alternatively, the instance can be resolved from the application container using the dompdf.wrapper alias.

```php
use Barryvdh\DomPDF\Facade\Pdf;

// Facade (the common path)
$pdf = Pdf::loadHTML('<h1>Test</h1>');

// App container: $pdf = app()->make('dompdf.wrapper');
```

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

### Handling non-existent methods

Source: https://github.com/barryvdh/laravel-dompdf/blob/master/_autodocs/api-reference/pdf.md

Demonstrates the exception thrown when attempting to call a method that does not exist on the PDF instance or the underlying Dompdf object.

```php
try {
    Pdf::loadHTML($html)->setUnknownOptionXYZ('value');
} catch (\UnexpectedValueException $e) {
    // "Method [setUnknownOptionXYZ] does not exist on PDF instance."
}
```

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

### provides() method definition

Source: https://github.com/barryvdh/laravel-dompdf/blob/master/_autodocs/api-reference/service-provider.md

Defines the provides method signature.

```php
public function provides(): array
```

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

### setOptions() method signature

Source: https://github.com/barryvdh/laravel-dompdf/blob/master/_autodocs/api-reference/pdf.md

Signature of the setOptions() method. It accepts an array of options and an optional boolean to merge with defaults. Returns self for fluent chaining.

```php
public function setOptions(array $options, bool $mergeWithDefaults = false): self
```

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

### Basic PDF Download

Source: https://github.com/barryvdh/laravel-dompdf/blob/master/resources/boost/skills/laravel-dompdf/SKILL.md

Generates a PDF from a Blade view and triggers a browser download.

```php
use Barryvdh\DomPDF\Facade\Pdf;

return Pdf::loadView('pdf.invoice', [
    'order' => $order,
])->download('invoice.pdf');
```

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

### Download PDF response

Source: https://github.com/barryvdh/laravel-dompdf/blob/master/_autodocs/api-reference/pdf.md

Returns an Illuminate\Http\Response to trigger a browser download of the PDF.

```php
return Pdf::loadView('pdf.invoice', $data)->download('invoice.pdf');
```

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

### Load HTML file with loadFile()

Source: https://github.com/barryvdh/laravel-dompdf/blob/master/_autodocs/api-reference/pdf.md

Loads an HTML file from the specified path and returns a fluent instance. The method is subject to Dompdf's chroot file path constraints.

```php
return Pdf::loadFile(public_path('assets/report.html'))
    ->setPaper('a4', 'landscape')
    ->stream('report.pdf');
```

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

### Enable PDF/A-3b per-PDF at runtime

Source: https://github.com/barryvdh/laravel-dompdf/blob/master/readme.md

Enable PDF/A-3b compliance for a specific PDF instance using the setPdfA method.

```php
    $pdf = Pdf::loadView('invoice', $data)
        ->setPdfA()
        ->download('invoice.pdf');
```

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

### output()

Source: https://github.com/barryvdh/laravel-dompdf/blob/master/_autodocs/api-reference/pdf.md

Renders the PDF if not already rendered and returns the PDF as a byte string. Can throw exceptions if warnings are enabled and Dompdf warnings exist, or on render/output failures.

```APIDOC
## output()

### Description
Renders the PDF if not already rendered and returns the PDF as a byte string. Can throw exceptions if warnings are enabled and Dompdf warnings exist, or on render/output failures.

### Method
output

### Signature
public function output(array $options = []): string

### Parameters
- **$options** (array<string, int>) - Optional, default: [] - Output options; docblock documents 'compress' => 1|0 (content stream compression, on by default).

### Return Type
string - the rendered PDF as a byte string.

### Behavior
Lazy render guard: calls render() if $rendered is false, then (string) $this->dompdf->output($options).

### Throws
\Exception from render() if setWarnings(true) and Dompdf warnings exist; whatever Dompdf throws on render/output failures.

### Example
```php
$pdf = Pdf::loadView('mail.attachment', $data);
$bytes = $pdf->output();            // raw PDF string
Mail::to($user)->send(new InvoiceMail($bytes));
```

### Example (Error handling)
```php
// Error handling when warnings are enabled
$pdf = Pdf::loadHTML($html)->setWarnings(true);
try {
    $bytes = $pdf->output();
} catch (\Exception $e) {
    Log::error('PDF render failed', ['warnings' => $e->getMessage()]);
}
```
```

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

### Package Module Graph

Source: https://github.com/barryvdh/laravel-dompdf/blob/master/_autodocs/api-reference/index.md

Visual representation of the package's internal structure, container bindings, and class relationships.

```text
composer.json (auto-discovery)
        │
        ▼
src/ServiceProvider.php ── registers container bindings:
        ├── 'dompdf.options' ──► array<string, mixed> (config-driven Options)
        ├── 'dompdf'          ──► \Dompdf\Dompdf
        ├── alias 'dompdf'    ──► \Dompdf\Dompdf::class
        └── 'dompdf.wrapper'  ──► \Barryvdh\DomPDF\PDF
                                   │
src/Facade/Pdf.php ◄── 'dompdf.wrapper' (PDF) ── exposes statically
        │
        ▼
src/PDF.php (wraps \Dompdf\Dompdf)
        │
        ▼
config/dompdf.php (read via ConfigRepository; published via boot())
```

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

### loadView()

Source: https://github.com/barryvdh/laravel-dompdf/blob/master/_autodocs/api-reference/pdf.md

Renders a view and loads the resulting HTML into the PDF generator. The method accepts a view name, optional data, merge data, and encoding. It returns self for fluent chaining.

```APIDOC
## loadView()

### Description
Renders a view and loads the resulting HTML into the PDF generator. The method accepts a view name, optional data, merge data, and encoding. It returns self for fluent chaining.

### Method
loadView

### Signature
public function loadView(string $view, array $data = [], array $mergeData = [], ?string $encoding = null): self

### Parameters
- **$view** (string) - Required - View name/identifier passed to the view factory
- **$data** (array<string, mixed>) - Optional - Data made available to the view (default: [])
- **$mergeData** (array<string, mixed>) - Optional - Additional data merged by the view factory (default: [])
- **$encoding** (?string) - Optional - Passed through to loadHTML() (default: null)

### Return Type
self - fluent

### Behavior
$html = $this->view->make($view, $data, $mergeData)->render(); then delegates to loadHTML($html, $encoding).

### Throws
None directly; the view factory may throw if the view is missing.

### Example
```php
use Barryvdh\DomPDF\Facade\Pdf;

public function downloadInvoice(Invoice $invoice): \Illuminate\Http\Response
{
    $data = ['number' => 'INV-1001', 'customer' => 'Acme Ltd.', 'total' => 199.99];
    return Pdf::loadView('pdf.invoice', $data)->download('invoice.pdf');
}
```
```

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

### render()

Source: https://github.com/barryvdh/laravel-dompdf/blob/master/_autodocs/api-reference/pdf.md

Eagerly renders the PDF by calling the underlying Dompdf render method. Optionally throws an exception if warnings are present and showWarnings is enabled.

```APIDOC
## render()

### Description
Eagerly renders the PDF by calling the underlying Dompdf render method. Optionally throws an exception if warnings are present and showWarnings is enabled.

### Method
render

### Signature
public function render(): void

### Parameters
None

### Return Type
void

### Behavior
- Calls $this->dompdf->render()
- If $showWarnings is truthy and global $_dompdf_warnings is non-empty, concatenates the messages (each followed by "\n") and throws new Exception($warnings)
- Otherwise sets $rendered = true

### Throws
\Exception (global namespace) when warnings are shown and present

### Example
```php
$pdf = Pdf::loadHTML($html);
$pdf->render();                 // eager render
$pdf->addEmbeddedFile($xml, 'factur-x.xml', 'Factur-X Invoice', 'text/xml');
return $pdf->download('invoice.pdf');
```
```

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

### Full default configuration array

Source: https://github.com/barryvdh/laravel-dompdf/blob/master/_autodocs/configuration.md

The complete default configuration structure for laravel-dompdf, defining paths, protocols, and PDF rendering options.

```php
return [

    'show_warnings' => false,   // Throw an Exception on warnings from dompdf

    'public_path' => null,  // Override the public path if needed

    'convert_entities' => true,

    'pdfa' => [
        'enabled' => false,
    ],

    'options' => [
        'font_dir' => storage_path('fonts'),
        'font_cache' => storage_path('fonts'),
        'temp_dir' => sys_get_temp_dir(),
        'chroot' => realpath(base_path()),
        'allowed_protocols' => [
            'data://' => ['rules' => []],
            'file://' => ['rules' => []],
            'http://' => ['rules' => []],
            'https://' => ['rules' => []],
        ],
        'artifactPathValidation' => null,
        'log_output_file' => null,
        'enable_font_subsetting' => false,
        'pdf_backend' => 'CPDF',
        'default_media_type' => 'screen',
        'default_paper_size' => 'a4',
        'default_paper_orientation' => 'portrait',
        'default_font' => 'serif',
        'dpi' => 96,
        'enable_php' => false,
        'enable_javascript' => true,
        'enable_remote' => false,
        'allowed_remote_hosts' => null,
        'font_height_ratio' => 1.1,
        'enable_html5_parser' => true,
    ],

];
```

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

### Customize PDF settings

Source: https://github.com/barryvdh/laravel-dompdf/blob/master/readme.md

Set paper orientation, size, and warnings before saving.

```php
Pdf::loadHTML($html)->setPaper('a4', 'landscape')->setWarnings(false)->save('myfile.pdf')
```

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

### Pdf::__callStatic($method, $args)

Source: https://github.com/barryvdh/laravel-dompdf/blob/master/_autodocs/api-reference/facade-pdf.md

Static magic method that forwards calls to a new PDF instance resolved from the facade application. Throws RuntimeException if no facade application is set.

```APIDOC
## Pdf::__callStatic($method, $args)

### Description
Static magic method that forwards calls to a new PDF instance resolved from the facade application. Throws RuntimeException if no facade application is set.

### Method
__callStatic (static magic method)

### Signature
public static function __callStatic($method, $args)

### Parameters
- **$method** (string) - Required - Method name to invoke on the wrapper
- **$args** (array<mixed>) - Required - Arguments (named arguments are preserved)

### Return Type
mixed - whatever the wrapper method returns (usually \Barryvdh\DomPDF\PDF for fluent methods, string for output(), \Illuminate\Http\Response for download()/stream())

### Throws
- \RuntimeException('Facade application has not been set.') when no facade application is registered

### Behavior
- A missing facade application throws immediately.
- A new instance is resolved on every call - $app->make() is not cached, so each static call gets a fresh PDF from the dompdf.wrapper binding.
- ...$args unpacking supports named arguments from PHP call sites.

### Methods Available Through the Facade
All methods are static and map to corresponding \Barryvdh\DomPDF\PDF methods.

| Method | Applies to | Returns |
|---|---|---|
| loadView, loadHTML, loadFile | loading input | \Barryvdh\DomPDF\PDF |
| setPaper, setOption, setOptions, setWarnings, setPdfA | configuration | \Barryvdh\DomPDF\PDF |
| addInfo, addEmbeddedFile, setAdditionalXmpRdf | metadata/attachments | \Barryvdh\DomPDF\PDF |
| output | rendering output | string |
| save | rendering output | \Barryvdh\DomPDF\PDF |
| download, stream | HTTP responses | \Illuminate\Http\Response |

### Full Method List
- setBaseHost(string $baseHost): BasePDF
- setBasePath(string $basePath): BasePDF
- setCanvas(\Dompdf\Canvas $canvas): BasePDF
- setCallbacks(array<string, mixed> $callbacks): BasePDF
- setCss(\Dompdf\Css\Stylesheet $css): BasePDF
- setDefaultView(string $defaultView, array<string, mixed> $options): BasePDF
- setDom(\DOMDocument $dom): BasePDF
- setFontMetrics(\Dompdf\FontMetrics $fontMetrics): BasePDF
- setHttpContext(resource|array<string, mixed> $httpContext): BasePDF
- setPaper(string|float[] $paper, string $orientation = 'portrait'): BasePDF
- setProtocol(string $protocol): BasePDF
- setTree(\Dompdf\Frame\FrameTree $tree): BasePDF
- setWarnings(bool $warnings): BasePDF
- setOption(array<string, mixed>|string $attribute, $value = null): BasePDF
- setOptions(array<string, mixed> $options): BasePDF
- loadView(string $view, array<string, mixed> $data = [], array<string, mixed> $mergeData = [], ?string $encoding = null): BasePDF
- loadHTML(string $string, ?string $encoding = null): BasePDF
- loadFile(string $file): BasePDF
- addInfo(array<string, string> $info): BasePDF
- setPdfA(bool $enabled = true): BasePDF
- addEmbeddedFile(string $filePath, string $name, string $description = '', string $mimeType = 'text/xml'): BasePDF
- setAdditionalXmpRdf(string $xmpRdf): BasePDF
- output(array<string, int> $options = []): string
- save(): BasePDF
- download(string $filename = 'document.pdf'): \Illuminate\Http\Response
- stream(string $filename = 'document.pdf'): \Illuminate\Http\Response

Note: setEncryption() is not annotated on the facade, but since __callStatic forwards any method, Pdf::setEncryption(...) is callable - it returns void, so it cannot be chained after.
```

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

### Enable PDF/A-3b globally in config/dompdf.php

Source: https://github.com/barryvdh/laravel-dompdf/blob/master/readme.md

Configure the PDF/A-3b setting globally within the dompdf configuration file.

```php
    'pdfa' => [
        'enabled' => true,
    ],
```

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

### Enable Remote Images

Source: https://github.com/barryvdh/laravel-dompdf/blob/master/resources/boost/skills/laravel-dompdf/references/example.md

Configure remote asset loading. This is disabled by default in version 3.x for security.

```php
Pdf::setOption([
    'isRemoteEnabled' => true,
    'allowedRemoteHosts' => ['example.com'],
]);
```

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

### loadHTML()

Source: https://github.com/barryvdh/laravel-dompdf/blob/master/_autodocs/api-reference/pdf.md

Loads HTML markup for PDF rendering. Runs convertEntities() on the string first and resets the internal rendered flag.

```APIDOC
## loadHTML()

### Description
Loads HTML markup to render into a PDF. Runs convertEntities() on the string first and resets the internal $rendered flag to false, then calls Dompdf::loadHtml().

### Method
GET

### Endpoint
Pdf::loadHTML(string $string, ?string $encoding = null)

### Parameters
#### Path Parameters
- **$string** (string) - Required - HTML markup to render
- **$encoding** (?string) - Optional - Character encoding, passed through to Dompdf::loadHtml() (docblock comment: "Not used yet")

### Request Example
```php
$pdf = Pdf::loadHTML('<h1>Hello PDF</h1><p>Rendered from a string.</p>');
return $pdf->download('hello.pdf');
```

### Response
#### Success Response
- **Return type:** self — fluent

#### Response Example
```php
$pdf = Pdf::loadHTML('<h1>Hello PDF</h1>');
```
```

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

### Registering the Service Provider manually for Lumen

Source: https://github.com/barryvdh/laravel-dompdf/blob/master/_autodocs/api-reference/service-provider.md

Use this command to register the provider manually in a Lumen application.

```php
$app->register(\Barryvdh\DomPDF\ServiceProvider::class);
```

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

### setOptions()

Source: https://github.com/barryvdh/laravel-dompdf/blob/master/_autodocs/api-reference/pdf.md

Sets Dompdf options. By default, it replaces all existing options, but can merge with defaults if the $mergeWithDefaults parameter is set to true. Returns the instance for fluent chaining.

```APIDOC
## setOptions()

### Description
Sets the Dompdf options. By default, it replaces the entire options object, but can merge with container-resolved defaults if $mergeWithDefaults is true. Returns the instance for fluent chaining.

### Method
setOptions

### Signature
public function setOptions(array $options, bool $mergeWithDefaults = false): self

### Parameters
- **$options** (array<string, mixed>) - Required - Options that replace the entire Dompdf Options object.
- **$mergeWithDefaults** (bool) - Optional, default: false - If true, merges $options over the container-resolved defaults from app()->make('dompdf.options') before constructing Options.

### Return Type
self - fluent.

### Behavior
Rebuilds new \Dompdf\Options($options) and calls $this->dompdf->setOptions(...). Without $mergeWithDefaults = true all previously configured options are replaced.

### Throws
None.

### Example
```php
// Keep defaults (font_dir, chroot, ...) and override selectively
Pdf::loadHTML($html)->setOptions(['dpi' => 150], true)->download('x.pdf');
```
```

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

### Render PDF and Add Embedded File

Source: https://github.com/barryvdh/laravel-dompdf/blob/master/_autodocs/api-reference/pdf.md

Performs an eager render of the PDF and adds an embedded file before downloading.

```php
$pdf = Pdf::loadHTML($html);
$pdf->render();                 // eager render
$pdf->addEmbeddedFile($xml, 'factur-x.xml', 'Factur-X Invoice', 'text/xml');
return $pdf->download('invoice.pdf');
```

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

### Constructor signature for PDF class

Source: https://github.com/barryvdh/laravel-dompdf/blob/master/_autodocs/api-reference/pdf.md

The constructor requires the Dompdf engine, Laravel config repository, filesystem, and view factory. It is typically handled by the service provider via the dompdf.wrapper container alias.

```php
public function __construct(Dompdf $dompdf, ConfigRepository $config, Filesystem $files, ViewFactory $view)
```

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

### Add PDF metadata with addInfo()

Source: https://github.com/barryvdh/laravel-dompdf/blob/master/_autodocs/api-reference/pdf.md

Adds metadata to the PDF document using a key-value map. This method is fluent and can be chained with other PDF operations.

```php
return Pdf::loadView('pdf.invoice', compact('invoice'))
    ->addInfo(['Title' => 'Invoice ' . $invoice['number'], 'Author' => 'Acme Ltd.'])
    ->download('invoice.pdf');
```

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

### Render Laravel views with loadView()

Source: https://github.com/barryvdh/laravel-dompdf/blob/master/_autodocs/api-reference/pdf.md

Renders a Laravel view into HTML and loads it into the PDF instance. It accepts view data and optional encoding settings.

```php
use Barryvdh"></DomPDF"></Facade"></Pdf;

public function downloadInvoice(Invoice $invoice): \Illuminate\Http\Response
{
    $data = ['number' => 'INV-1001', 'customer' => 'Acme Ltd.', 'total' => 199.99];
    return Pdf::loadView('pdf.invoice', $data)->download('invoice.pdf');
}
```

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

### Generate PDF/A

Source: https://github.com/barryvdh/laravel-dompdf/blob/master/resources/boost/skills/laravel-dompdf/references/example.md

Create a PDF/A compliant document. Note that this requires embedded fonts like DejaVu Sans.

```php
use Barryvdh\DomPDF\Facade\Pdf;

return Pdf::loadView('pdf.archive-invoice', ['invoice' => $invoice])
    ->setPdfA()
    ->download('archive-invoice.pdf');
```

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

### Loading HTML content with loadHTML()

Source: https://github.com/barryvdh/laravel-dompdf/blob/master/_autodocs/api-reference/pdf.md

Use loadHTML() to load HTML markup for rendering. It automatically converts entities and resets the internal render state.

```php
$pdf = Pdf::loadHTML('<h1>Hello PDF</h1><p>Rendered from a string.</p>');
return $pdf->download('hello.pdf');
```

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

### setOption() method signature

Source: https://github.com/barryvdh/laravel-dompdf/blob/master/_autodocs/api-reference/pdf.md

Method signature for setting Dompdf options. Accepts either a string option name or an array of options. Writes directly to the live Dompdf Options object.

```php
public function setOption($attribute, $value = null): self
```

```php
/** @param array<string, mixed>|string $attribute */
```

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

### Stream PDF in Browser

Source: https://github.com/barryvdh/laravel-dompdf/blob/master/resources/boost/skills/laravel-dompdf/references/example.md

Use the stream method to display the PDF directly in the browser instead of triggering a download.

```php
use Barryvdh\DomPDF\Facade\Pdf;

return Pdf::loadView('pdf.report', [
    'title' => 'Monthly Report',
])->stream('monthly-report.pdf');
```

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

### Generate PDF from HTML String

Source: https://github.com/barryvdh/laravel-dompdf/blob/master/resources/boost/skills/laravel-dompdf/references/example.md

Generate a PDF directly from a raw HTML string and set paper size and orientation.

```php
use Barryvdh\DomPDF\Facade\Pdf;

$html = '<h1>Hello PDF</h1><p>This PDF was generated from HTML.</p>';

return Pdf::loadHTML($html)
    ->setPaper('a4', 'portrait')
    ->download('example.pdf');
```

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

### setWarnings()

Source: https://github.com/barryvdh/laravel-dompdf/blob/master/_autodocs/api-reference/pdf.md

Sets whether render() should throw an exception if Dompdf collected warnings. Returns the PDF instance for fluent chaining.

```APIDOC
## setWarnings()

### Description
Sets whether render() will throw an \Exception if Dompdf collected warnings. Overrides the runtime default from config('dompdf.show_warnings', false).

### Method
GET

### Endpoint
Pdf::setWarnings(bool $warnings)

### Parameters
#### Path Parameters
- **$warnings** (bool) - Required - When true, render() will throw an \Exception if Dompdf collected warnings

### Request Example
```php
return Pdf::loadHTML($html)
    ->setWarnings(false)            // suppress warning exceptions
    ->save('myfile.pdf');
```

### Response
#### Success Response
- **Return type:** self (PDF) — fluent

#### Response Example
```php
$pdf = Pdf::loadHTML($html)->setWarnings(false);
```
```

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

### Binding dompdf.options

Source: https://github.com/barryvdh/laravel-dompdf/blob/master/_autodocs/api-reference/service-provider.md

This binding processes configuration options, handling legacy defines or standard options, and enabling PDF/A support if configured.

```php
$this->app->bind('dompdf.options', function ($app) {
    $defines = $app['config']->get('dompdf.defines');

    if ($defines) {
        $options = [];
        foreach ($defines as $key => $value) {
            $key = strtolower(str_replace('DOMPDF_', '', $key));
            $options[$key] = $value;
        }
    } else {
        $options = $app['config']->get('dompdf.options');
    }

    if ($app['config']->get('dompdf.pdfa.enabled')) {
        $options['isPdfAEnabled'] = true;
    }

    return $options;
});
```

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

### Binding dompdf engine

Source: https://github.com/barryvdh/laravel-dompdf/blob/master/_autodocs/api-reference/service-provider.md

Constructs the Dompdf instance and sets the base path, throwing a RuntimeException if the public path cannot be resolved.

```php
$this->app->bind('dompdf', function ($app) {
    $options = $app->make('dompdf.options');
    $dompdf = new Dompdf($options);
    $path = realpath($app['config']->get('dompdf.public_path') ?: base_path('public'));
    if ($path === false) {
        throw new \RuntimeException('Cannot resolve public path');
    }
    $dompdf->setBasePath($path);

    return $dompdf;
});
```

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

### Download PDF with non-ASCII filename

Source: https://github.com/barryvdh/laravel-dompdf/blob/master/_autodocs/api-reference/pdf.md

Demonstrates how the download method handles non-ASCII characters and percent signs in filenames using RFC 5987 fallback.

```php
// Filenames with non-ASCII or '%' get an RFC 5987 fallback:
return Pdf::loadHTML($html)->download('Faktúra 100%.pdf');
// Content-Disposition: attachment; filename=Faktura 100.pdf; filename*=utf-8''Fakt%C3%BAra%20100%25.pdf
```

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

### Save PDF to filesystem disk

Source: https://github.com/barryvdh/laravel-dompdf/blob/master/_autodocs/api-reference/pdf.md

Saves the PDF to a configured Laravel filesystem disk or a globally configured disk.

```php
// Save to a filesystem disk
Pdf::loadView('pdf.invoice', $data)->save('invoices/invoice-1001.pdf', 'local');

// Or configure globally, then save without an explicit disk
// config/dompdf.php: 'disk' => 's3'   (custom key read by save())
Pdf::loadView('pdf.invoice', $data)->save('invoices/invoice-1001.pdf');
```

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

### Unknown forwarded method exception

Source: https://github.com/barryvdh/laravel-dompdf/blob/master/_autodocs/errors.md

Exception thrown when a method does not exist on the PDF instance or is not a valid forwarded method.

```php
throw new \UnexpectedValueException("Method [{$method}] does not exist on PDF instance.");
```

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

### Configuring warning behavior with setWarnings()

Source: https://github.com/barryvdh/laravel-dompdf/blob/master/_autodocs/api-reference/pdf.md

Use setWarnings() to toggle whether render() throws an exception when Dompdf collects warnings. This method provides a fluent interface.

```php
return Pdf::loadHTML($html)
    ->setWarnings(false)            // suppress warning exceptions
    ->save('myfile.pdf');
```

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

### isLumen() implementation

Source: https://github.com/barryvdh/laravel-dompdf/blob/master/_autodocs/api-reference/service-provider.md

Implementation logic for checking if the application version string contains 'Lumen'.

```php
return Str::contains($this->app->version(), 'Lumen') === true;
```
Tokens:
Raw