forci/pdf-generator-bundle

A WKHTMLTOPDF based PDF Generator

Maintainers

Details

github.com/forci/pdf-generator-bundle

Source

Issues

Installs: 5 998

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 3

Forks: 0

Open Issues: 0

Type:symfony-bundle

v0.6.0 2022-04-06 22:37 UTC

Requires

Requires (Dev)

Suggests

MIT 63450fbdc30f83ff57ef96e0d11714b5dbf3325e

  • Martin Kirilov <wucdbm.woop@gmail.com>

html to pdfwucdbmpdf bundlesymfony pdf generatorsymfony html pdf

This package is auto-updated.

Last update: 2024-04-07 02:49:27 UTC

README

PDF Generator Bundle based on wkhtmltopdf

Requirements

  • xvfb to be installed on your server (apt-get install xvfb on debian/ubuntu)

By default this bundle uses the h4cc/wkhtmltopdf-i386 package's binary. To use your system binary, add this to your parameters.yml.dist file and do a composer install

    forci_pdf_generator.binary: wkhtmltopdf

Register the bundle in your AppKernel

<?php
public function registerBundles() {
    $bundles = [
        new Symfony\Bundle\FrameworkBundle\FrameworkBundle(),
        // Add ForciPdfGeneratorBundle to your AppKernel
        new \Forci\Bundle\PdfGenerator\ForciPdfGeneratorBundle(),
    ];
}

Basic Usage

<?php 

use \Forci\Bundle\PdfGenerator\Generator\PdfResult;

/** @var \Forci\Bundle\PdfGenerator\Generator\PdfGenerator $generator */
$generator = $container->get('forci_pdf_generator.generator');
$filename = 'someFile.pdf';
$html = 'someHtmlString';
// Get a PdfResult. The wkPrint and bootstrap methods both return a PdfResult
/** @var \Forci\Bundle\PdfGenerator\Generator\PdfResult $result */
$result = $generator->wkPrint($html);
// This will NOT cleanup on KernelEvents::TERMINATE
$result = $generator->wkPrint($html, false);
// The PdfResult is the result of the PDF generation. It has access to the temporary PDF file
$tempPdfPath = $result->realPath();
// return a Symfony BinaryFileResponse
return $generator->bootstrap($html)->response($filename);
// return a BinaryFileResponse, 500 on error
return $manager->wkPrint($html)->response($filename, PdfResult::RESPONSE_ON_ERROR_500_RESPONSE);
// return a Response, 500 on error. This will read the whole file into memory and set it to the newly created Response object
return $manager->wkPrint($html)->response($filename, PdfResult::RESPONSE_ON_ERROR_500_RESPONSE | PdfResult::RESPONSE_TYPE_NORMAL);
// return a Symfony Response and copy the file some place else
// The Generator does NOT save the files; it will unlink them as soon as the request is finished
// The copy() method returns PrintResult
return $generator->bootstrap($html)->copy('/some/location/someFile.pdf')->response($filename);
// And last, you can also get the PDF file contents as string
$contents = $generator->bootstrap($html)->contents();

TODO