Spatie PDF to Image

https://github.com/spatie/pdf-to-image
Admin
A PHP package that provides an easy-to-use class to convert PDF files into one or more image files.
Tokens:25,706
Snippets:349
Trust Score:10
License:MIT
Update:3 months ago
Show doc for...
Tokens:
Raw
### Get Output Format

Source: https://github.com/spatie/pdf-to-image/blob/main/_autodocs/api-reference/pdf.md

Retrieves the currently set output format.

```php
$format = $pdf->getFormat();
```

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

### Install package via Composer

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

Use this command to install the package in your PHP project. Requires PHP 8.2 or higher.

```bash
composer require spatie/pdf-to-image
```

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

### Get Current Format

Source: https://github.com/spatie/pdf-to-image/blob/main/_autodocs/api-reference/output-format.md

Retrieves the currently configured output format from the Pdf instance.

```php
public function getFormat(): OutputFormat
```

```php
use Spatie\PdfToImage\Pdf;
use Spatie\PdfToImage\Enums\OutputFormat;

$pdf = new Pdf('/path/to/document.pdf');
$format = $pdf->getFormat();  // Returns OutputFormat::Jpg (default)
```

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

### Use LayerMethod Validation

Source: https://github.com/spatie/pdf-to-image/blob/main/_autodocs/types.md

Examples of validating integer values against defined LayerMethod cases.

```php
use Spatie\\\PdfToImage\\\Enums\\\LayerMethod;

LayerMethod::isValid(Imagick::LAYERMETHOD_FLATTEN);  // true
LayerMethod::isValid(999);                          // false
LayerMethod::isValid(-1);                           // true (LayerMethod::None)
```

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

### selectPage()

Source: https://github.com/spatie/pdf-to-image/blob/main/_autodocs/api-reference/pdf.md

Selects a single page to convert. Page numbering starts at 1.

```APIDOC
## selectPage(int $page)

### Description
Selects a single page to convert. Page numbering starts at 1.

### Parameters
- **page** (int) - Required - Page number to select

### Returns
- **static** - $this (fluent interface)

### Throws
- **PageDoesNotExist** - if the page number is out of range (< 1 or > total pages)
```

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

### Catch InvalidQuality exception

Source: https://github.com/spatie/pdf-to-image/blob/main/_autodocs/errors.md

Example of handling an InvalidQuality exception when setting an out-of-range quality value.

```php
use Spatie\PdfToImage\Pdf;
use Spatie\PdfToImage\Exceptions\InvalidQuality;

try {
    $pdf = new Pdf('/path/to/document.pdf');
    $pdf->quality(150)->save('/output.jpg');
} catch (InvalidQuality $e) {
    echo "Invalid quality setting: " . $e->getMessage();
}
```

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

### Initialize Pdf Instance

Source: https://github.com/spatie/pdf-to-image/blob/main/_autodocs/api-reference/pdf.md

Create a new instance by providing the path to the PDF file. Throws PdfDoesNotExist if the file is missing.

```php
use Spatie\PdfToImage\Pdf;

$pdf = new Pdf('/path/to/document.pdf');
```

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

### Initialize PDF Class

Source: https://github.com/spatie/pdf-to-image/blob/main/_autodocs/overview.md

Instantiate the Pdf class with a file path.

```php
use Spatie\PdfToImage\Pdf;

$pdf = new Pdf($pathToPdfFile);
```

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

### Create a PdfPage Instance

Source: https://github.com/spatie/pdf-to-image/blob/main/_autodocs/api-reference/pdf-page.md

Demonstrates instantiation of the PdfPage DTO with required parameters.

```php
use Spatie\\\PdfToImage\\\DTOs\\\PdfPage;
use Spatie\\\PdfToImage\\\Enums\\\OutputFormat;

$page = new PdfPage(
    1,
    OutputFormat::Jpg,
    'doc-',
    '/path/to/output.jpg'
);
```

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

### Get PDF Metadata

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

Retrieve information about the PDF document structure.

```php
/** @var int $numberOfPages */
$numberOfPages = $pdf->pageCount();
```

```php
/** @var bool $isSupported */
$isSupported = $pdf->isValidOutputFormat('jpg');
```

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

### Initialize and Convert PDF to Image

Source: https://github.com/spatie/pdf-to-image/blob/main/_autodocs/README.md

Demonstrates the primary workflow for loading a PDF and saving a specific page as an image with custom settings.

```php
use Spatie\PdfToImage\Pdf;

$pdf = new Pdf('/path/to/document.pdf');
$pdf
    ->resolution(300)
    ->quality(90)
    ->format(OutputFormat::Png)
    ->size(800, 600)
    ->selectPage(1)
    ->save('/output.png');
```

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

### Configure Layer Methods and Background Colors

Source: https://github.com/spatie/pdf-to-image/blob/main/_autodocs/api-reference/layer-method.md

Demonstrates setting layer flattening strategies and custom background colors for PDF conversion.

```php
use Spatie\PdfToImage\Pdf;
use Spatie\PdfToImage\Enums\LayerMethod;

$pdf = new Pdf('/path/to/document.pdf');

// This defaults to white background
$pdf->layerMethod(LayerMethod::Flatten)->save('/output.jpg');

// This uses transparent background (not flattened)
$pdf->layerMethod(LayerMethod::None)->save('/output.png');

// This uses custom background
$pdf
    ->layerMethod(LayerMethod::Flatten)
    ->backgroundColor('#f0f0f0')
    ->save('/output.jpg');
```

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

### Get Page Dimensions

Source: https://github.com/spatie/pdf-to-image/blob/main/_autodocs/api-reference/pdf.md

Returns the dimensions of the first PDF page as a PageSize DTO.

```php
$size = $pdf->getSize();
echo "Width: " . $size->width . "px, Height: " . $size->height . "px";
```

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

### Import PDF Class

Source: https://github.com/spatie/pdf-to-image/blob/main/_autodocs/INDEX.md

The primary entry point for using the library.

```php
use Spatie\PdfToImage\Pdf;
```

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

### Use OutputFormat Enum

Source: https://github.com/spatie/pdf-to-image/blob/main/_autodocs/types.md

Demonstrates setting the output format and checking the current format.

```php
use Spatie\\\PdfToImage\\\Enums\\\OutputFormat;

$pdf->format(OutputFormat::Webp)->save('/output.webp');

if ($pdf->getFormat() === OutputFormat::Png) {
    // PNG format is active
}
```

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

### Catch InvalidSize exception

Source: https://github.com/spatie/pdf-to-image/blob/main/_autodocs/errors.md

Example of handling an InvalidSize exception when providing negative dimensions.

```php
use Spatie\PdfToImage\Pdf;
use Spatie\PdfToImage\Exceptions\InvalidSize;

try {
    $pdf = new Pdf('/path/to/document.pdf');
    $pdf->size(-100)->save('/output.jpg');
} catch (InvalidSize $e) {
    echo "Invalid size: " . $e->getMessage();
}
```

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

### Method Chaining with Fluent Interface

Source: https://github.com/spatie/pdf-to-image/blob/main/_autodocs/README.md

Demonstrates chaining configuration methods that return the instance for further operations.

```php
$pdf->resolution(300)->quality(90)->save('/output.jpg');
```

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

### Get PDF page dimensions

Source: https://github.com/spatie/pdf-to-image/blob/main/_autodocs/api-reference/page-size.md

Retrieve the dimensions of a PDF document using the getSize method.

```php
use Spatie\PdfToImage\Pdf;

$pdf = new Pdf('/path/to/document.pdf');
$size = $pdf->getSize();

echo "Width: " . $size->width . "px";
echo "Height: " . $size->height . "px";
```

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

### Pdf Class Initialization and Usage

Source: https://github.com/spatie/pdf-to-image/blob/main/_autodocs/README.md

The main entry point for the library is the Pdf class, which allows loading a PDF file and chaining configuration methods before saving the output.

```APIDOC
## Pdf Class

### Description
Initializes a new PDF instance for conversion.

### Constructor
`new Pdf(string $path)`

### Configuration Methods
- `resolution(int $dpi)` - Sets the DPI (default: 144)
- `quality(int $quality)` - Sets compression quality (1-100)
- `format(OutputFormat $format)` - Sets output format (Jpg, Jpeg, Png, Webp)
- `backgroundColor(string $color)` - Sets background color
- `layerMethod(LayerMethod|int $method)` - Sets layer merging strategy
- `size(int $width, ?int $height)` - Sets output dimensions
- `thumbnailSize(int $width, ?int $height)` - Sets thumbnail dimensions
- `colorspace(int $colorspace)` - Sets Imagick colorspace
- `antialiased(bool $enabled)` - Toggles anti-aliasing

### Page Selection
- `selectPage(int $page)` - Selects a single page
- `selectPages(int ...$pages)` - Selects multiple pages
- `pageCount()` - Returns total pages in PDF
- `getSize()` - Returns page dimensions

### Output Methods
- `save(string $path, string $filename)` - Saves selected pages
- `saveAllPages(string $path, string $filename)` - Saves all pages
```

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

### Configuration Methods

Source: https://github.com/spatie/pdf-to-image/blob/main/_autodocs/INDEX.md

Fluent methods for configuring the PDF conversion process.

```text
resolution(int)          // DPI
quality(int)            // 1-100
format(OutputFormat)    // Output format
backgroundColor(string) // Color
layerMethod(LayerMethod|int) // Layer merging
size(int, ?int)         // Output dimensions
thumbnailSize(int, ?int) // Thumbnail
colorspace(int)         // Imagick colorspace
antialiased(bool)       // Anti-aliasing
```

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

### Convert PDF to Image using Fluent Interface

Source: https://github.com/spatie/pdf-to-image/blob/main/_autodocs/api-reference/pdf.md

Chain configuration methods to set resolution, quality, format, page selection, and dimensions before saving the output.

```php
$pdf = new Pdf('/path/to/document.pdf');
$pdf
    ->resolution(300)
    ->quality(90)
    ->format(OutputFormat::Png)
    ->selectPage(1)
    ->size(800, 600)
    ->save('/path/to/output.png');
```

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

### Catch InvalidLayerMethod exception

Source: https://github.com/spatie/pdf-to-image/blob/main/_autodocs/errors.md

Example of handling the exception when an invalid layer method constant is passed to the Pdf instance.

```php
use Spatie\\
```

```php
use Spatie\PdfToImage\Pdf;
use Spatie\PdfToImage\Exceptions\InvalidLayerMethod;

try {
    $pdf = new Pdf('/path/to/document.pdf');
    $pdf->layerMethod(9999)->save('/output.jpg');
} catch (InvalidLayerMethod $e) {
    echo "Invalid layer method: " . $e->getMessage();
}
```

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

### Initialize PdfPage Constructor

Source: https://github.com/spatie/pdf-to-image/blob/main/_autodocs/api-reference/pdf-page.md

Defines the signature for creating a new PdfPage instance.

```php
public function __construct(
    int $number,
    OutputFormat $format,
    string $prefix,
    string $path
)
```

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

### Retrieve PDF Information

Source: https://github.com/spatie/pdf-to-image/blob/main/_autodocs/quick-reference.md

Methods to get the total page count, dimensions, current output format, and validate format strings.

```php
$pageCount = $pdf->pageCount();  // Total pages in PDF
```

```php
$size = $pdf->getSize();
$width = $size->width;    // Width in pixels
$height = $size->height;  // Height in pixels
```

```php
$format = $pdf->getFormat();  // Returns OutputFormat enum
```

```php
$isValid = $pdf->isValidOutputFormat('jpg');        // true
$isValid = $pdf->isValidOutputFormat('invalid');    // false
```

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

### Configure Output Format

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

Set the desired image format for the output.

```php
$pdf->format(\Spatie\PdfToImage\Enums\OutputFormat::Webp)
    ->save($pathToWhereImageShouldBeStored); //the saved image will be in webp format
```

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

### Configuration Methods

Source: https://github.com/spatie/pdf-to-image/blob/main/_autodocs/INDEX.md

Fluent methods to configure the PDF conversion settings.

```APIDOC
## Configuration Methods

- **resolution(int)**: Sets the DPI.
- **quality(int)**: Sets the quality (1-100).
- **format(OutputFormat)**: Sets the output format.
- **backgroundColor(string)**: Sets the background color.
- **layerMethod(LayerMethod|int)**: Sets the layer merging method.
- **size(int, ?int)**: Sets the output dimensions (width, height).
- **thumbnailSize(int, ?int)**: Sets the thumbnail dimensions (width, height).
- **colorspace(int)**: Sets the Imagick colorspace.
- **antialiased(bool)**: Enables or disables anti-aliasing.
```

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

### Catching PdfDoesNotExist Exception

Source: https://github.com/spatie/pdf-to-image/blob/main/_autodocs/errors.md

Demonstrates how to handle the PdfDoesNotExist exception when initializing a Pdf object.

```php
use Spatie\PdfToImage\Pdf;
use Spatie\PdfToImage\Exceptions\PdfDoesNotExist;

try {
    $pdf = new Pdf('/path/to/missing.pdf');
} catch (PdfDoesNotExist $e) {
    echo "PDF file not found: " . $e->getMessage();
}
```

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

### thumbnailSize(int $width, ?int $height)

Source: https://github.com/spatie/pdf-to-image/blob/main/_autodocs/api-reference/pdf.md

Creates a thumbnail by resizing the image proportionally or to exact dimensions.

```APIDOC
## thumbnailSize(int $width, ?int $height)

### Description
Creates a thumbnail by resizing the image proportionally or to exact dimensions. If height is omitted, it scales proportionally based on width.

### Parameters
- **width** (int) - Required - Thumbnail width in pixels (must be >= 0)
- **height** (int) - Optional - Thumbnail height in pixels (must be >= 0)

### Returns
- **static** - Returns $this for fluent interface

### Throws
- **InvalidSize** - if width or height is negative

### Example
```php
$pdf->thumbnailSize(400)->save('/path/to/output.jpg');
$pdf->thumbnailSize(400, 300)->save('/path/to/output.jpg');
```
```

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

### Configuration Methods

Source: https://github.com/spatie/pdf-to-image/blob/main/_autodocs/quick-reference.md

Methods to configure the output image properties such as resolution, quality, format, and dimensions.

```APIDOC
## Configuration Methods

### resolution(int $resolution)
Sets the DPI for the output image. Default is 144.

### quality(int $quality)
Sets the image quality from 1 to 100.

### format(OutputFormat $format)
Sets the output format (e.g., Png, Webp).

### backgroundColor(string $color)
Sets the background color of the image.

### size(int $width, ?int $height = null)
Sets the image dimensions. If only width is provided, height scales proportionally.

### thumbnailSize(int $width)
Sets the image to thumbnail mode with the specified width.

### layerMethod(LayerMethod $method)
Sets the layer merging method (Flatten, None, or Merge).

### antialiased(bool $antialiased)
Enables or disables antialiasing. Default is true.

### colorspace(int $colorspace)
Sets the Imagick colorspace.
```

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

### Instantiate PageSize

Source: https://github.com/spatie/pdf-to-image/blob/main/_autodocs/types.md

Constructor and factory method signatures for PageSize.

```php
new PageSize(int $width, int $height)
```

```php
public static function make(int $width, int $height): self
```

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

### Convert All Pages with Customization

Source: https://github.com/spatie/pdf-to-image/blob/main/_autodocs/overview.md

Convert all pages with custom resolution, quality, and output format settings.

```php
$pdf = new Pdf('/path/to/document.pdf');
$pdf
    ->resolution(300)
    ->quality(95)
    ->format(OutputFormat::Webp)
    ->saveAllPages('/path/to/output-directory/', 'page-');
```

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

### getFormat()

Source: https://github.com/spatie/pdf-to-image/blob/main/_autodocs/api-reference/pdf.md

Returns the currently configured output format.

```APIDOC
## getFormat()

### Description
Returns the currently configured output format.

### Returns
`OutputFormat` enum value

### Example
```php
$format = $pdf->getFormat();
```
```

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

### Constructor

Source: https://github.com/spatie/pdf-to-image/blob/main/_autodocs/api-reference/pdf.md

Creates a new instance of the Pdf class to process a specified PDF file.

```APIDOC
## __construct(string $filename)

### Description
Creates a new instance to process the specified PDF file.

### Parameters
- **filename** (string) - Required - Absolute or relative path to the PDF file

### Throws
- **PdfDoesNotExist** - If the file does not exist
```

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

### Create PdfPage instance

Source: https://github.com/spatie/pdf-to-image/blob/main/_autodocs/api-reference/pdf-page.md

Instantiate a new PdfPage using the factory method.

```php
use Spatie\PdfToImage\DTOs\PdfPage;
use Spatie\PdfToImage\Enums\OutputFormat;

$page = PdfPage::make(1, OutputFormat::Jpg, 'page-', '/output/image.jpg');
```

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

### Apply LayerMethod

Source: https://github.com/spatie/pdf-to-image/blob/main/_autodocs/types.md

Configuring the PDF processor with specific layer methods.

```php
use Spatie\\\PdfToImage\\\Enums\\\LayerMethod;

$pdf->layerMethod(LayerMethod::Flatten)->save('/output.jpg');
$pdf->layerMethod(LayerMethod::None)->save('/output.jpg');
```

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

### Implement safe layer method usage

Source: https://github.com/spatie/pdf-to-image/blob/main/_autodocs/errors.md

Demonstrates safe ways to set layer methods using Enums, Imagick constants, or manual validation to avoid triggering the exception.

```php
use Spatie\PdfToImage\Enums\LayerMethod;

// Using enums: always safe, no exception possible
$pdf->layerMethod(LayerMethod::Flatten)->save('/output.jpg');
$pdf->layerMethod(LayerMethod::None)->save('/output.jpg');

// Using Imagick constants: validation required
$pdf->layerMethod(Imagick::LAYERMETHOD_FLATTEN)->save('/output.jpg');

// Validating integers before use
use Spatie\PdfToImage\Enums\LayerMethod;

$value = intval($_GET['layer_method']);
if (LayerMethod::isValid($value)) {
    $pdf->layerMethod($value)->save('/output.jpg');
}
```

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

### Output Generation Methods

Source: https://github.com/spatie/pdf-to-image/blob/main/_autodocs/INDEX.md

Methods to save converted pages to the filesystem, returning an array of results.

```text
save(string, string): array             // Save selected pages
saveAllPages(string, string): array     // Save all pages
```

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

### Create PageSize via factory method

Source: https://github.com/spatie/pdf-to-image/blob/main/_autodocs/api-reference/page-size.md

Use the static make method to create a PageSize instance.

```php
public static function make(int $width, int $height): self
```

```php
use Spatie\PdfToImage\DTOs\PageSize;

$size = PageSize::make(612, 792);
```

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

### Instantiate PdfPage

Source: https://github.com/spatie/pdf-to-image/blob/main/_autodocs/types.md

Constructor and factory method signatures for PdfPage.

```php
new PdfPage(int $number, OutputFormat $format, string $prefix, string $path)
```

```php
public static function make(int $pageNumber, OutputFormat $format, string $prefix, string $path): self
```

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

### PageSize::make

Source: https://github.com/spatie/pdf-to-image/blob/main/_autodocs/api-reference/page-size.md

Creates a new PageSize instance using the factory pattern.

```APIDOC
## public static make(int $width, int $height)

### Description
Creates a new PageSize instance using the factory pattern.

### Parameters
- **width** (int) - Required - Page width in pixels
- **height** (int) - Required - Page height in pixels

### Returns
- **PageSize** - A new instance of the PageSize class.
```

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

### Multiple pages conversion with prefix

Source: https://github.com/spatie/pdf-to-image/blob/main/_autodocs/api-reference/pdf-page.md

Converts selected pages to a directory with a specified filename prefix.

```php
use Spatie\PdfToImage\Pdf;

$pdf = new Pdf('/path/to/document.pdf');
$pdf->selectPages(1, 2, 3)->save('/path/to/output-directory/', 'page-');
// Creates:
// /path/to/output-directory/page-1.jpg
// /path/to/output-directory/page-2.jpg
// /path/to/output-directory/page-3.jpg
```

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

### Select Pages for Conversion

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

Specify which pages to render from the PDF document.

```php
$pdf->selectPage(2)
    ->save($pathToWhereImageShouldBeStored); //saves the second page
```

```php
$pdf->selectPages(2, 4, 5)
    ->save($directoryToWhereImageShouldBeStored); //saves the 2nd, 4th and 5th pages
```

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

### PdfPage::make()

Source: https://github.com/spatie/pdf-to-image/blob/main/_autodocs/api-reference/pdf-page.md

Creates a new PdfPage instance using the factory pattern.

```APIDOC
## PdfPage::make()

### Description
Creates a new PdfPage instance using the factory pattern. This method is used for explicit factory semantics.

### Signature
`public static function make(int $pageNumber, OutputFormat $format, string $prefix, string $path): self`

### Parameters
- **pageNumber** (int) - Required - PDF page number (1-indexed)
- **format** (OutputFormat) - Required - Output image format enum
- **prefix** (string) - Required - Filename prefix (can be empty)
- **path** (string) - Required - Target file or directory path

### Returns
- **PdfPage** - A new instance of the PdfPage class

### Example
```php
use Spatie\PdfToImage\DTOs\PdfPage;
use Spatie\PdfToImage\Enums\OutputFormat;

$page = PdfPage::make(1, OutputFormat::Jpg, 'page-', '/output/image.jpg');
```
```

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

### Handle Generic Exceptions in PHP

Source: https://github.com/spatie/pdf-to-image/blob/main/_autodocs/errors.md

Use a catch-all block to log errors during the PDF conversion process.

```php
use Spatie\\\PdfToImage\\\Pdf;

try {
    $pdf = new Pdf($inputPath);
    $pdf
        ->resolution(300)
        ->quality(90)
        ->selectPage(1)
        ->save($outputPath);
} catch (Exception $e) {
    error_log("PDF conversion failed: " . $e->getMessage());
}
```

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

### save(string $pathToImage, string $prefix = '')

Source: https://github.com/spatie/pdf-to-image/blob/main/_autodocs/api-reference/pdf.md

Saves the selected pages as images.

```APIDOC
## save(string $pathToImage, string $prefix = '')

### Description
Saves the selected pages as images. If a single page is selected, $pathToImage should be a file path. If multiple pages are selected, it must be a directory path.

### Parameters
- **pathToImage** (string) - Required - Output file path (single page) or directory path (multiple pages)
- **prefix** (string) - Optional - Prefix for generated filenames (multiple pages only)

### Returns
- **array<string>** - File paths of saved images

### Example
```php
$paths = $pdf->selectPage(1)->save('/path/to/output.jpg');
```
```

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

### Convert PDF page to PNG

Source: https://github.com/spatie/pdf-to-image/blob/main/_autodocs/implementation-guide.md

Demonstrates the fluent API usage for selecting a page, setting format and quality, and saving the output.

```php
$pdf = new Pdf('/doc.pdf')
  $pdf->selectPage(2)->format(OutputFormat::Png)->quality(95)->save('/out.png')
```

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

### All pages conversion with prefix

Source: https://github.com/spatie/pdf-to-image/blob/main/_autodocs/api-reference/pdf-page.md

Converts every page of the PDF to a directory with a specified prefix.

```php
use Spatie\PdfToImage\Pdf;

$pdf = new Pdf('/path/to/document.pdf');
$pdf->saveAllPages('/path/to/output-directory/', 'document-');
// Creates:
// /path/to/output-directory/document-1.jpg
// /path/to/output-directory/document-2.jpg
// /path/to/output-directory/document-3.jpg
// ... etc
```

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

### quality()

Source: https://github.com/spatie/pdf-to-image/blob/main/_autodocs/api-reference/pdf.md

Sets the compression quality for the output image.

```APIDOC
## quality(int $compressionQuality)

### Description
Sets the compression quality for the output image. Value must be between 1 and 100.

### Parameters
- **compressionQuality** (int) - Required - Compression quality: 1–100

### Returns
- **static** - Returns $this for fluent interface

### Throws
- **InvalidQuality** - If quality is less than 1 or greater than 100

### Example
```php
$pdf->quality(90)->save('/path/to/output.jpg');
```
```

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

### Select multiple pages in PHP

Source: https://github.com/spatie/pdf-to-image/blob/main/_autodocs/api-reference/pdf.md

Selects multiple pages for conversion using variadic arguments. Throws PageDoesNotExist if any provided page index is invalid.

```php
$pdf->selectPages(1, 3, 5)->save('/path/to/output-directory/');
```

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

### Chain configuration methods using the fluent interface

Source: https://github.com/spatie/pdf-to-image/blob/main/_autodocs/INDEX.md

Methods return $this to allow chaining configuration settings before triggering the final save operation.

```php
$pdf->resolution(300)->quality(90)->size(800)->save('/output.jpg');
```

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

### size(int $width, ?int $height)

Source: https://github.com/spatie/pdf-to-image/blob/main/_autodocs/api-reference/pdf.md

Resizes the output image to specified dimensions.

```APIDOC
## size(int $width, ?int $height)

### Description
Resizes the output image to specified dimensions. If height is omitted, it scales proportionally based on width.

### Parameters
- **width** (int) - Required - Output width in pixels (must be >= 0)
- **height** (int) - Optional - Output height in pixels (must be >= 0)

### Returns
- **static** - Returns $this for fluent interface

### Throws
- **InvalidSize** - if width or height is negative

### Example
```php
$pdf->size(800)->save('/path/to/output.jpg');
$pdf->size(800, 600)->save('/path/to/output.jpg');
```
```

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

### Set thumbnail dimensions in PHP

Source: https://github.com/spatie/pdf-to-image/blob/main/_autodocs/api-reference/pdf.md

Configures thumbnail size with optional proportional scaling. Throws InvalidSize if dimensions are negative.

```php
$pdf->thumbnailSize(400)->save('/path/to/output.jpg');
$pdf->thumbnailSize(400, 300)->save('/path/to/output.jpg');
```

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

### PageSize::__construct

Source: https://github.com/spatie/pdf-to-image/blob/main/_autodocs/api-reference/page-size.md

Creates a new PageSize instance with the specified width and height in pixels.

```APIDOC
## public __construct(int $width, int $height)

### Description
Creates a new PageSize instance with the specified dimensions.

### Parameters
- **width** (int) - Required - Page width in pixels
- **height** (int) - Required - Page height in pixels
```

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

### Construct PageSize instance

Source: https://github.com/spatie/pdf-to-image/blob/main/_autodocs/api-reference/page-size.md

Instantiate a new PageSize object with specific width and height dimensions.

```php
public function __construct(int $width, int $height)
```

```php
use Spatie\PdfToImage\DTOs\PageSize;

$size = new PageSize(612, 792);
echo $size->width;   // 612
echo $size->height;  // 792
```

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

### Import Enums

Source: https://github.com/spatie/pdf-to-image/blob/main/_autodocs/overview.md

Required imports for output formatting and layer methods.

```php
use Spatie\PdfToImage\Enums\OutputFormat;
use Spatie\PdfToImage\Enums\LayerMethod;
```

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

### Project Directory Structure

Source: https://github.com/spatie/pdf-to-image/blob/main/_autodocs/INDEX.md

Visual representation of the project's file organization and documentation hierarchy.

```text
output/
├── INDEX.md                    # This file
├── overview.md                 # Architecture overview
├── quick-reference.md          # Quick lookup guide
├── errors.md                   # Exception reference
├── types.md                    # Type definitions
├── implementation-guide.md     # Internal design
└── api-reference/
    ├── pdf.md                  # Pdf class
    ├── output-format.md        # OutputFormat enum
    ├── layer-method.md         # LayerMethod enum
    ├── page-size.md            # PageSize DTO
    └── pdf-page.md             # PdfPage DTO
```

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

### Configure Layer Method

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

Set the merge layer method for Imagick processing.

```php
$pdf->layerMethod(\Spatie\PdfToImage\Enums\LayerMethod::Merge);

// or disable layer merging:
$pdf->layerMethod(\Spatie\PdfToImage\Enums\LayerMethod::None);
```

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

### Handle Dynamic Format Selection

Source: https://github.com/spatie/pdf-to-image/blob/main/_autodocs/api-reference/output-format.md

Validate user-provided format strings against supported output formats before applying them.

```php
use Spatie\PdfToImage\Pdf;
use Spatie\PdfToImage\Enums\OutputFormat;

$pdf = new Pdf('/path/to/document.pdf');
$userFormat = $_GET['format'] ?? 'jpg';

if ($pdf->isValidOutputFormat($userFormat)) {
    $format = OutputFormat::from($userFormat);
    $pdf->format($format)->save("/output.{$userFormat}");
}
```

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

### Set Default Page Selection

Source: https://github.com/spatie/pdf-to-image/blob/main/_autodocs/implementation-guide.md

Initializes the default page selection to the first page.

```php
protected array $pages = [1];
```

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

### format()

Source: https://github.com/spatie/pdf-to-image/blob/main/_autodocs/api-reference/pdf.md

Sets the output format of the generated image. Default is OutputFormat::Jpg.

```APIDOC
## format(OutputFormat $outputFormat)

### Description
Sets the output format of the generated image. Default is `OutputFormat::Jpg`.

### Parameters
- **outputFormat** (OutputFormat) - Required - Output format enum: Jpg, Jpeg, Png, or Webp

### Returns
`static` (fluent interface)

### Example
```php
use Spatie\PdfToImage\Enums\OutputFormat;

$pdf->format(OutputFormat::Webp)->save('/path/to/output.webp');
```
```

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

### Apply Format-Based Processing

Source: https://github.com/spatie/pdf-to-image/blob/main/_autodocs/api-reference/output-format.md

Use the current format to conditionally apply settings like background color before saving.

```php
use Spatie\PdfToImage\Pdf;
use Spatie\PdfToImage\Enums\OutputFormat;

$pdf = new Pdf('/path/to/document.pdf');

match ($pdf->getFormat()) {
    OutputFormat::Jpg, OutputFormat::Jpeg => $pdf->backgroundColor('white'),
    OutputFormat::Png, OutputFormat::Webp => $pdf->backgroundColor('transparent'),
};

$pdf->save('/output.jpg');
```

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

### Set Image Resolution

Source: https://github.com/spatie/pdf-to-image/blob/main/_autodocs/api-reference/pdf.md

Configure the output image resolution in DPI using a fluent interface. The default resolution is 144 DPI.

```php
$pdf->resolution(300)->save('/path/to/output.jpg');
```

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

### PdfToImage SDK Methods

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

A collection of methods available in the Spatie\PdfToImage\Pdf class for PDF conversion and configuration.

```APIDOC
## PdfToImage SDK Methods

### save(string $path)
Converts the selected PDF page(s) to an image and saves it to the specified path. Returns an array of filenames if multiple images are saved, or a string path if a single image is saved.

### saveAllPages(string $directory)
Converts all pages of the PDF to images and saves them into the provided directory.

### pageCount()
Returns the total number of pages in the PDF as an integer.

### selectPage(int $pageNumber)
Selects a specific page to be rendered. Returns the Pdf instance for chaining.

### selectPages(int ...$pageNumbers)
Selects multiple specific pages to be rendered. Returns the Pdf instance for chaining.

### format(OutputFormat $format)
Sets the output image format (e.g., jpg, png, webp). Returns the Pdf instance for chaining.

### quality(int $quality)
Sets the compression quality from 0 to 100. Returns the Pdf instance for chaining.

### resolution(int $dpi)
Sets the output resolution in DPI. Returns the Pdf instance for chaining.

### thumbnailSize(int $width, ?int $height = null)
Sets the thumbnail dimensions. If height is omitted, it is calculated automatically. Returns the Pdf instance for chaining.

### size(int $width, ?int $height = null)
Sets the output image dimensions. If height is omitted, it is calculated automatically. Returns the Pdf instance for chaining.

### backgroundColor(string $color)
Sets the background color of the output image (supports text, hex, or rgb strings). Returns the Pdf instance for chaining.

### layerMethod(LayerMethod $method)
Sets the Merge Layer Method for Imagick. Returns the Pdf instance for chaining.

### getSize()
Returns a PageSize DTO containing the width and height of the PDF.

### isValidOutputFormat(string $format)
Checks if the provided file extension is a supported output format. Returns a boolean.
```

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

### Set layer method in Pdf class

Source: https://github.com/spatie/pdf-to-image/blob/main/_autodocs/api-reference/layer-method.md

Demonstrates applying layer methods using either the enum or raw Imagick constants.

```php
use Spatie\\\PdfToImage\\\Pdf;
use Spatie\\\PdfToImage\\\Enums\\\LayerMethod;

$pdf = new Pdf('/path/to/document.pdf');
$pdf->layerMethod(LayerMethod::Flatten)->save('/output.jpg');
```

```php
use Spatie\\\PdfToImage\\\Pdf;
use Imagick;

$pdf = new Pdf('/path/to/document.pdf');
$pdf->layerMethod(Imagick::LAYERMETHOD_FLATTEN)->save('/output.jpg');
```

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

### backgroundColor()

Source: https://github.com/spatie/pdf-to-image/blob/main/_autodocs/api-reference/pdf.md

Sets the background color of the output image.

```APIDOC
## backgroundColor(string $backgroundColorCode)

### Description
Sets the background color of the output image. Accepts CSS color format: color names, hex codes, or RGB notation.

### Parameters
- **backgroundColorCode** (string) - Required - Color in format: 'white', '#fff', 'rgb(255, 255, 255)'

### Returns
- **static** - The current instance for fluent interface usage
```

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

### PdfDoesNotExist Static Factory Method

Source: https://github.com/spatie/pdf-to-image/blob/main/_autodocs/errors.md

Creates an instance of the PdfDoesNotExist exception with a formatted message.

```php
public static function for(string $pdfFile): static
```

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

### Type-Safe Configuration with Enums

Source: https://github.com/spatie/pdf-to-image/blob/main/_autodocs/README.md

Uses enums to ensure valid configuration values for output formats and layer methods.

```php
$pdf->format(OutputFormat::Png);     // Type-safe
$pdf->layerMethod(LayerMethod::Merge); // Type-safe
```

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

### Run unit tests with PEST

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

Executes the project's unit test suite using the PEST framework.

```bash
./vendor/bin/pest
```

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

### Implement catch-all error handling

Source: https://github.com/spatie/pdf-to-image/blob/main/_autodocs/overview.md

A basic try-catch block for general PDF processing operations.

```php
try {
    $pdf = new Pdf($path);
    $pdf->quality(90)->save($output);
} catch (Exception $e) {
    handle_error($e);
}
```

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

### OutputFormat Enum Reference

Source: https://github.com/spatie/pdf-to-image/blob/main/_autodocs/quick-reference.md

Available image formats for the conversion process.

```php
OutputFormat::Jpg    // 'jpg'
OutputFormat::Jpeg   // 'jpeg'
OutputFormat::Png    // 'png'
OutputFormat::Webp   // 'webp'
```

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

### Optimize for size

Source: https://github.com/spatie/pdf-to-image/blob/main/_autodocs/api-reference/layer-method.md

Uses the optimize layer method to reduce output file size.

```php
use Spatie\\\PdfToImage\\\Pdf;
use Spatie\\\PdfToImage\\\Enums\\\LayerMethod;

$pdf = new Pdf('/path/to/document.pdf');
$pdf
    ->layerMethod(LayerMethod::Optimize)
    ->quality(80)
    ->save('/output.jpg');
```

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

### Catching PageDoesNotExist Exception

Source: https://github.com/spatie/pdf-to-image/blob/main/_autodocs/errors.md

Demonstrates how to handle the PageDoesNotExist exception when selecting an invalid page.

```php
use Spatie\PdfToImage\Pdf;
use Spatie\PdfToImage\Exceptions\PageDoesNotExist;

try {
    $pdf = new Pdf('/path/to/document.pdf');
    $pdf->selectPage(999)->save('/output.jpg');
} catch (PageDoesNotExist $e) {
    echo "Invalid page: " . $e->getMessage();
}
```

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

### Generate output filename

Source: https://github.com/spatie/pdf-to-image/blob/main/_autodocs/api-reference/pdf-page.md

Generate the full output path based on the page configuration.

```php
use Spatie\PdfToImage\DTOs\PdfPage;
use Spatie\PdfToImage\Enums\OutputFormat;

// Single page with prefix
$page = PdfPage::make(1, OutputFormat::Jpg, 'doc-', '/output/image.jpg');
echo $page->filename();  // /output/doc-image.jpg

// Single page without prefix
$page = PdfPage::make(1, OutputFormat::Png, '', '/output/image.png');
echo $page->filename();  // /output/image.png

// Multiple pages scenario (directory path)
$page = PdfPage::make(2, OutputFormat::Jpg, 'page-', '/output/2.jpg');
echo $page->filename();  // /output/page-2.jpg
```

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

### Pdf Class Fluent Interface

Source: https://github.com/spatie/pdf-to-image/blob/main/_autodocs/api-reference/pdf.md

The Pdf class allows for chaining configuration methods to define how a PDF should be converted to an image.

```APIDOC
## Pdf Class

### Description
Initializes a new PDF conversion instance and provides a fluent interface to configure output settings before saving.

### Constructor
`new Pdf(string $path)`

### Methods
- **resolution(int $resolution)**: Sets the output resolution in DPI.
- **quality(int $quality)**: Sets the output quality (0-100).
- **format(OutputFormat $format)**: Sets the output image format (e.g., Png).
- **selectPage(int $page)**: Selects a specific page from the PDF to convert.
- **size(int $width, int $height)**: Sets the dimensions of the output image.
- **save(string $path)**: Performs the conversion and saves the image to the specified path.

### Example
```php
$pdf = new Pdf('/path/to/document.pdf');
$pdf
    ->resolution(300)
    ->quality(90)
    ->format(OutputFormat::Png)
    ->selectPage(1)
    ->size(800, 600)
    ->save('/path/to/output.png');
```
```

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

### Set Image Quality

Source: https://github.com/spatie/pdf-to-image/blob/main/_autodocs/quick-reference.md

Define the output quality from 1 to 100.

```php
$pdf->quality(90)->save('/output.jpg');  // 1-100 (default: unset)
```

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

### Enable PDF read/write permissions in policy.xml

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

Add this policy rule to allow ImageMagick to process PDF files if a security policy error occurs.

```xml
<policy domain="coder" rights="read | write" pattern="PDF" />
```

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

### Preventing PdfDoesNotExist Exception

Source: https://github.com/spatie/pdf-to-image/blob/main/_autodocs/errors.md

Check file existence before initializing the Pdf class to avoid the exception.

```php
if (file_exists($path)) {
    $pdf = new Pdf($path);
}
```

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

### Validate Compression Quality

Source: https://github.com/spatie/pdf-to-image/blob/main/_autodocs/implementation-guide.md

Enforces quality constraints immediately to prevent invalid configurations.

```php
public function quality(int $compressionQuality): static
{
    if ($compressionQuality < 1 || $compressionQuality > 100) {
        throw InvalidQuality::for($compressionQuality);
    }
    // ...
}
```

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

### Set Output Resolution

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

Configure the DPI resolution for the generated image.

```php
$pdf->resolution(300) // resolution of 300 dpi
    ->save($pathToWhereImageShouldBeStored);
```

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

### Preserve transparency

Source: https://github.com/spatie/pdf-to-image/blob/main/_autodocs/api-reference/layer-method.md

Uses the optimize transparency method, typically paired with PNG output.

```php
use Spatie\\\PdfToImage\\\Pdf;
use Spatie\\\PdfToImage\\\Enums\\\LayerMethod;

$pdf = new Pdf('/path/to/document.pdf');
$pdf
    ->layerMethod(LayerMethod::OptimizeTrans)
    ->format(OutputFormat::Png)
    ->save('/output.png');
```

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

### Output Methods

Source: https://github.com/spatie/pdf-to-image/blob/main/_autodocs/INDEX.md

Methods to save the processed pages as images.

```APIDOC
## Output Methods

- **save(string, string): array**: Saves selected pages to the specified path.
- **saveAllPages(string, string): array**: Saves all pages to the specified path.
```

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

### Page Selection Methods

Source: https://github.com/spatie/pdf-to-image/blob/main/_autodocs/INDEX.md

Fluent methods to select specific pages or ranges for conversion.

```text
selectPage(int)         // Single page
selectPages(int...)     // Multiple pages
```

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

### Set Output Format

Source: https://github.com/spatie/pdf-to-image/blob/main/_autodocs/api-reference/output-format.md

Configures the output format for the PDF conversion process.

```php
public function format(OutputFormat $outputFormat): static
```

```php
use Spatie\PdfToImage\Pdf;
use Spatie\PdfToImage\Enums\OutputFormat;

$pdf = new Pdf('/path/to/document.pdf');
$pdf->format(OutputFormat::Webp)->save('/output.webp');
```

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

### Configure Imagick resource limits for ultra-wide PDFs

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

Update the policy.xml file to increase memory limits for width and height when processing large PDF files.

```xml
  <policy domain="resource" name="width" value="4GiB"/>
  <policy domain="resource" name="height" value="4GiB"/>
```

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

### Convert PDF to WebP

Source: https://github.com/spatie/pdf-to-image/blob/main/_autodocs/api-reference/output-format.md

Explicitly set the output format to WebP, which supports lower quality settings for efficient file sizes.

```php
use Spatie\PdfToImage\Pdf;
use Spatie\PdfToImage\Enums\OutputFormat;

$pdf = new Pdf('/path/to/document.pdf');
$pdf
    ->format(OutputFormat::Webp)
    ->quality(85)  // WebP can use lower quality for similar visual results
    ->save('/output.webp');
```

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

### Define Namespace

Source: https://github.com/spatie/pdf-to-image/blob/main/_autodocs/overview.md

The primary namespace for the library.

```php
Spatie\PdfToImage
```

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

### Set output image size in PHP

Source: https://github.com/spatie/pdf-to-image/blob/main/_autodocs/api-reference/pdf.md

Resizes the output image to specific dimensions or scales proportionally if height is omitted.

```php
$pdf->size(800)->save('/path/to/output.jpg');
$pdf->size(800, 600)->save('/path/to/output.jpg');
```

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

### Convert Specific Pages to PNG

Source: https://github.com/spatie/pdf-to-image/blob/main/_autodocs/overview.md

Select specific pages and convert them to PNG format.

```php
$pdf = new Pdf('/path/to/document.pdf');
$pdf
    ->selectPages(1, 3, 5)
    ->format(OutputFormat::Png)
    ->save('/path/to/output-directory/');
```

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

### Access OutputFormat Cases

Source: https://github.com/spatie/pdf-to-image/blob/main/_autodocs/api-reference/output-format.md

Individual enum cases for specifying output formats.

```php
OutputFormat::Jpg
```

```php
OutputFormat::Jpeg
```

```php
OutputFormat::Png
```

```php
OutputFormat::Webp
```

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

### Set Image Dimensions

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

Specify the width and height of the output image.

```php
$pdf->size(400) // set the width to 400px; height is calculated automatically
    ->save($pathToWhereImageShouldBeStored);
```

```php
$pdf->size(400, 300) // set the width to 400px and the height to 300px
    ->save($pathToWhereImageShouldBeStored);
```

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

### Configure Resolution Before Reading

Source: https://github.com/spatie/pdf-to-image/blob/main/_autodocs/implementation-guide.md

Resolution must be set prior to reading the PDF file, as Imagick utilizes this setting during the initial rendering process. Modifying resolution after reading would necessitate a costly re-read of the image.

```php
$this->imagick->setResolution($this->resolution, $this->resolution);
$this->imagick->readImage(sprintf('%s[%s]', $this->filename, $pageNumber - 1));
```

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

### Determine Output Format

Source: https://github.com/spatie/pdf-to-image/blob/main/_autodocs/implementation-guide.md

Resolves the output format based on explicit settings, filename extensions, or a default JPEG fallback.

```php
protected function determineOutputFormat(string $pathToImage): OutputFormat
{
    // Try to extract format from filename
    $outputFormat = OutputFormat::tryFrom(pathinfo($pathToImage, PATHINFO_EXTENSION));

    // Override with explicitly set format
    if (! empty($this->outputFormat)) {
        $outputFormat = $this->outputFormat;
    }

    // Fallback to JPEG if invalid
    if (! $this->isValidOutputFormat($outputFormat)) {
        $outputFormat = OutputFormat::Jpg;
    }

    return $outputFormat;
}
```

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

### Import Exception Classes

Source: https://github.com/spatie/pdf-to-image/blob/main/_autodocs/overview.md

Required imports for handling library-specific exceptions.

```php
use Spatie\PdfToImage\Exceptions\PdfDoesNotExist;
use Spatie\PdfToImage\Exceptions\PageDoesNotExist;
use Spatie\PdfToImage\Exceptions\InvalidQuality;
use Spatie\PdfToImage\Exceptions\InvalidSize;
use Spatie\PdfToImage\Exceptions\InvalidLayerMethod;
```

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

### Set Output Format

Source: https://github.com/spatie/pdf-to-image/blob/main/_autodocs/quick-reference.md

Specify the output file format using the OutputFormat enum.

```php
use Spatie\PdfToImage\Enums\OutputFormat;

$pdf->format(OutputFormat::Png)->save('/output.png');
$pdf->format(OutputFormat::Webp)->save('/output.webp');
```

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

### PageDoesNotExist Static Factory Method

Source: https://github.com/spatie/pdf-to-image/blob/main/_autodocs/errors.md

Creates an instance of the PageDoesNotExist exception with a formatted message.

```php
public static function for(int $pageNumber): static
```

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

### Use flatten layer method

Source: https://github.com/spatie/pdf-to-image/blob/main/_autodocs/api-reference/layer-method.md

Applies the flatten method, often requiring a background color for correct rendering.

```php
use Spatie\\\PdfToImage\\\Pdf;
use Spatie\\\PdfToImage\\\Enums\\\LayerMethod;

$pdf = new Pdf('/path/to/document.pdf');
$pdf
    ->layerMethod(LayerMethod::Flatten)
    ->backgroundColor('white')  // Flatten often requires a background color
    ->save('/output.jpg');
```

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

### Handle Specific Exceptions in PHP

Source: https://github.com/spatie/pdf-to-image/blob/main/_autodocs/errors.md

Catch granular exceptions to provide targeted feedback for file, page, quality, or size errors.

```php
use Spatie\\\PdfToImage\\\Pdf;
use Spatie\\\PdfToImage\\\Exceptions\\\PdfDoesNotExist;
use Spatie\\\PdfToImage\\\Exceptions\\\PageDoesNotExist;
use Spatie\\\PdfToImage\\\Exceptions\\\InvalidQuality;
use Spatie\\\PdfToImage\\\Exceptions\\\InvalidSize;

try {
    $pdf = new Pdf($inputPath);
    $pdf->quality($quality)->size($width, $height)->save($outputPath);
} catch (PdfDoesNotExist $e) {
    return error('File not found: ' . $inputPath);
} catch (PageDoesNotExist $e) {
    return error('Invalid page number');
} catch (InvalidQuality $e) {
    return error('Quality must be between 1 and 100');
} catch (InvalidSize $e) {
    return error('Dimensions must be non-negative');
}
```

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

### Batch Convert to Multiple Formats

Source: https://github.com/spatie/pdf-to-image/blob/main/_autodocs/api-reference/output-format.md

Iterate through an array of formats to generate multiple image outputs from a single PDF source.

```php
use Spatie\PdfToImage\Pdf;
use Spatie\PdfToImage\Enums\OutputFormat;

$pdf = new Pdf('/path/to/document.pdf');
$formats = [OutputFormat::Jpg, OutputFormat::Png, OutputFormat::Webp];

foreach ($formats as $format) {
    $filename = '/output/image.' . $format->value;
    $pdf->format($format)->save($filename);
}
```

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

### Set PATH environment variable in php-fpm.conf

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

Add this configuration to php-fpm.conf to ensure the PHP process can locate the Ghostscript 'gs' binary.

```ini
env[PATH] = /usr/local/bin:/usr/bin:/bin
```

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

### Toggle Antialiasing

Source: https://github.com/spatie/pdf-to-image/blob/main/_autodocs/quick-reference.md

Enable or disable antialiasing for the output.

```php
$pdf->antialiased(false)->save('/output.jpg');  // Default: true
```

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

### LayerMethod Enum Reference

Source: https://github.com/spatie/pdf-to-image/blob/main/_autodocs/quick-reference.md

Available methods for handling image layers during conversion.

```php
LayerMethod::None                // Disable merging
LayerMethod::Flatten             // Default
LayerMethod::Merge
LayerMethod::Coalesce
LayerMethod::CompareAny
LayerMethod::CompareClear
LayerMethod::CompareOverlay
LayerMethod::Dispose
LayerMethod::Optimize
LayerMethod::OptimizePlus
LayerMethod::OptimizeTrans
LayerMethod::Composite
LayerMethod::OptimizeImage
LayerMethod::RemoveDups
LayerMethod::RemoveZero
LayerMethod::Mosaic
LayerMethod::TrimBounds
LayerMethod::Undefined
```

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

### Calculate aspect ratio

Source: https://github.com/spatie/pdf-to-image/blob/main/_autodocs/api-reference/page-size.md

Calculate the aspect ratio to maintain proportions during resizing.

```php
use Spatie\PdfToImage\Pdf;

$pdf = new Pdf('/path/to/document.pdf');
$size = $pdf->getSize();

$aspectRatio = $size->width / $size->height;
echo "Aspect ratio: " . round($aspectRatio, 2);

// Resize while maintaining aspect ratio
$targetWidth = 800;
$targetHeight = (int)($targetWidth / $aspectRatio);
$pdf->size($targetWidth, $targetHeight)->save('/output.jpg');
```

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

### Set Thumbnail Size

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

Define dimensions for thumbnail generation.

```php
$pdf
   ->thumbnailSize(400) // set thumbnail width to 400px; height is calculated automatically
   ->save($pathToWhereImageShouldBeStored);

// or:
$pdf
   ->thumbnailSize(400, 300) // set thumbnail width to 400px and the height to 300px
   ->save($pathToWhereImageShouldBeStored);
```

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

### Calculate thumbnail dimensions

Source: https://github.com/spatie/pdf-to-image/blob/main/_autodocs/api-reference/page-size.md

Determine height based on a fixed width to create a thumbnail.

```php
use Spatie\PdfToImage\Pdf;

$pdf = new Pdf('/path/to/document.pdf');
$size = $pdf->getSize();

// Create a thumbnail with maximum width of 200px
$maxWidth = 200;
$thumbnailHeight = (int)(($size->height / $size->width) * $maxWidth);

$pdf->thumbnailSize($maxWidth, $thumbnailHeight)->save('/thumbnail.jpg');
```

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

### Exception Classes

Source: https://github.com/spatie/pdf-to-image/blob/main/_autodocs/INDEX.md

List of exceptions that may be thrown during library operations.

```text
PdfDoesNotExist
PageDoesNotExist
InvalidQuality
InvalidSize
InvalidLayerMethod
```

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

### Implement Input Validation Pattern in PHP

Source: https://github.com/spatie/pdf-to-image/blob/main/_autodocs/errors.md

Validate inputs before processing to avoid runtime exceptions during PDF conversion.

```php
use Spatie\\\PdfToImage\\\Pdf;
use Spatie\\\PdfToImage\\\Enums\\\LayerMethod;

if (!file_exists($pdfPath)) {
    throw new Exception("PDF file not found");
}

$pdf = new Pdf($pdfPath);

if ($pageNumber < 1 || $pageNumber > $pdf->pageCount()) {
    throw new Exception("Invalid page number");
}

if ($quality < 1 || $quality > 100) {
    throw new Exception("Quality must be between 1 and 100");
}

if (LayerMethod::isValid($layerMethod) === false) {
    throw new Exception("Invalid layer method");
}

// Now safe to call methods without exception handling
$pdf
    ->quality($quality)
    ->layerMethod($layerMethod)
    ->selectPage($pageNumber)
    ->save($outputPath);
```

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

### Configure Antialiasing

Source: https://github.com/spatie/pdf-to-image/blob/main/_autodocs/api-reference/pdf.md

Enables or disables antialiasing for the rendered image. Defaults to true.

```php
$pdf->antialiased(false)->save('/path/to/output.jpg');
```
Tokens:
Raw