PHP WK HTML to PDF | WUI knowledgebase

Component ID

2197973

Component name

PHP WK HTML to PDF

Component type

module

Maintenance status

Actively maintained

Development status

Maintenance fixes only

Component security advisory coverage

covered

Downloads

10945

Component created

Mon, 02/17/2014 - 12:00

Component changed

Sat, 04/11/2015 - 12:00

Component body

After lots of frustration and not-close-enough results with other HTML to PDF modules & libraries, I decided to make a Drupal implementation of something I know works extremely well.

IMHO: WkHtmlToPdf is just fantastic!

The Print module was way more than I needed and still would have required custom work for my requirements.

This is intended for module developers, nothing is usable from the front-end.

This module is a Drupal Library implementation for the PHPWkHtmlToPdf wrapper and as a result is extremely small because it uses WkHtmlToPdf to do the heavy work.

Requirements

WkHtmlToPdf Installed

You must have WkHtmlToPdf installed and working on the server before attempting to use this module.
See wkhtmltopdf.org for OS specific binaries.

Basically you'll want to download the latest release package and install it via your package manager.

Ubuntu example

Example: sudo dpkg -i wkhtmltox-0.12.2.1_linux-precise-amd64.deb

Installation

Reminder, you must have the OS specific packages of WkHtmlToPdf installed before using this module.

Download and enable this module as you would any other Drupal module.
Install library dependencies via drush make:
drush make --no-core -y sites/all/modules/contrib/phpwkhtmltopdf/phpwkhtmltopdf.make
Verify the "PHPWkHtmlToPdf " library version is displayed on your Status Page under:
Reports > Status report.

Quick Start

The following example is an adaption from the official PhpWkHtmlToPdf docs located at: https://github.com/mikehaertl/phpwkhtmltopdf

if (($library = libraries_load('phpwkhtmltopdf')) && !empty($library['loaded'])) {
    $pdf = new WkHtmlToPdf();

    // Add a HTML file, a HTML string or a page from a URL
    $pdf->addPage('/home/joe/page.html');
    $pdf->addPage('<html>....</html>');
    $pdf->addPage('http://google.com');

    // Add a cover (same sources as above are possible)
    $pdf->addCover('mycover.html');

    // Save the PDF
    $pdf->saveAs('/tmp/new.pdf');

    // ... or send to client for inline display
    $pdf->send();

    // ... or send to client as file download
    $pdf->send('test.pdf');
}

Credits

A very special thanks goes out to the maintainers of WkHtmlToPDF and to authors of the PHP wrapper.

See WkHtmlTpPDF Contributors:
https://github.com/wkhtmltopdf/wkhtmltopdf/graphs/contributors

See PHP Wrapper Contributors:
https://github.com/mikehaertl/phpwkhtmltopdf/graphs/contributors

Component url

https://www.drupal.org/project/phpwkhtmltopdf

Categories