Laravel PDF: mPDF wrapper for Laravel 5

Easily generate PDF documents from HTML right inside of Laravel using this mPDF wrapper., _(*1)

Installation

Require this package in your composer.json or install it by running:, _(*2)

composer require reposys/laravel-pdf

To start using Laravel, add the Service Provider and the Facade to your config/app.php:, _(*3)

'providers' => [
    // ...
    niklasravnsborg\LaravelPdf\PdfServiceProvider::class
]

'aliases' => [
    // ...
    'PDF' => niklasravnsborg\LaravelPdf\Facades\Pdf::class
]

Basic Usage

To use Laravel PDF add something like this to one of your controllers. You can pass data to a view in /resources/views., _(*4)

use PDF;

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:, _(*5)

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
];

To override this configuration on a per-file basis use the fourth parameter of the initializing call like this:, _(*6)

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:, _(*7)

<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:, _(*8)

@page {
    header: page-header;
    footer: page-footer;
}

Inside of headers and footers {PAGENO} can be used to display the page number., _(*9)

Included Fonts

By default you can use all the fonts shipped with mPDF., _(*10)

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):, _(*11)

return [
    'custom_font_path' => 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:, _(*12)

body {
    font-family: 'examplefont', sans-serif;
}

Set Protection

To set protection, you just call the SetProtection() method and pass an array with permissions, an user password and an owner password., _(*13)

The passwords are optional., _(*14)

There are a fews permissions: 'copy', 'print', 'modify', 'annot-forms', 'fill-forms', 'extract', 'assemble', 'print-highres'., _(*15)

use PDF;

function generate_pdf() {
    $data = [
        'foo' => 'bar'
    ];
    $pdf = PDF::loadView('pdf.document', $data);
    $pdf->SetProtection(['copy', 'print'], '', 'pass');
    return $pdf->stream('document.pdf');
}

Find more information to SetProtection() here: https://mpdf.github.io/reference/mpdf-functions/setprotection.html, _(*16)