Download the PHP package spatie/pdf-to-image without Composer
On this page you can find all versions of the php package spatie/pdf-to-image. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download spatie/pdf-to-image
More information about spatie/pdf-to-image
Files in spatie/pdf-to-image
Package pdf-to-image
Short Description Convert a pdf to an image
License MIT
Homepage https://github.com/spatie/pdf-to-image
Rated 3.13 based on 8 reviews
Informations about the package pdf-to-image
Convert a PDF to an image
This package provides an easy-to-work-with class to convert a PDF to one or more image.
Requirements
You should have Imagick and Ghostscript installed. See Imagick Issues for more information.
Installation
The package can be installed via composer and requires PHP 8.2+:
If you are using PHP < 8.2, use version 2.0 of this package.
Usage
Converting a PDF to an image is easy.
If the filename you pass to saveImage
has the extensions jpg
, jpeg
, png
, or webp
the image will be saved in that format; otherwise the output format will be jpg
.
The save()
method returns an array with the filenames of the saved images if multiple images are saved, otherwise returns a string with the path to the saved image.
Other methods
Get the total number of pages in the pdf:
Check if a file type is a supported output format:
By default, only the first page of the PDF will be rendered. To render another page, call the selectPage()
method:
Or, select multiple pages with the selectPages()
method:
Change the output format:
Set the output quality (the compression quality) from 0 to 100:
Set the output resolution DPI:
Specify the thumbnail size of the output image:
Set the output image width:
Set the output image width and height:
Get the dimensions of the PDF. This can be used to determine if the PDF is extremely high-resolution.
[!NOTE] $directoryToWhereImagesShouldBeStored must be an existing directory
Save all pages to images:
Set the Merge Layer Method for Imagick:
Set the background color of the output image:
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:
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.
This will instruct PHP FPM to look for the gs
binary in the right places.
Imagick Issues
If you receive an error with the message attempt to perform an operation not allowed by the security policy 'PDF'
, you may need to add the following line to your policy.xml
file. This file is usually located in /etc/ImageMagick-[VERSION]/policy.xml
, such as /etc/ImageMagick-7/policy.xml
.
Testing
spatie/pdf-to-image
uses the PEST framework for unit tests. They can be run with the following command:
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security Vulnerabilities
Please review our security policy on how to report security vulnerabilities.
Credits
- Freek Van der Herten
- Patrick Organ
- All Contributors
License
The MIT License (MIT). Please see License File for more information.
All versions of pdf-to-image with dependencies
ext-imagick Version *