DOMPDF Wrapper for Laravel

Laravel

 

Require this package in your composer.json and update composer. This will download the package and the dompdf + fontlib libraries also.

composer require barryvdh/laravel-dompdf

Lumen

 

After updating composer add the following lines to register provider in bootstrap/app.php

$app->register(\Barryvdh\DomPDF\ServiceProvider::class);

To change the configuration, copy the config file to your config folder and enable it in bootstrap/app.php:

$app->configure('dompdf');

Using

 

You can create a new DOMPDF instance and load a HTML string, file or view name. You can save it to a file, or stream (show in browser) or download.

    use Barryvdh\DomPDF\Facade\Pdf;

    $pdf = Pdf::loadView('pdf.invoice', $data);
    return $pdf->download('invoice.pdf');

or use the App container:

    $pdf = App::make('dompdf.wrapper');
    $pdf->loadHTML('<h1>Test</h1>');
    return $pdf->stream();

Or use the facade:

You can chain the methods:

    return Pdf::loadFile(public_path().'/myfile.html')->save('/path-to/my_stored_file.pdf')->stream('download.pdf');

You can change the orientation and paper size, and hide or show errors (by default, errors are shown when debug is on)

    Pdf::loadHTML($html)->setPaper('a4', 'landscape')->setWarnings(false)->save('myfile.pdf')

If you need the output as a string, you can get the rendered PDF with the output() function, so you can save/output it yourself.

Use php artisan vendor:publish to create a config file located at config/dompdf.php which will allow you to define local configurations to change some settings (default paper etc). You can also use your ConfigProvider to set certain keys.

Configuration

 

The defaults configuration settings are set in config/dompdf.php. Copy this file to your own config directory to modify the values. You can publish the config using this command:

    php artisan vendor:publish --provider="Barryvdh\DomPDF\ServiceProvider"

You can still alter the dompdf options in your code before generating the pdf using this command:

    Pdf::setOption(['dpi' => 150, 'defaultFont' => 'sans-serif']);

Available options and their defaults:

  • rootDir: “{app_directory}/vendor/dompdf/dompdf”
  • tempDir: “/tmp” (available in config/dompdf.php)
  • fontDir: “{app_directory}/storage/fonts” (available in config/dompdf.php)
  • fontCache: “{app_directory}/storage/fonts” (available in config/dompdf.php)
  • chroot: “{app_directory}” (available in config/dompdf.php)
  • logOutputFile: “/tmp/log.htm”
  • defaultMediaType: “screen” (available in config/dompdf.php)
  • defaultPaperSize: “a4” (available in config/dompdf.php)
  • defaultFont: “serif” (available in config/dompdf.php)
  • dpi: 96 (available in config/dompdf.php)
  • fontHeightRatio: 1.1 (available in config/dompdf.php)
  • isPhpEnabled: false (available in config/dompdf.php)
  • isRemoteEnabled: false (available in config/dompdf.php)
  • isJavascriptEnabled: true (available in config/dompdf.php)
  • isHtml5ParserEnabled: true (available in config/dompdf.php)
  • allowedRemoteHosts: null (available in config/dompdf.php)
  • isFontSubsettingEnabled: false (available in config/dompdf.php)
  • debugPng: false
  • debugKeepTemp: false
  • debugCss: false
  • debugLayout: false
  • debugLayoutLines: true
  • debugLayoutBlocks: true
  • debugLayoutInline: true
  • debugLayoutPaddingBox: true
  • pdfBackend: “CPDF” (available in config/dompdf.php)
  • pdflibLicense: “”
  • adminUsername: “user”
  • adminPassword: “password”
  • artifactPathValidation: null (available in config/dompdf.php)

Note: Since 3.x the remote access is disabled by default, to provide more security. Use with caution!

 

Tip: UTF-8 support

 

In your templates, set the UTF-8 Metatag:

<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>

Tip: Page breaks

 

You can use the CSS page-break-before/page-break-after properties to create a new page.

<style>
.page-break {
    page-break-after: always;
}
</style>
<h1>Page 1</h1>
<div class="page-break"></div>
<h1>Page 2</h1>

How to configure a header and footer in Dompdf

A. HTML Based Header/Footer

If you only want to set HTML on your footer and header, it will be enough to include the header and footer tags in the document with a specific dimensions. The position of both elements need to be fixed, otherwise they will be relative to the content of your PDF, thing that obviously we don’t want. You need to provide the dimensions of the page as well according to your needs. The following example generates a PDF of 2 pages with margins of the described height:

Dompdf Footer and Header

<html>
<head>
<style>
/** Define the margins of your page **/
@page {
margin: 100px 25px;
}

header {
position: fixed;
top: -60px;
left: 0px;
right: 0px;
height: 50px;

/** Extra personal styles **/
background-color: #03a9f4;
color: white;
text-align: center;
line-height: 35px;
}

footer {
position: fixed; 
bottom: -60px; 
left: 0px; 
right: 0px;
height: 50px;

/** Extra personal styles **/
background-color: #03a9f4;
color: white;
text-align: center;
line-height: 35px;
}
</style>
</head>
<body>
<!-- Define header and footer blocks before your content -->
<header>
Our Code World
</header>

<footer>
Copyright &copy; <?php echo date("Y");?> 
</footer>

<!-- Wrap the content of your PDF inside a main tag -->
<main>
<p style="page-break-after: always;">
Content Page 1
</p>
<p style="page-break-after: never;">
Content Page 2
</p>
</main>
</body>
</html>

B. Full width HTML Based Header/Footer

With the previous approach, you have a little problem. The header and the footer fit inside the margins of the page, which sometimes isn’t exactly what you need. In case that you need that the footer and header have the same width of the paper sheet, you need to proceed different. If this is the case, you may do the following: set the margins of the page to 0, this will automatically make that all the content of the PDF fits in the entire sheet, making that the footer and header have the 100% width. But you have another problem now and that is the margins of the real content of your PDF. This can be set with margins on the body, note that the margins (at least the top and bottom) need to be greater than the height of the footer and header or you won’t see part of your content. As last, apply your own styles to the elements as shown in the following example:

Full width footer and header on Dompdf

<html>
<head>
<style>
/** 
Set the margins of the page to 0, so the footer and the header
can be of the full height and width !
**/
@page {
margin: 0cm 0cm;
}

/** Define now the real margins of every page in the PDF **/
body {
margin-top: 2cm;
margin-left: 2cm;
margin-right: 2cm;
margin-bottom: 2cm;
}

/** Define the header rules **/
header {
position: fixed;
top: 0cm;
left: 0cm;
right: 0cm;
height: 2cm;

/** Extra personal styles **/
background-color: #03a9f4;
color: white;
text-align: center;
line-height: 1.5cm;
}

/** Define the footer rules **/
footer {
position: fixed; 
bottom: 0cm; 
left: 0cm; 
right: 0cm;
height: 2cm;

/** Extra personal styles **/
background-color: #03a9f4;
color: white;
text-align: center;
line-height: 1.5cm;
}
</style>
</head>
<body>
<!-- Define header and footer blocks before your content -->
<header>
Our Code World
</header>

<footer>
Copyright &copy; <?php echo date("Y");?> 
</footer>

<!-- Wrap the content of your PDF inside a main tag -->
<main>
<h1>Hello World</h1>
</main>
</body>
</html>

C. Image Based Header/Footer

If you want to add an image as footer and header, you will need to follow the same structure of the Full Width Html Based Header and Footer. However the content of the footer and header would be now an img tag with the corresponding image (with full height and width).

Dompdf Image as Footer and Header

<html>
<head>
<style>
/** 
Set the margins of the page to 0, so the footer and the header
can be of the full height and width !
**/
@page {
margin: 0cm 0cm;
}

/** Define now the real margins of every page in the PDF **/
body {
margin-top: 3cm;
margin-left: 2cm;
margin-right: 2cm;
margin-bottom: 2cm;
}

/** Define the header rules **/
header {
position: fixed;
top: 0cm;
left: 0cm;
right: 0cm;
height: 3cm;
}

/** Define the footer rules **/
footer {
position: fixed; 
bottom: 0cm; 
left: 0cm; 
right: 0cm;
height: 2cm;
}
</style>
</head>
<body>
<!-- Define header and footer blocks before your content -->
<header>
<img src="header.png" width="100%" height="100%"/>
</header>

<footer>
<img src="footer.png" width="100%" height="100%"/>
</footer>

<!-- Wrap the content of your PDF inside a main tag -->
<main>
<h1>Hello World</h1>
</main>
</body>
</html>