PDF Fieldtype/Inputfield

Module for ProcessWire CMS allowing you to easily generate images from the PDF files embedded to the site.

1. Requirements
2. Installation
3. How to use
   • In site's administration
   • In templates
4. API documentation
5. Tests
6. Upgrading from 1.0.1 and lower
7. Troubleshooting
8. Changelog

Requirements

• Processwire 3+
• ImageMagick PHP extension
• Ghostscript

For ProcessWire 2.x support use version 1.x, maintained in pw-2 branch.

Installation

How to install or uninstall modules.

Via Composer

In your ProcessWire installation root run:

composer require uiii/processwire-fieldtypepdf

Login to your ProcessWire admin and go to Modules > Refresh and install the module.

If you want to read more about ProcessWire and Composer visit https://processwire.com/blog/posts/composer-google-calendars-and-processwire/

How to use

In site's administration

Add a field and set its type to PDF. Use the field the same way as the file field (obviously, this accepts only *.pdf files). After the file is uploaded you will see a small thumbnail of it, just like for image field.

Image generation is highly configurable (image format, extension, background, ...). See the PDF to image converter section on field's Details tab.

In templates

There are some backward-compatible API changes against the version 1.0.1 and lower, see Upgrading from 1.0.1 and lower.

The PDF field extends file field and adds new hookable ___toImage($page = 0, $options = array()) method to generate the image from PDF.

$image = $page->pdfFile->toImage();
$image->size(100, 100);

Method accepts two optional parameters. First is the $page, which specifies the PDF's page number the image is generated from, default is 0. The exception is thrown if the page is out of range.

The second is $options parameter, which is an array of options to override the options set in administration.

$options = array(
	'suffix' => array('suffix1', 'suffix2'), // suffixes used in filename
	'forceNew' => false, // if TRUE the image is regenerated if already exists
	'format' => 'JPEG', // image format
	'extension' => 'jpg', // image file extension
	'background' => '#FFFFFF', // background color used when the PDF has transparent background
	'resolution' => '300x300', // resolution used when reading the PDF
	'colorspace' => Imagick::COLORSPACE_RGB, // colorspace used when reading the PDF
	'imagickOptions' => array( // ImageMagick options
		'pdf:use-cropbox=true'
	)
)

For each combinations of page and suffixes there will be one image. The generated images are saved in page's assets and will be created only once until forceNew options is TRUE. The image is the instance of Pageimage, so you can do with it whatever you can do with the image field. When you delete the PDF file the generated images are deleted too.

API documentation

Generate into doc directory:

apigen generate -d doc

Tests

DO NOT run the tests against the production site. They modify the fields, templates and pages as they need, so can potentially damage your site!

Prepare the PW testing installation and export the PW_PATH environment variable containing the path to the root of that installation. Copy the module sources in the $PW_PATH/site/modules/FieldtypePDF directory.

Install required packages:

composer install

Run the tests

./vendor/bin/phpunit

Test multiple ProcessWire versions (automatically)

You can also automatically test against multiple ProcessWire versions. It uses Tense tool for it.

1. Install reuquired packages:

   composer install
   

2. Run the tests:

   vendor/bin/tense run
   

WARNING: The tool will ask you for database connection parameters. Configure the db connection parameters carefully because it creates and drops a database for each ProcessWire installation.

Upgrading from 1.0.1 and lower

In 1.1.0 some methods of class PagePDF are deprecated. See the list here. You doesn't have to make any changes but it is recommended to use the new API, for compatibility with later versions.

Instructions for replacing the deprecated methods:

• $page->pdf->thumbnail($width, $height) replace with the code

$image = $page->pdf->toImage();
$image->size($width, $height);

• isThumbnail($basename) replace with isImageOfThis($basename)

NOTE: There is certain incompatibility between these two methods. While isThumbnail returns TRUE for all the images generated from the PDF and also theirs derivatives (e.g. pdf.jpg, pdf.100x100.jpg), the isImageOfThis return TRUE only for the images generated directly from PDF (e.g. pdf.jpg). That doesn't change much, because you can use it in combination with Pageimage::isVariation.

• removeThumbnails replace with removeImages

Troubleshooting

Thumbnail's colors do not match the colors in PDF

To fix that, you need to made some changes in ImageMagick delegate files. Detailed instructions can be found here: http://www.lassosoft.com/CMYK-Colour-Matching-with-ImageMagick

GhostScript exceptions occured

If you got some GhostScript exceptions when generating image, update GhostScript and ImageMagick to the latest versions.

If you can't, you can use the fallback mode. Turn it on in the module's settings.

Be aware of that this will produce low quality images and most of the field type options won't be abvailable.