Laravel Snappy

https://github.com/barryvdh/laravel-snappy
Admin
Laravel Snappy is a ServiceProvider wrapper for Snappy that enables easy PDF and image generation...
Tokens:41,216
Snippets:310
Trust Score:9.8
License:MIT
Update:1 month ago
Show doc for...
Tokens:
Raw
### Set binary path for composer-installed wkhtmltopdf

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

Example config/snappy.php line for binaries installed via composer.

```php
'binary' => base_path('vendor/h4cc/wkhtmltopdf-amd64/bin/wkhtmltopdf-amd64'),
```

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

### download() usage example

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

Example of using download() with a view and data to return a PDF response.

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

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

### Download image example

Source: https://github.com/barryvdh/laravel-snappy/blob/master/_autodocs/api-reference/image-wrapper.md

Example of returning an image as a downloadable response with a custom filename.

```php
return $img->download('avatar.jpg');
```

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

### Instantiating ImageWrapper

Source: https://github.com/barryvdh/laravel-snappy/blob/master/_autodocs/api-reference/image-wrapper.md

Example of manually creating an engine instance and injecting it into the ImageWrapper.

```php
$engine = new Barryvdh\Snappy\IlluminateSnappyImage(app['files'], '/usr/local/bin/wkhtmltoimage', [], []);
$wrapper = new Barryvdh\Snappy\ImageWrapper($engine);
```

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

### loadFile usage example

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

Shows how to load a file from a URL and output it inline.

```php
PDF::loadFile('http://www.github.com')->inline('github.pdf');
```

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

### ImageWrapper __call usage examples

Source: https://github.com/barryvdh/laravel-snappy/blob/master/_autodocs/api-reference/image-wrapper.md

Examples of using shortcut methods like html, view, and file, as well as forwarding a method call to the Knp\Snappy\Image engine.

```php
$img->html('<h1>Badge</h1>');    // loadHTML()
$img->view('badge.user', $data); // loadView()
$img->file('/tmp/badge.html');   // loadFile()
$img->setTimeout(20);            // forwarded to Knp\Snappy\Image
```

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

### Shortcut usage examples for __call

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

Examples of using the shortcuts: ->html calls loadHTML, ->view calls loadView, and ->file calls loadFile. These are direct calls on the PdfWrapper instance.

```php
$pdf->html('<h1>Test</h1>');     // shortcut for loadHTML()
$pdf->view('pdf.invoice', $data); // shortcut for loadView()
$pdf->file('/tmp/source.html');   // shortcut for loadFile()
```

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

### setOptions usage example

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

Example of bulk setting multiple wkhtmltopdf options using an array. Returns $this for chaining.

```php
$pdf->setOptions(['page-size' => 'A4', 'orientation' => 'landscape', 'margin-bottom' => 0]);
```

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

### Using snappy() to set binary

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

Example of retrieving the wrapper from the container and using snappy() to call setBinary() on the underlying engine.

```php
$wrapper = App::make('snappy.pdf.wrapper');
$wrapper->snappy()->setBinary('/usr/local/bin/wkhtmltopdf');
```

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

### SnappyImage facade usage example

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

Shows loading a view with the SnappyImage facade, setting an option, and returning the image inline as PNG.

```php
// SnappyImage facade
$image = SnappyImage::loadView('badge.user', ['name' => 'Ada'])->setOption('width', 512);
return $image->inline('ada.png');
```

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

### Set binary path for Vagrant-installed wkhtmltopdf

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

Example config/snappy.php line for binaries moved to /usr/local/bin.

```php
'binary'  => '/usr/local/bin/wkhtmltopdf-amd64',
```

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

### setPaper usage examples

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

Shows two usage examples: setting paper to 'letter' and setting paper to 'a4' with landscape orientation and saving.

```php
$pdf->setPaper('letter');
```

```php
// with orientation
$pdf->setPaper('a4', 'landscape')->save('out.pdf');
```

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

### Save image to file example

Source: https://github.com/barryvdh/laravel-snappy/blob/master/_autodocs/api-reference/image-wrapper.md

Example of loading a view and saving the resulting image to a specific path with overwrite enabled.

```php
$img->loadView('badge.user', $data)->save('/tmp/badge.png', true);
```

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

### save() usage examples

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

Two examples of using save(): one without overwrite and one with overwrite set to true to overwrite an existing file.

```php
$pdf->loadHTML('<h1>Invoice</h1>')->save('/tmp/invoice-42.pdf');
$pdf->save('/tmp/invoice-42.pdf', true); // overwrite existing file
```

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

### loadView usage example

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

Example of using the loadView method to load a PDF view with data.

```php
$pdf = PDF::loadView('view-pdf-order-shipping', ['order' => $order]);
```

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

### Install laravel-snappy via Composer

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

Require the package in composer.json and update composer.

```bash
composer require barryvdh/laravel-snappy
```

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

### Usage example for stream()

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

Example usage of stream() as a legacy streaming variant of inline().

```php
return $pdf->stream('report.pdf'); // legacy streaming variant of inline()
```

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

### loadHTML usage example

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

Shows how to load an HTML string and a rendered view object, then save or download the PDF.

```php
$pdf = App::make('snappy.pdf.wrapper');
$pdf->loadHTML('<h1>Bill</h1><p>You owe me money, dude.</p>');
$pdf->save('/tmp/bill-123.pdf');

// loading a rendered view object directly
$pdf->loadHTML(View::make('pdf.invoice', ['total' => 42.50]))->download('invoice.pdf');
```

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

### Instantiating IlluminateSnappyPdf

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

Example of manual instantiation using application configuration, including setting an optional timeout.

```php
$snappy = new IlluminateSnappyPdf($app['files'], $binary, $options, $env);
if (false !== $timeout) {
    $snappy->setTimeout($timeout);
}
```

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

### Generate PDF output with loadHTML

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

Example of using output() to get PDF bytes after loading HTML content. The returned string can be stored in a database or storage driver.

```php
$pdf = App::make('snappy.pdf.wrapper');
$pdf->loadHTML('<h1>Bill</h1>');
$content = $pdf->output(); // PDF bytes, e.g. to store in a database or storage driver
```

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

### assertDontSee usage example

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

Example of using assertDontSee to verify that a specific string does not appear in the response.

```php
PDF::assertDontSee('Internal error');
```

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

### assertViewHasAll usage examples

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

Demonstrates checking for specific key-value pairs or verifying the presence of keys in the view data.

```php
PDF::assertViewHasAll(['order_id' => 42, 'customer' => 'Ada']);
PDF::assertViewHasAll(['order_id', 'customer']); // presence-only for each key
```

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

### Forwarding to underlying Knp\Snappy\Pdf instance

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

Example of forwarding method calls to the underlying Knp\Snappy\Pdf instance, such as setTimeout and setBinary. These methods are not defined on the wrapper but are delegated to the engine.

```php
// forwarding to the underlying Knp\Snappy\Pdf instance
$pdf->setTimeout(30);      // engine method, forwarded
$pdf->setBinary('/usr/local/bin/wkhtmltopdf');
```

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

### setWarnings usage example (no-op)

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

Example call to the deprecated setWarnings method. It is a no-op kept for backwards compatibility.

```php
$pdf->setWarnings(false); // no-op, kept for backwards compatibility
```

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

### PDF facade usage examples

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

Shows typical usage of the PDF facade: loading a view and downloading, chaining loadFile with inline, and setting options before saving. Uses the global alias 'PDF'.

```php
// facade usage via the global alias (composer extra.laravel.aliases: PDF)
$pdf = PDF::loadView('pdf.invoice', $data);
return $pdf->download('invoice.pdf');

// chaining
return PDF::loadFile('http://www.github.com')->inline('github.pdf');

// options + save
PDF::loadHTML($html)
    ->setPaper('a4')
    ->setOrientation('landscape')
    ->setOption('margin-bottom', 0)
    ->save('myfile.pdf');
```

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

### inline method usage

Source: https://github.com/barryvdh/laravel-snappy/blob/master/_autodocs/api-reference/image-wrapper.md

Example of returning an image response with a custom filename.

```php
return $img->inline('receipt.png');
```

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

### assertSeeText usage example

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

Example of using assertSeeText to verify that a specific string appears in the HTML-stripped response.

```php
PDF::assertSeeText('Total: $42.00');
```

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

### Direct instantiation of PdfWrapper

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

Direct instantiation example: builds an IlluminateSnappyPdf engine with the filesystem and wkhtmltopdf binary path, then passes it to the PdfWrapper constructor.

```php
$snappy = new Barryvdh\Snappy\IlluminateSnappyPdf(app['files'], '/usr/local/bin/wkhtmltopdf', [], []);
$wrapper = new Barryvdh\Snappy\PdfWrapper($snappy);
```

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

### setOption usage examples

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

Shows setting a simple option and passing a Renderable (View) that is automatically rendered. Both calls return $this for chaining.

```php
$pdf->setOption('margin-bottom', 0);
$pdf->setOption('header-html', View::make('pdf.header', ['company' => 'ACME'])); // Renderable is rendered automatically
```

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

### Configure Windows binary path with embedded quotes

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

Example of setting the binary path for Windows environments using embedded quotes.

```php
'binary' => '"C:\\Program Files\\wkhtmltopdf\\bin\\wkhtmltopdf"',
```

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

### PDF fake test example

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

Example test using the PDF facade's fake method to assert that a view is used and contains specific text.

```php
<?php

namespace Tests\Feature;

use Tests\TestCase;
use PDF;

class ExampleTest extends TestCase
{
    public function testPrintOrderShipping()
    {
        PDF::fake();
        
        // Perform order shipping...
        
        PDF::assertViewIs('view-pdf-order-shipping');
        PDF::assertSee('Name');
    }
}
```

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

### setTemporaryFolder usage example

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

Creates a PDF wrapper, sets the temporary folder to a subdirectory of the system temp directory, loads HTML, and saves the PDF.

```php
$pdf = App::make('snappy.pdf.wrapper')->setTemporaryFolder(sys_get_temp_dir() . '/my-invoices');
$pdf->loadHTML('<h1>Bill</h1>')->save('/tmp/bill-123.pdf');
```

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

### assertDontSeeText usage example

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

Example of using assertDontSeeText to verify that a specific string does not appear in the HTML-stripped response.

```php
PDF::assertDontSeeText('draft');
```

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

### Container construction for IlluminateSnappyImage

Source: https://github.com/barryvdh/laravel-snappy/blob/master/_autodocs/api-reference/illuminate-snappy-image.md

Container construction example for the image service. It creates an instance with the application's filesystem and a default binary path, then sets a timeout if one is provided.

```php
$image = new IlluminateSnappyImage($app['files'], '/usr/local/bin/wkhtmltoimage', [], []);
if (false !== $timeout) {
    $image->setTimeout($timeout);
}
```

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

### setOrientation usage example

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

Loads HTML and sets orientation to landscape, then returns the PDF inline.

```php
PDF::loadHTML($html)->setOrientation('landscape')->inline();
```

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

### assertSee usage example

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

Checks that the provided substring appears in the rendered HTML output.

```php
PDF::assertSee('Name');
```

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

### assertViewMissing usage example

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

Verifies that the specified data key is not present in the view.

```php
PDF::assertViewMissing('credit_card_number');
```

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

### stream method usage

Source: https://github.com/barryvdh/laravel-snappy/blob/master/_autodocs/api-reference/image-wrapper.md

Example of returning an image response using the deprecated stream method.

```php
return $img->stream('preview.jpg');
```

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

### Error handling for output() without source

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

Example of catching InvalidArgumentException when output() is called without a loaded source, then loading fallback HTML and retrying.

```php
// error handling: output() with no source loaded
$pdf = App::make('snappy.pdf.wrapper');
try {
    $pdf->output();
} catch (\InvalidArgumentException $e) {
    // "PDF Generator requires a html or file in order to produce output."
    $pdf->loadHTML('<h1>Fallback</h1>');
    $pdf->output();
}
```

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

### boot() method implementation

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

Publishes config/snappy.php to the config publish group. If snappy.pdf.enabled is truthy, binds snappy.pdf to IlluminateSnappyPdf and snappy.pdf.wrapper to PdfWrapper, aliasing it as Barryvdh\Snappy\PdfWrapper. If snappy.image.enabled is truthy, binds snappy.image to IlluminateSnappyImage and snappy.image.wrapper to ImageWrapper, aliasing it as Barryvdh\Snappy\ImageWrapper. Bindings are lazy closures that read binary, options, env, and timeout from config, with defaults /usr/local/bin/wkhtmltopdf and /usr/local/bin/wkhtmltoimage. Timeout is applied only when not false.

```php
    public function boot()
    {
        $configPath = __DIR__ . '/../config/snappy.php';
        $this->publishes([$configPath => config_path('snappy.php')], 'config');

        if($this->app['config']->get('snappy.pdf.enabled')){
            $this->app->bind('snappy.pdf', function($app)
            {
                $binary = $app['config']->get('snappy.pdf.binary', '/usr/local/bin/wkhtmltopdf');
                $options = $app['config']->get('snappy.pdf.options', array());
                $env = $app['config']->get('snappy.pdf.env', array());
                $timeout = $app['config']->get('snappy.pdf.timeout', false);

                $snappy = new IlluminateSnappyPdf($app['files'], $binary, $options, $env);
                if (false !== $timeout) {
                    $snappy->setTimeout($timeout);
                }

                return $snappy;
            });

            $this->app->bind('snappy.pdf.wrapper', function($app)
            {
                return new PdfWrapper($app['snappy.pdf']);
            });
            $this->app->alias('snappy.pdf.wrapper', 'Barryvdh\Snappy\PdfWrapper');
        }


        if($this->app['config']->get('snappy.image.enabled')){
            $this->app->bind('snappy.image', function($app)
            {
                $binary = $app['config']->get('snappy.image.binary', '/usr/local/bin/wkhtmltoimage');
                $options = $app['config']->get('snappy.image.options', array());
                $env = $app['config']->get('snappy.image.env', array());
                $timeout = $app['config']->get('snappy.image.timeout', false);

                $image = new IlluminateSnappyImage($app['files'], $binary, $options, $env);
                if (false !== $timeout) {
                    $image->setTimeout($timeout);
                }

                return $image;
            });

            $this->app->bind('snappy.image.wrapper', function($app)
            {
                return new ImageWrapper($app['snappy.image']);
            });
            $this->app->alias('snappy.image.wrapper', 'Barryvdh\Snappy\ImageWrapper');
        }

	}
```

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

### Create PDF using wrapper

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

Shows how to use the Snappy wrapper to load HTML and return an inline PDF response.

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

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

### Create PDF using facade

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

Shows how to use the PDF facade to load a view and download the resulting PDF.

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

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

### Accessing Snappy services via App and Facades

Source: https://github.com/barryvdh/laravel-snappy/blob/master/_autodocs/index.md

Demonstrates how to resolve the PDF and image wrapper services from the Laravel container or use the provided facades for quick HTML rendering.

```php
$pdfWrapper = App::make('snappy.pdf.wrapper');  // Barryvdh\Snappy\PdfWrapper
$pdf        = App::make('snappy.pdf');          // Barryvdh\Snappy\IlluminateSnappyPdf
$image      = App::make('snappy.image');        // Barryvdh\Snappy\IlluminateSnappyImage
$pdf        = PDF::loadHTML('<h1>Invoice</h1>'); // facade → PdfWrapper
```

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

### provides() method returning service names

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

Returns an array of service names: snappy.pdf, snappy.pdf.wrapper, snappy.image, snappy.image.wrapper. This list is returned unconditionally even though boot() only binds services for enabled halves.

```php
	/**
	 * Get the services provided by the provider.
	 *
	 * @return array
	 */
	public function provides()
	{
		return array('snappy.pdf', 'snappy.pdf.wrapper', 'snappy.image', 'snappy.image.wrapper');
	}
```

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

### Create PDF using App container

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

Shows how to instantiate Snappy PDF via the App container and generate PDFs from HTML or a URL, saving to a file or returning as a response.

```php
$snappy = App::make('snappy.pdf');
//To file
$html = '<h1>Bill</h1><p>You owe me money, dude.</p>';
$snappy->generateFromHtml($html, '/tmp/bill-123.pdf');
$snappy->generate('http://www.github.com', '/tmp/github.pdf');
//Or output:
return new Response(
    $snappy->getOutputFromHtml($html),
    200,
    array(
        'Content-Type'          => 'application/pdf',
        'Content-Disposition'   => 'attachment; filename="file.pdf"'
    )
);
```

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

### Resolving Snappy services via App::make

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

Shows how to resolve the snappy.pdf, snappy.pdf.wrapper, snappy.image, and snappy.image.wrapper services from the container.

```php
$snappy = App::make('snappy.pdf');            // IlluminateSnappyPdf
$wrapper = App::make('snappy.pdf.wrapper');   // PdfWrapper
$image = App::make('snappy.image');           // IlluminateSnappyImage
$wrapper2 = App::make('snappy.image.wrapper'); // ImageWrapper
```

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

### Generate image from HTML using Snappy

Source: https://github.com/barryvdh/laravel-snappy/blob/master/_autodocs/api-reference/illuminate-snappy-image.md

Demonstrates how to resolve the snappy.image service from the container, configure options, and generate image output from HTML content.

```php
$image = App::make('snappy.image');        // Barryvdh\Snappy\IlluminateSnappyImage
$image->setOption('width', 1024);
$bytes = $image->getOutputFromHtml('<h1>Direct</h1>', []);
```

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

### Publish the snappy config file

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

Run artisan vendor:publish to create config/snappy.php.

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

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

### Register Lumen facades optionally

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

Add facades for PDF and SnappyImage in Lumen.

```php
class_alias(Barryvdh\Snappy\Facades\SnappyPdf::class, 'PDF');
class_alias(Barryvdh\Snappy\Facades\SnappyImage::class, 'SnappyImage');
```

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

### Register Facades for PDF and SnappyImage

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

Optionally add facades for shorter code in the facades array.

```php
'PDF' => Barryvdh\Snappy\Facades\SnappyPdf::class,
'SnappyImage' => Barryvdh\Snappy\Facades\SnappyImage::class,
```

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

### Configure multiple options with setOptions()

Source: https://github.com/barryvdh/laravel-snappy/blob/master/_autodocs/api-reference/image-wrapper.md

Sets multiple wkhtmltoimage options at once using an associative array. This method is delegated to Knp\Snappy\Image::setOptions().

```php
    public function setOptions($options)
```

```php
$wrapper->setOptions(['width' => 1280, 'height' => 720]);
```

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

### Retrieve Snappy instance with snappy()

Source: https://github.com/barryvdh/laravel-snappy/blob/master/_autodocs/api-reference/image-wrapper.md

Returns the underlying Knp\Snappy\Image engine instance. Use this to access engine-specific methods like setBinary.

```php
    /**
     * Get the Snappy instance.
     *
     * @return \Knp\Snappy\Image
     */
    public function snappy()
```

```php
$wrapper->snappy()->setBinary('/usr/local/bin/wkhtmltoimage');
```

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

### setOptions($options)

Source: https://github.com/barryvdh/laravel-snappy/blob/master/_autodocs/api-reference/image-wrapper.md

Sets multiple wkhtmltoimage options at once by delegating to the underlying Snappy engine's setOptions() method. Returns the wrapper instance for chaining.

```APIDOC
## setOptions($options)

### Description
Sets a bulk map of wkhtmltoimage options, delegated to Knp\Snappy\Image::setOptions().

### Method
setOptions($options)

### Parameters
- **options** (array) - Required - A map of option names to values.

### Return
- **$this** (ImageWrapper) - For chaining.

### Example
```php
$wrapper->setOptions(['width' => 1280, 'height' => 720]);
```
```

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

### Catching InvalidArgumentException

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

Example of catching the InvalidArgumentException when outputting a PDF. This pattern allows for providing fallback content if the initial generation fails due to missing source data.

```php
$pdf = App::make('snappy.pdf.wrapper');
try {
    $bytes = $pdf->output();
} catch (\InvalidArgumentException $e) {
    // "PDF Generator requires a html or file in order to produce output."
    $bytes = $pdf->loadHTML('<h1>Fallback</h1>')->output();
}
```

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

### Chain methods on PDF facade

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

Demonstrates chaining methods to load a file and return an inline PDF with a custom filename.

```php
return PDF::loadFile('http://www.github.com')->inline('github.pdf');
```

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

### Constructor

Source: https://github.com/barryvdh/laravel-snappy/blob/master/_autodocs/api-reference/image-wrapper.md

Creates a new ImageWrapper instance with a SnappyImage engine.

```APIDOC
## Constructor

### Description
Initializes the ImageWrapper with the provided Snappy image engine.

### Method
__construct

### Signature
public function __construct(SnappyImage $snappy)

### Parameters
- **snappy** (Knp\Snappy\Image) - Required - The Snappy image engine instance the wrapper delegates to.

### Example
```php
$engine = new Barryvdh\Snappy\IlluminateSnappyImage(app['files'], '/usr/local/bin/wkhtmltoimage', [], []);
$wrapper = new Barryvdh\Snappy\ImageWrapper($engine);
```
```

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

### IlluminateSnappyImage::__construct

Source: https://github.com/barryvdh/laravel-snappy/blob/master/_autodocs/api-reference/illuminate-snappy-image.md

Constructs a new IlluminateSnappyImage instance with a filesystem abstraction, the path to the wkhtmltoimage binary, default options, and environment variables.

```APIDOC
## IlluminateSnappyImage::__construct

### Description
Constructs a new IlluminateSnappyImage instance. It initializes the parent Knp\Snappy\Image with the given binary, options, and environment variables, and stores the provided Filesystem instance for file operations.

### Method
Constructor

### Signature
```php
public function __construct(Filesystem $fs, $binary, array $options, array $env)
```

### Parameters
- **fs** (Illuminate\Filesystem\Filesystem) - Required - Filesystem abstraction used for all file hooks; stored as `protected $fs`.
- **binary** (string) - Required - Path to the `wkhtmltoimage` executable.
- **options** (array) - Required - Default wkhtmltoimage options passed to the parent constructor.
- **env** (array) - Required - Environment variables for the subprocess, passed to the parent constructor.

### Implementation
```php
parent::__construct($binary, $options, $env);
$this->fs = $fs;
```

### Container Construction Example
```php
$image = new IlluminateSnappyImage($app['files'], '/usr/local/bin/wkhtmltoimage', [], []);
if (false !== $timeout) {
    $image->setTimeout($timeout);
}
```
```

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

### PdfFaker assertViewHas failure example in PHPUnit test

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

Shows a test where PDF::fake() is used, loadHTML() is called instead of loadView(), and assertViewHas('order_id') fails with 'The response is not a view.' because no view is recorded.

```php
PDF::fake();
PDF::loadHTML('<h1>Test</h1>');   // no loadView() recorded
PDF::assertViewHas('order_id');   // fails: "The response is not a view."
```

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

### ServiceProvider::register()

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

Registers the service provider by merging the snappy config file into the application configuration under the 'snappy' key. Returns void.

```php
	/**
	 * Register the service provider.
	 *
	 * @return void
	 */
	public function register()
    {
        $configPath = __DIR__ . '/../config/snappy.php';
        $this->mergeConfigFrom($configPath, 'snappy');
    }
```

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

### snappy()

Source: https://github.com/barryvdh/laravel-snappy/blob/master/_autodocs/api-reference/image-wrapper.md

Returns the underlying Knp\Snappy\Image engine instance, allowing direct access to engine methods such as setBinary().

```APIDOC
## snappy()

### Description
Returns the Snappy engine instance for the image wrapper.

### Method
snappy()

### Parameters
No parameters.

### Return
- **Knp\Snappy\Image** - The engine instance.

### Example
```php
$wrapper->snappy()->setBinary('/usr/local/bin/wkhtmltoimage');
```
```

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

### Configure options with setOption()

Source: https://github.com/barryvdh/laravel-snappy/blob/master/_autodocs/api-reference/image-wrapper.md

Sets a single wkhtmltoimage option. The value is passed through unchanged, and the method returns the instance for chaining.

```php
    public function setOption($name, $value)
```

```php
$wrapper->setOption('width', 1024)->setOption('quality', 90);
```

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

### PDF facade with fake for testing

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

Demonstrates using PDF::fake() to generate PDFs without spawning wkhtmltopdf, allowing assertions on the view, data, and filename. Useful for tests.

```php
// facade with the fake — test-time PDF generation without wkhtmltopdf
PDF::fake();

$pdf = PDF::loadView('pdf.invoice', ['total' => 42.00]); // no subprocess spawn
$pdf->save('/tmp/invoice.pdf');

PDF::assertViewIs('pdf.invoice');
PDF::assertViewHas('total', 42.00);
PDF::assertFileNameIs('/tmp/invoice.pdf');
```

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

### PdfWrapper constructor

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

Constructor that accepts a Knp\Snappy\Pdf instance. The parameter is required and is the engine the wrapper delegates to.

```php
/**
 * @param \Knp\Snappy\Pdf $snappy
 */
public function __construct(SnappyPDF $snappy)
```

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

### IlluminateSnappyImage constructor

Source: https://github.com/barryvdh/laravel-snappy/blob/master/_autodocs/api-reference/illuminate-snappy-image.md

Constructor signature for IlluminateSnappyImage. It accepts a Filesystem instance, the wkhtmltoimage binary path, default options, and environment variables. The implementation calls the parent constructor and stores the filesystem as $fs.

```php
	/**
	 * @param \Illuminate\Filesystem\Filesystem
     * @param string $binary
     * @param array $options
	 */
	public function __construct(Filesystem $fs, $binary, array $options, array $env)
```

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

### Generate PDF from HTML

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

Demonstrates resolving the PDF service from the container and generating output from an HTML string.

```php
$pdf = App::make('snappy.pdf');          // Barryvdh\Snappy\IlluminateSnappyPdf
$pdf->setOption('page-size', 'A4');
$output = $pdf->getOutputFromHtml('<h1>Direct</h1>', []);
```

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

### setOptions($options)

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

Bulk sets multiple wkhtmltopdf options by delegating to the underlying Snappy instance's setOptions method.

```APIDOC
## setOptions($options)

### Description
Bulk sets multiple wkhtmltopdf options. The options array is delegated to `Knp\Snappy\Pdf::setOptions()`.

### Method
setOptions

### Signature
`public function setOptions($options)`

### Parameters
- **options** (array) - Required - Bulk map of wkhtmltopdf options delegated to `Knp\Snappy\Pdf::setOptions()`.

### Return
`$this` (PdfWrapper) for chaining.

### Example
```php
$pdf->setOptions(['page-size' => 'A4', 'orientation' => 'landscape', 'margin-bottom' => 0]);
```
```

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

### mkdir method

Source: https://github.com/barryvdh/laravel-snappy/blob/master/_autodocs/api-reference/illuminate-snappy-image.md

A protected wrapper for the mkdir function that creates a directory using the filesystem service.

```php
    /**
     * Wrapper for the mkdir function
     *
     * @param string $pathname
     *
     * @return boolean
     */
    protected function mkdir($pathname)
```

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

### output() method usage

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

Returns a static, hard-coded dummy PDF string. This method does not execute wkhtmltopdf and never throws exceptions.

```php
public function output()
```

```php
$pdf = PDF::loadHTML('<h1>Test</h1>');
$content = $pdf->output(); // always the fixed dummy PDF
```

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

### Set paper size and orientation

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

Shows how to set paper size, orientation, and options when generating a PDF.

```php
PDF::loadHTML($html)->setPaper('a4')->setOrientation('landscape')->setOption('margin-bottom', 0)->save('myfile.pdf')
```

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

### output()

Source: https://github.com/barryvdh/laravel-snappy/blob/master/_autodocs/api-reference/image-wrapper.md

Generates and returns the image binary as a string. Throws an InvalidArgumentException if no HTML or file source is set, and may propagate RuntimeException from the underlying wkhtmltoimage process.

```APIDOC
## output()

### Description
Generates and returns the image binary as a string. Throws an InvalidArgumentException if no HTML or file source is set, and may propagate RuntimeException from the underlying wkhtmltoimage process.

### Method
output

### Signature
`public function output()`

### Parameters
None.

### Return
`string` - The rendered image binary.

### Throws
- **\InvalidArgumentException** - If neither `$this->html` nor `$this->file` is set. Message: 'Image Generator requires a html or file in order to produce output.'
- **\RuntimeException** (propagated from Knp\Snappy) - If the `wkhtmltoimage` process fails.

### Example
```php
$content = $img->output(); // image bytes
```

```php
try {
    $img->output();
} catch (\InvalidArgumentException $e) {
    // "Image Generator requires a html or file in order to produce output."
    $img->loadHTML('<h1>placeholder</h1>');
}
```
```

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

### IlluminateSnappyPdf::__construct

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

Constructor for the IlluminateSnappyPdf class. It initializes the parent Knp\Snappy\Pdf with the binary path, options, and environment variables, and stores the provided Filesystem instance for file operations.

```APIDOC
## IlluminateSnappyPdf::__construct

### Description
Constructor for the IlluminateSnappyPdf class. It initializes the parent Knp\Snappy\Pdf with the binary path, options, and environment variables, and stores the provided Filesystem instance for file operations.

### Method
Constructor

### Signature
```php
public function __construct(Filesystem $fs, $binary, array $options, array $env)
```

### Parameters
- **fs** (Illuminate\Filesystem\Filesystem) - Required - Filesystem abstraction used for all file hooks; stored as protected $fs.
- **binary** (string) - Required - Path to the wkhtmltopdf executable.
- **options** (array) - Required - Default wkhtmltopdf options passed to the parent constructor.
- **env** (array) - Required - Environment variables for the subprocess, passed to the parent constructor.

### Implementation
```php
parent::__construct($binary, $options, $env);
$this->fs = $fs;
```

### Usage Example
```php
$snappy = new IlluminateSnappyPdf($app['files'], $binary, $options, $env);
if (false !== $timeout) {
    $snappy->setTimeout($timeout);
}
```
```

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

### SnappyPdf static facade methods

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

Declared static methods on the SnappyPdf facade that forward to the bound PdfWrapper instance. These methods allow setting paper size, options, loading views/HTML/files, and generating output, downloads, or inline responses.

```APIDOC
## Static Facade Methods

### Description
The following static methods are declared on the SnappyPdf facade and are forwarded to the underlying PdfWrapper instance. They provide the main functionality for generating PDFs.

### Methods

#### setPaper($paper, $orientation = 'portrait')
- **Return**: \Barryvdh\Snappy\PdfWrapper
- Sets the paper size and orientation.

#### setWarnings($warnings)
- **Return**: \Barryvdh\Snappy\PdfWrapper
- Sets whether warnings are shown.

#### setOptions(array $options)
- **Return**: \Barryvdh\Snappy\PdfWrapper
- Sets options for the PDF generation.

#### loadView($view, $data = array(), $mergeData = array(), $encoding = null)
- **Return**: \Barryvdh\Snappy\PdfWrapper
- Loads a view as the PDF content.

#### loadHTML($string, $encoding = null)
- **Return**: \Barryvdh\Snappy\PdfWrapper
- Loads an HTML string as the PDF content.

#### loadFile($file)
- **Return**: \Barryvdh\Snappy\PdfWrapper
- Loads a file as the PDF content.

#### output($options = [])
- **Return**: string
- Returns the PDF output as a string.

#### save()
- **Return**: \Barryvdh\Snappy\PdfWrapper
- Saves the PDF to a file (filename is recorded when using fake).

#### download($filename = 'document.pdf')
- **Return**: \Illuminate\Http\Response
- Returns a download response for the PDF.

#### inline($filename = 'document.pdf')
- **Return**: \Illuminate\Http\Response
- Returns an inline response for the PDF.

### Example
```php
PDF::setPaper('a4')->loadView('pdf.order')->save('order.pdf');
```
```

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

### output()

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

Returns a static, hard-coded dummy PDF string so that downstream consumers receive valid-looking PDF bytes without executing wkhtmltopdf. Never throws, regardless of whether loadHTML or loadFile was called.

```APIDOC
## output()

### Description
Returns a static, hard-coded dummy PDF (a %PDF-1.3 document with a single A4 page at 595.28 x 841.89 points) so that downstream consumers of output() (e.g. download(), inline()) receive valid-looking PDF bytes without executing wkhtmltopdf. Never throws, regardless of whether loadHTML/loadFile was called.

### Method
output()

### Parameters
No parameters.

### Return
string - a static, hard-coded dummy PDF.

### Example
```php
$pdf = PDF::loadHTML('<h1>Test</h1>');
$content = $pdf->output(); // always the fixed dummy PDF
```
```

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

### Copy wkhtmltopdf binaries to /usr/local/bin for Vagrant

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

Move the composer-installed binaries to a non-synced folder to avoid error 126.

```bash
cp vendor/h4cc/wkhtmltoimage-amd64/bin/wkhtmltoimage-amd64 /usr/local/bin/
cp vendor/h4cc/wkhtmltopdf-amd64/bin/wkhtmltopdf-amd64 /usr/local/bin/
```

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

### __call($name, array $arguments)

Source: https://github.com/barryvdh/laravel-snappy/blob/master/_autodocs/api-reference/image-wrapper.md

Magic method that handles dynamic method calls on ImageWrapper. It provides shortcuts for loading HTML, views, and files, and forwards any other method calls to the underlying Snappy Image instance.

```APIDOC
## __call($name, array $arguments)

### Description
Magic method that handles dynamic method calls on ImageWrapper. It provides shortcuts for loading HTML, views, and files, and forwards any other method calls to the underlying Snappy Image instance.

### Method
__call

### Signature
__call($name, array $arguments)

### Parameters
- **name** (string) - Required - Shortcut name (`html`, `view`, `file`) or a method name on either the wrapper or the Snappy engine.
- **arguments** (array) - Required - Argument list passed to the resolved method.

### Return
mixed - Identical strategy to `PdfWrapper::__call`: tries `'load' . ucfirst($name)` on the wrapper first (`method_exists`), otherwise forwards the call to `$this->snappy`.

### Example
```php
$img->html('<h1>Badge</h1>');    // loadHTML()
$img->view('badge.user', $data); // loadView()
$img->file('/tmp/badge.html');   // loadFile()
$img->setTimeout(20);            // forwarded to Knp\Snappy\Image
```
```

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

### Make wkhtmltopdf binaries executable

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

Set executable permissions on the copied binaries to prevent error 126.

```bash
chmod +x /usr/local/bin/wkhtmltoimage-amd64 
chmod +x /usr/local/bin/wkhtmltopdf-amd64
```

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

### Register Lumen ServiceProvider and alias

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

Add to bootstrap/app.php for Lumen.

```php
class_alias('Barryvdh\Snappy\Facades\SnappyPdf', 'PDF');
$app->register(Barryvdh\Snappy\LumenServiceProvider::class);
```

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

### snappy() method signature

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

Method signature for snappy(), which returns the Knp\Snappy\Pdf engine instance. Useful for engine-level calls such as setBinary() or setTimeout().

```php
/**
 * Get the Snappy instance.
 *
 * @return \Knp\Snappy\Pdf
 */
 public function snappy()
```

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

### SnappyPdf fake() method

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

Swaps the bound 'snappy.pdf.wrapper' instance with a PdfFaker constructed around the current 'snappy.pdf' engine. After calling, PDF::* calls hit the fake, avoiding wkhtmltopdf execution.

```php
    /**
     * Replace the bound instance with a fake.
     *
     * @return void
     */
    public static function fake()
    {
        static::swap(new PdfFaker(app('snappy.pdf')));
    }
```

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

### setOption($name, $value)

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

Sets a single wkhtmltopdf command-line option. If the value is a Renderable, it is rendered to a string before being passed to the underlying Snappy instance.

```APIDOC
## setOption($name, $value)

### Description
Sets a single wkhtmltopdf command-line option. If the value is an instance of `Illuminate\Contracts\Support\Renderable`, it is rendered to a string first before delegating to the underlying Snappy instance.

### Method
setOption

### Signature
`public function setOption($name, $value)`

### Parameters
- **name** (string) - Required - wkhtmltopdf command-line option name (without leading dashes).
- **value** (mixed) - Required - Option value. If `value` is an `Illuminate\Contracts\Support\Renderable`, it is rendered to a string first.

### Return
`$this` (PdfWrapper) for chaining.

### Behavior
When `$value instanceof Renderable`, `$value = $value->render()` before delegating to `$this->snappy->setOption($name, $value)`.

### Example
```php
$pdf->setOption('margin-bottom', 0);
$pdf->setOption('header-html', View::make('pdf.header', ['company' => 'ACME'])); // Renderable is rendered automatically
```
```

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

### Default configuration file schema

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

The default structure of the config/snappy.php file, defining settings for both PDF and image generation services.

```php
return [

    'pdf' => [
        'enabled' => true,
        'binary'  => env('WKHTML_PDF_BINARY', '/usr/local/bin/wkhtmltopdf'),
        'timeout' => false,
        'options' => [],
        'env'     => [],
    ],

    'image' => [
        'enabled' => true,
        'binary'  => env('WKHTML_IMG_BINARY', '/usr/local/bin/wkhtmltoimage'),
        'timeout' => false,
        'options' => [],
        'env'     => [],
    ],

];
```

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

### output()

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

Renders the PDF as a string. Returns the full PDF binary content. Throws an InvalidArgumentException if neither HTML nor a file has been loaded.

```APIDOC
## output()

### Description
Renders the PDF as a string. Returns the full PDF binary content. Throws an InvalidArgumentException if neither HTML nor a file has been loaded.

### Method
output()

### Signature
`public function output()`

### Parameters
None.

### Return Value
- **Type**: `string`
- **Description**: The full PDF binary content. When `$this->html` is set, it calls `$this->snappy->getOutputFromHtml($this->html, $this->options)`. When `$this->file` is set, it calls `$this->snappy->getOutput($this->file, $this->options)`. Both paths run `$this->snappy->removeTemporaryFiles()` in a `finally` block, so temp files are removed even on failure.

### Exceptions
- **\InvalidArgumentException** - Thrown when neither `$this->html` nor `$this->file` is set (no loader called). Message: `'PDF Generator requires a html or file in order to produce output.'`
- **\RuntimeException** (propagated from `Knp\Snappy`) - Thrown when the `wkhtmltopdf` process fails, e.g., invalid binary.

### Example
```php
$pdf = App::make('snappy.pdf.wrapper');
$pdf->loadHTML('<h1>Bill</h1>');
$content = $pdf->output(); // PDF bytes, e.g. to store in a database or storage driver
```

### Error Handling Example
```php
// error handling: output() with no source loaded
$pdf = App::make('snappy.pdf.wrapper');
try {
    $pdf->output();
} catch (\InvalidArgumentException $e) {
    // "PDF Generator requires a html or file in order to produce output."
    $pdf->loadHTML('<h1>Fallback</h1>');
    $pdf->output();
}
```
```

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

### PdfWrapper::snappy()

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

Returns the underlying Snappy PDF engine instance for engine-level configuration.

```APIDOC
## snappy()

### Description
Returns the underlying Snappy PDF engine instance, allowing engine-level calls such as setBinary() or setTimeout().

### Method
snappy()

### Signature
`public function snappy()`

### Parameters
None

### Return
- **Knp\Snappy\Pdf** - The engine instance.

### Example
```php
$wrapper = App::make('snappy.pdf.wrapper');
$wrapper->snappy()->setBinary('/usr/local/bin/wkhtmltopdf');
```
```

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

### setOption($name, $value)

Source: https://github.com/barryvdh/laravel-snappy/blob/master/_autodocs/api-reference/image-wrapper.md

Sets a single wkhtmltoimage option on the wrapper. Returns the wrapper instance for chaining.

```APIDOC
## setOption($name, $value)

### Description
Sets a single wkhtmltoimage option. The value is passed through unchanged, without any Renderable handling.

### Method
setOption($name, $value)

### Parameters
- **name** (string) - Required - The wkhtmltoimage option name.
- **value** (mixed) - Required - The option value.

### Return
- **$this** (ImageWrapper) - For chaining.

### Example
```php
$wrapper->setOption('width', 1024)->setOption('quality', 90);
```
```

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

### LumenServiceProvider::register()

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

Registers the provider for Lumen, calling $this->app->configure('snappy') before merging config. This extra step is required by the Lumen bootstrap.

```php
    public function register()
    {
        $this->app->configure('snappy');

        $configPath = __DIR__ . '/../config/snappy.php';
        $this->mergeConfigFrom($configPath, 'snappy');
    }
```

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

### Generate image output with output

Source: https://github.com/barryvdh/laravel-snappy/blob/master/_autodocs/api-reference/image-wrapper.md

Returns the rendered image as a binary string. Throws an InvalidArgumentException if neither HTML nor a file is set.

```php
    /**
     * Output the PDF as a string.
     *
     * @return string The rendered PDF as string
     * @throws \InvalidArgumentException
     */
    public function output()
```

```php
$content = $img->output(); // image bytes
```

```php
try {
    $img->output();
} catch (\InvalidArgumentException $e) {
    // "Image Generator requires a html or file in order to produce output."
    $img->loadHTML('<h1>placeholder</h1>');
}
```

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

### SnappyPdf getFacadeAccessor()

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

Returns the container binding 'snappy.pdf.wrapper' that resolves to Barryvdh\Snappy\PdfWrapper.

```php
    /**
     * Get the registered name of the component.
     *
     * @return string
     */
    protected static function getFacadeAccessor() { return 'snappy.pdf.wrapper'; }
```
Tokens:
Raw