README

A wrapper around Imagick to ease out conversion of PDF file to a JPEG/JPG image.

Requirements

You should have Imagick and Ghostscript installed. See issues regarding Ghostscript.

Installation

The package can be installed via composer:

$ composer require break-down/pdf-to-image

Usage

Converting a pdf to an image is easy.

$pdf = new BreakDown\PdfToImage\PdfToImage(new BreakDown\PdfToImage\Resources\FilePath($pathToPdfFile));
$pdf->savePageAsImage($pageNumber, $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

You can override the output format:

$pdf->setOutputFormat('png')
    ->savePageAsImage($pageNumber, $pathToWhereImageShouldBeStored); //the output wil be a png, no matter what

You can set the quality of compression from 0 to 100:

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

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().

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

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

Credits

All Contributors

License

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

break-down / pdf-to-image

Maintainers

Details