README.md

NucleosDompdfBundle

This bundle provides a wrapper for using dompdf inside Symfony.

Installation

Open a command console, enter your project directory and execute the following command to download the latest stable version of this bundle:

composer require nucleos/dompdf-bundle

Enable the Bundle

Then, enable the bundle by adding it to the list of registered bundles in config/bundles.php file of your project:

// config/bundles.php

return [
    // ...
    Nucleos\DompdfBundle\NucleosDompdfBundle::class => ['all' => true],
];

Configure the Bundle

# config/packages/nucleos_dompdf.yaml

nucleos_dompdf:
    defaults:
        defaultFont: 'helvetica'
        # See https://github.com/dompdf/dompdf/wiki/Usage#options for available options

Usage

Whenever you need to turn a html page into a PDF use dependency injection for your service:

use Nucleos\DompdfBundle\Factory\DompdfFactoryInterface;
use Nucleos\DompdfBundle\Wrapper\DompdfWrapperInterface;

final class MyService
{
    public function __construct(DompdfFactoryInterface $factory)
    {
        $this->factory = $factory;
    }

    public function render()
    {
        // ...
        /** @var Dompdf\Dompdf $dompdf */
        $dompdf = $this->factory->create();
        // Or pass an array of options:
        $dompdf = $this->factory->create(['chroot' => '/home']);
        // ...
    }
}

final class MyOtherService
{
    public function __construct(DompdfWrapperInterface $wrapper)
    {
        $this->wrapper = $wrapper;
    }

    public function stream()
    {
        // ...
        $html = '<h1>Sample Title</h1><p>Lorem Ipsum</p>';

        /** @var Symfony\Component\HttpFoundation\StreamedResponse $response */
        $response = $this->wrapper->getStreamResponse($html, "document.pdf");
        $response->send();
        // ...
    }

    public function binaryContent()
    {
        // ...
        return $this->wrapper->getPdf($html);
        // ...
    }
}

Render pdf using Twig

If you use Twig to create the content, make sure to use renderView() instead of render(). Otherwise you might get the following HTTP header printed inside your PDF:

HTTP/1.0 200 OK Cache-Control: no-cache

$html = $this->renderView('my_pdf.html.twig', array(
    // ...
));
$this->wrapper->getStreamResponse($html, 'document.pdf');

Using asset() to link assets

First, make sure your chroot is correctly set and isRemoteEnabled is true.

# config/packages/nucleos_dompdf.yaml

nucleos_dompdf:
    defaults:
        chroot: '%kernel.project_dir%/public/assets'
        isRemoteEnabled: true

Second, use {{ absolute_url( asset() ) }}

<img src={{ absolute_url( asset('assets/example.jpg') ) }}>

Events

The dompdf wrapper dispatches events to conveniently get the inner dompdf instance when creating the PDF.

• dompdf.output is dispatched in getPdf()
• dompdf.stream is dispatched in streamHtml()

See Symfony Events and Event Listeners for more info.

Dom PDF use

Use listeners if you want to hook to DomPDF page_script and/or callbacks.

Simple implementation with twig rendering, add page number to the footer with page_script:

DomPDF documentation: Page Script

namespace App\EventListener;

use Symfony\Component\EventDispatcher\Attribute\AsEventListener;

final class DomPdfListener {
    #[AsEventListener(event: 'dompdf.stream')]
    public function onDompdfOutput($event): void
    {
        // Get DOMPDF instance
        $domPdf      = $event->getPdf();
        // Get canvas instance
        $canvas      = $domPdf->getCanvas();

        $canvas->page_script(function ($pageNumber, $pageCount, $canvas, $fontMetrics) {
            $pageWidth  = $canvas->get_width();
            $pageHeight = $canvas->get_height();

            // page number
            $text  = "Page $pageNumber of $pageCount";
            $font  = $fontMetrics->getFont('Helvetica');
            $size  = 10;
            $width = $fontMetrics->getTextWidth($text, $font, $size);
            $canvas->text($pageWidth - $width - 20, $pageHeight - 20, $text, $font, $size);
        });
    }

callback example to add a watermark (can be achieved with page_script as well): DomPDF documentation: Callbacks

    [...]
    $domPdf      = $event->getPdf();
    $canvas      = $domPdf->getCanvas();

    $domPdf->setCallbacks(
        [
            [
                'event' => 'begin_page_render',
                'f'     => function ($frame, $canvas, $fontMetrics) {
                    // watermark
                    $text  = 'WaterMak text';
                    $font  = $fontMetrics->getFont('Helvetica', 'bold');
                    $size  = 48;
                    $width = $fontMetrics->getTextWidth($text, $font, $size);
                    $x     = ($canvas->get_width() - $width) / 2;
                    $y     = ($canvas->get_height() - $size) / 2;
                    $canvas->page_text($x, $y, $text, $font, $size, [0.5, 0.5, 0.5, "alpha" => 0.4], 20, 0, -45);
                },
            ],
        ]
    );
    [...]

There are 6 events available, see documentation for more details:

• begin_page_reflow
• begin_frame
• end_frame
• begin_page_render
• end_page_render
• end_document

License

This bundle is under the MIT license.