Skip to content


Subversion checkout URL

You can clone with
Download ZIP
CakePHP plugin for creating and/or rendering PDFs, supporting several popular PDF engines.
Latest commit 3cef0c9 @dakota dakota Merge pull request #129 from QueenCityCodeFactory/3.1
Readme Fix for CakePHP 3.1

CakePdf plugin

Build Status License

Plugin containing CakePdf lib which will use a PDF engine to convert HTML to PDF.

Current engines:

  • DomPdf
  • Mpdf
  • Tcpdf



You can install this plugin into your CakePHP application using composer. For existing applications you can add the following to your composer.json file:

"require": {
    "friendsofcake/cakepdf": "3.0.x-dev"

And run php composer.phar update, or composer update (Depending on your composer setup)

CakePdf does not include any of the supported PDF engines, you need to install them yourself. The recommend wkhtmltopdf engine can be downloaded from, by default CakePdf expects the wkhtmltopdf binary to be located in /usr/bin/wkhtmltopdf.

DomPdf, Mpdf and Tcpdf can be installed via composer using on of the following commands:

composer require dompdf/dompdf
composer require
composer require mpdf/mpdf


In config/bootstrap.php add:

Plugin::load('CakePdf', array('bootstrap' => true, 'routes' => true));


Use Configure::write('CakePdf', $config); or set Controller property $pdfConfig (only when used with PdfView) You need to define at least $config['engine']. When using CakePdf directly you can also pass the config array to constructor. The value for engine should have the Plugin.ClassName format without the Engine suffix

Configuration options:

  • engine: Engine to be used (required), or an array of engine config options
    • className: Engine class to use
    • binary: Binary file to use (Only for wkhtmltopdf)
    • options: Options to pass on to wkhtmltopdf
  • crypto: Crypto engine to be used, or an array of crypto config options
    • className: Crypto class to use
    • binary: Binary file to use
  • pageSize: Change the default size, defaults to A4
  • orientation: Change the default orientation, defaults to potrait
  • margin: Array or margins with the keys: bottom, left, right, top and their values
  • title: Title of the document
  • encoding: Change the encoding, defaults to UTF-8
  • download: Set to true to force a download, only when using PdfView
  • filename: Filename for the document when using forced download


    Configure::write('CakePdf', [
        'engine' => 'CakePdf.WkHtmlToPdf',
        'margin' => [
            'bottom' => 15,
            'left' => 50,
            'right' => 30,
            'top' => 45
        'orientation' => 'landscape',
        'download' => true

    class InvoicesController extends AppController {
        //in your Invoices controller you could set additional configs, or override the global ones:
        public function view($id = null) {
            $invoice = $this->Invoice->get($id);
                'pdfConfig' => [
                    'orientation' => 'portrait',
                    'filename' => 'Invoice_' . $id
            $this->set('invoice', $invoice);

The engine and crypto config options can also be arrays with configuration options for the relevant class. For example,

    Configure::write('CakePdf', [
        'engine' => [
            'className' => 'CakePdf.WkHtmlToPdf',
            // Mac OS X / Linux is usually like:
            'binary' => '/usr/local/bin/wkhtmltopdf',
            // On Windows environmnent you NEED to use the path like
            // old fashioned MS-DOS Paths, otherwise you will keep getting:
            // WKHTMLTOPDF didn't return any data
            // 'binary' => 'C:\\Progra~1\\wkhtmltopdf\\bin\\wkhtmltopdf.exe',
            'options' => [
                'print-media-type' => false,
                'outline' => true,
                'dpi' => 96


You can use CakePdf in 2 ways, read carefully which one you actually need. Many people mix both ways and don't get the expected results.

1: Render as PDF (including forced download) in the browser with PdfView

You can create PDF view and layout files for your controller actions and have them automatically rendered. Place the view templates in a 'pdf' subdir, for instance src/Template/Invoices/pdf/view.ctp Layouts will be in src/Template/Layouts/pdf/default.ctp

Make sure your InvoicesController has RequestHandler Component in the $components array. Browse to http://localhost/invoices/view/1.pdf

Additionally you can map resources by adding Router::mapResources(array('Invoices')); to your routes file and you can access the same document at http://localhost/invoices/1.pdf

2: Create PDF for email attachment, file storage etc.

You can use CakePdf lib to create raw PDF data with a view template. The view file path would look like src/Template/Pdf/newsletter.ctp. Layout file path would be like src/Template/Layouts/pdf/default.ctp Note that layouts for both usage types are within same directory, but the view templates use different file paths Optionally you can also write the raw data to file.


    $CakePdf = new \CakePdf\Pdf\CakePdf();
    $CakePdf->template('newsletter', 'default');
    //get the pdf string returned
    $pdf = $CakePdf->output();
    //or write it to file directly
    $pdf = $CakePdf->write(APP . 'files' . DS . 'newsletter.pdf');


You can optionally encrypt the PDF with permissions

To use encryption you first need to select a crypto engine. Currently we support the following crypto engines:

  • Pdftk


Add the following in your bootstrap.

Configure::write('CakePdf.crypto', 'CakePdf.Pdftk');

Options in pdfConfig:

  • protect: Set to true to enable encryption
  • userPassword (optional): Set a password to open the PDF file
  • ownerPassword (optional): Set the password to unlock the locked permissions
  • one of the above must be present, either userPassword or ownerPassword
  • permissions (optional): Define the permissions


By default, we deny all permissions.

To allow all permissions:

Set 'permission' to true

To allow specific permissions:

Set 'permissions' to an array with a combination of the following available permissions:

  • print
  • degraded_print
  • modify,
  • assembly,
  • copy_contents,
  • screen_readers,
  • annotate,
  • fill_in

Note about static assets

Use absolute URLs for static assets in your view templates for PDFs. If you use HtmlHelper::image(), HtmlHelper::script() or HtmlHelper::css() make sure you have $options['fullBase'] = true

Another solution would be to create a AppHelper of which it would force $options['fullBase'] = true for PDF requests. e.g:

class AppHelper extends Helper {
    public function assetUrl($path, $options = array()) {
        if (!empty($this->request->params['ext']) && $this->request->params['ext'] === 'pdf') {
            $options['fullBase'] = true;
        return parent::assetUrl($path, $options);


Many thanks to Kim Biesbjerg and Jelle Henkens for their contributions. Want your name here as well? Create a pull request for improvements/other PDF engines.

Something went wrong with that request. Please try again.