Laravel Mpdf: Using Mpdf in Laravel for generate Pdfs
Easily generate PDF documents from HTML right inside of Laravel using this mpdf wrapper.
Important Notes
Currently supported mpdf version
8.0with FPDF version 2 and PHP version >= 7.0. MPDF documentation
mPDF will timeout on fetching external HTTP resources when using single-threaded servers such as
php -Sorartisan serve. Use a proper webserver for full functionality.
Installation
Require this package in your composer.json
"require": {
carlos-meneses/laravel-mpdf: "2.1.6"
}
or install it by running:
composer require carlos-meneses/laravel-mpdf
To start using Laravel, add the Service Provider and the Facade to your config/app.php:
'providers' => [
// ...
Meneses\LaravelMpdf\LaravelMpdfServiceProvider::class
]
'aliases' => [
// ...
'PDF' => Meneses\LaravelMpdf\Facades\LaravelMpdf::class
]
Note: This package supports auto-discovery features of Laravel 5.5+, You only need to manually add the service provider and alias if working on Laravel version lower then 5.5
Basic Usage
To use Laravel Mpdf add something like this to one of your controllers. You can pass data to a view in /resources/views.
//....
use PDF;
class ReportController extends Controller {
public function generate_pdf()
{
$data = [
'foo' => 'bar'
];
$pdf = PDF::loadView('pdf.document', $data);
return $pdf->stream('document.pdf');
}
}
Config
You can use a custom file to overwrite the default configuration. Just create config/pdf.php and add this:
return [
'mode' => '',
'format' => 'A4',
'default_font_size' => '12',
'default_font' => 'sans-serif',
'margin_left' => 10,
'margin_right' => 10,
'margin_top' => 10,
'margin_bottom' => 10,
'margin_header' => 0,
'margin_footer' => 0,
'orientation' => 'P',
'title' => 'Laravel mPDF',
'author' => '',
'watermark' => '',
'show_watermark' => false,
'watermark_font' => 'sans-serif',
'display_mode' => 'fullpage',
'watermark_text_alpha' => 0.1,
'custom_font_dir' => '',
'custom_font_data' => [],
'auto_language_detection' => false,
'temp_dir' => rtrim(sys_get_temp_dir(), DIRECTORY_SEPARATOR),
'pdfa' => false,
'pdfaauto' => false,
'use_active_forms' => false,
];
To override this configuration on a per-file basis use the fourth parameter of the initializing call like this:
PDF::loadView('pdf', $data, [], [
'title' => 'Another Title',
'margin_top' => 0
])->save($pdfFilePath);
Headers and Footers
If you want to have headers and footers that appear on every page, add them to your <body> tag like this:
<htmlpageheader name="page-header">
Your Header Content
</htmlpageheader>
<htmlpagefooter name="page-footer">
Your Footer Content
</htmlpagefooter>
Now you just need to define them with the name attribute in your CSS:
@page {
header: page-header;
footer: page-footer;
}
Inside of headers and footers {PAGENO} can be used to display the page number.
Included Fonts
By default you can use all the fonts shipped with Mpdf.
Custom Fonts
You can use your own fonts in the generated PDFs. The TTF files have to be located in one folder, e.g. resources/fonts/. Add this to your configuration file (/config/pdf.php):
return [
'custom_font_dir' => base_path('resources/fonts/'), // don't forget the trailing slash!
'custom_font_data' => [
'examplefont' => [
'R' => 'ExampleFont-Regular.ttf', // regular font
'B' => 'ExampleFont-Bold.ttf', // optional: bold font
'I' => 'ExampleFont-Italic.ttf', // optional: italic font
'BI' => 'ExampleFont-Bold-Italic.ttf' // optional: bold-italic font
]
// ...add as many as you want.
]
];
Now you can use the font in CSS:
body {
font-family: 'examplefont', sans-serif;
}
Get instance your Mpdf
You can access all mpdf methods through the mpdf instance with getMpdf().
use PDF;
$pdf = PDF::loadView('pdf.document', $data);
$pdf->getMpdf()->AddPage(...);
Chunk HTML
For big HTML you might get Uncaught Mpdf\MpdfException: The HTML code size is larger than pcre.backtrack_limit xxx error, or you might just get empty or blank result. In these situations you can use chunk methods while you added a separator to your HTML:
//....
use PDF;
class ReportController extends Controller {
public function generate_pdf()
{
$data = [
'foo' => 'hello 1',
'bar' => 'hello 2'
];
$pdf = PDF::chunkLoadView('<html-separator/>', 'pdf.document', $data);
return $pdf->stream('document.pdf');
}
}
<div>
<h1>Hello World</h1>
<table>
<tr><td>{{ $foo }}</td></tr>
</table>
<html-separator/>
<table>
<tr><td>{{ $bar }}</td></tr>
</table>
<html-separator/>
</div>
License
Laravel Mpdf is open-sourced software licensed under the MIT license
2 Jan 23, 2022
399 Jan 2, 2023
513 Dec 31, 2022
3.6k Jan 6, 2023
16 Aug 24, 2022
5 Sep 22, 2022
90 Nov 14, 2022
2.3k Jan 2, 2023
21 Dec 11, 2022
67 Dec 28, 2022
88 Jul 25, 2022
11 Feb 15, 2022
7 Dec 30, 2022
108 Jul 25, 2022
228 May 3, 2022
2 Sep 20, 2022
17 Sep 12, 2022
0 Dec 3, 2021