README

This package provides an easy to work with class to convert PDF's to images. It is based on the spatie/pdf-to-image library, which relied on Imagick for the conversion. This library relies on GD instead.

Requirements

You should have Ghostscript installed. See issues regarding Ghostscript.

Installation

The package can be installed via composer:

composer require drenso/pdf-to-image

Usage

Converting a pdf to an image is easy.

$pdf = new Drenso\PdfToImage\Pdf($pathToPdf);
$pdf->saveImage($pathToWhereImageShouldBeStored);

If the path you pass to saveImage has the extensions jpg, jpeg, or png the image will be saved in that format. Otherwise the output will be a jpg.

Other methods

You can get the total number of pages in the pdf:

$pdf->getNumberOfPages(); //returns an int

By default the first page of the pdf will be rendered. If you want to render another page you can do so:

$pdf->setPage(2)
    ->saveImage($pathToWhereImageShouldBeStored); //saves the second page

You can override the output format:

$pdf->setOutputFormat(ExportFormatEnum::PNG)
    ->saveImage($pathToWhereImageShouldBeStored); //the output wil be a png, no matter what

You can set the quality of compression (this depends on the export format, see the GD documentation for more details):

$pdf->setCompressionQuality(100); // sets the compression quality to maximum

You can specify the width to scale down the resulting image:

$pdf
   ->setWidth(400)
   ->saveImage($pathToWhereImageShouldBeStored);

Issues regarding Ghostscript

This package uses Ghostscript through Imagick. For this to work Ghostscripts gs command should be accessible from the PHP process. For the PHP CLI process (e.g. Laravel's asynchronous jobs, commands, etc...) this is usually already the case.

However for PHP on FPM (e.g. when running this package "in the browser") you might run into the following problem:

Uncaught ImagickException: FailedToExecuteCommand 'gs'

This can be fixed by adding the following line at the end of your php-fpm.conf file and restarting PHP FPM. If you're unsure where the php-fpm.conf file is located you can check phpinfo(). If you are using Laravel Valet the php-fpm.conf file will be located in the /usr/local/etc/php/YOUR-PHP-VERSION directory.

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

This will instruct PHP FPM to look for the gs binary in the right places.

Testing

composer test

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Credits

All Contributors

License

The MIT License (MIT). Please see License File for more information.

drenso / pdf-to-image

Maintainers

Details