takeoo/zend-pdf

Create pdf from view in zend framework 2

HTML to PDF for zend framework

Create pdf from view in ZendFramework 3, _(*1)

Works on zend framework v3.*, _(*2)

IF you want to use it with older versions, use one of previous tags, _(*3)

Requirements

• wkhtmltopdf installed on your server, _(*4)

  • Debian, Ubuntu:, _(*5)

    sudo apt-get install wkhtmltopdf
    

  • *Debian servers have known errors with wkhtmltopdf lib, so if you get error like:, _(*6)

    wkhtmltopdf: cannot connect to X server
    

    install xvfb:, _(*7)

    sudo apt-get install xvfb
    

• zend-view 2.3* is installed as dependency
• zend-service-manager is already installed with 3.* version of zf3.

Install

• Composer install bash composer require takeoo/zend-pdf, _(*8)

• Add "Takeoo\Pdf" to 'modules' array in application.config.php, _(*9)

Usage

• Takeoo\Zend-pdf will create service throughout service manager, so it is available in serviceLocator as 'PdfCreator';, _(*10)

• Instantiate:, _(*11)

  $pdfCreator = $serviceManager->get('PdfCreator');
  

  NOTE: PdfCreator is not shared service, so every call to serviceManager will create new instance., _(*12)

  PdfCreator uses ViewResolver which is auto-magically injected to PhpRenderer if have MVC application, so you can use any view or layout you have in your app!, _(*13)

  • Set layout, _(*14)

    $pdfCreator->setLayoutTemplate('layout/pdf-template');
    

    • Add view as you would in your response, just pass name and variables to createHtml() function

    $pdfCreator->createHtml('path/to/view', ['variableName' => $variableValue]);
    

    OR you can directly pass already created view model, _(*15)

    $pdfCreator->createHtmlFromViewModel($viewModel);
    

  • Output, _(*16)

    • All modern browser support pdf output directly to browser:, _(*17)

      $pdfCreator->output();
      

    • get file handle, _(*18)

      $pdfCreator->writePdf();
      

    NOTE: Both above functions will save file to your disk, _(*19)

  • Get file path, _(*20)

    $pdfCreator->getFilePath();
    

  • By default all files are generated to your project root into "{Ymd_His}.pdf", _(*21)

  • Change file destination, _(*22)

    $pdfCreator->setPdfFileName('path/to/desired/folder/nameofyourfile.pdf');
    

  NOTE: All functions with public scope (with exception of output() and writePdf()) are fluent, so you can chain all functions:, _(*23)

  $pdfCreator->setLayoutTemplate('layout/pdf-layout')
   ->createHtml('view', ['variable1' => $variable1Value])
   ->setPdfFileName('./../file.pdf')
   ->setHasXvfb(false)
   ->output();
  

  NOTE: By default all wkhtmltopdf conversions are created with setHasXvfb(true), so you have to have installed Xvfb on your server! If you want to turn it of just do:, _(*24)

$pdfCreator->setHasXvfb(false);