spraed/pdf-generator-bundle

This bundle creates (multiple) PDFs in Symfony from Twig/HTML templates.

v1.12.1 2024-03-06 19:48 UTC

Requires

• php: ^8.0
• matthiasnoback/symfony-config-test: ^4.2.1
• symfony/framework-bundle: ^6.0.4

Requires (Dev)

• phpunit/phpunit: ^8.4

MIT

• Stefan Blanke
• Symfony Community

• generator
• bundle
• pdf
• spraed

README

SpraedPDFGeneratorBundle generates HTML documents to PDF. The bundle gives you the chance to add a page header and footer very easily (which can be disabled/switched on the first page).

It works with a little jar library based on the [Flying Saucer project][flyingsaucer]. So you need to run Java on your server (Java 6 or later).

Installation using Composer

composer require spraed/pdf-generator-bundle

Usage

There is a service registered in the services.yml to generate pdf files. Just call the PDF generator from the service class and call the generatePDF() method with the XHTML and the url of the PDF:

$html = $this->renderView('AcmeDemoBundle:Default:index.html.twig');
$pdfGenerator = $this->get('spraed.pdf.generator');

Also you are able to set an encoding option (you can leave the second parameter, it defaults to UTF-8):

$pdfGenerator->generatePDF($html, 'UTF-8');

Anything else will be handled by the Response object in the controller, i.e.:

    $html = $this->renderView('ACMEYourBundle:Print:print.html.twig');
    $pdfGenerator = $this->get('spraed.pdf.generator');

    return new Response($pdfGenerator->generatePDF($html),
                    200,
                    array(
                        'Content-Type' => 'application/pdf',
                        'Content-Disposition' => 'inline; filename="out.pdf"'
                    )
    );

If you wish the pdf to be offered as a download, simply change 'inline' in 'Content-Disposition' to 'attachment'.

Make sure that all assets in your HTML are linked with absolute paths, because the HTML is copied into a tmp folder on the server. If you want to add an image to your twig it should look something like this:

    {{ app.request.scheme ~'://' ~ app.request.httpHost ~ asset('images/foo.jpg') }}

You are also capable of printing multiple pdfs in one stack. Saying you generate multiple documents from multiple html files and you want to output those in on huge pdf file, there is the 'generatePDFs' method which takes an array of rendered html Views and sticks those together:

    $twigs[0] = 'SpraedSomethingBundle:Print:print_pdf_one.html.twig'
    $twigs[1] = 'SpraedSomethingBundle:Print:print_pdf_two.html.twig'

    $htmlCollection = array();
    foreach($twigs as $twig){
            $htmlCollection[] = $this->renderView($twig);
    }

    return new Response($pdfGenerator->generatePDFs($htmlCollection, 'UTF-8'),
        200,
        array(
            'Content-Type' => 'application/pdf',
            'Content-Disposition' => 'inline; filename="out.pdf"'
        )
    );

To define proper print css you might want to read into the w3.org's hints on that: [w3.org] [w3.org]: http://www.w3.org/TR/css3-page/ [flyingsaucer]: https://github.com/flyingsaucerproject/flyingsaucer [spraed]: http://www.spraed.com

Configuration

Example configuration options:

    spraed_pdf_generator:
        command:
            env:
                FOO: BAR
        java:
            full_path: /path/to/java

The command environment will add environment variables when running the Java application.