https://github.com/zanysoft/laravel-pdf
PDF document generator from HTML
https://github.com/zanysoft/laravel-pdf
html-to-pdf html-to-pdf-php laravel laravel-pdf mpdf pdf pdf-converter pdf-document pdf-files pdf-generation php
Last synced: 28 days ago
JSON representation
PDF document generator from HTML
- Host: GitHub
- URL: https://github.com/zanysoft/laravel-pdf
- Owner: zanysoft
- License: mit
- Created: 2017-02-20T08:00:19.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-12-18T16:27:43.000Z (10 months ago)
- Last Synced: 2025-06-21T06:47:23.831Z (4 months ago)
- Topics: html-to-pdf, html-to-pdf-php, laravel, laravel-pdf, mpdf, pdf, pdf-converter, pdf-document, pdf-files, pdf-generation, php
- Language: PHP
- Homepage: https://zanysoft.github.io/laravel-pdf/
- Size: 31.3 KB
- Stars: 7
- Watchers: 1
- Forks: 6
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Laravel PDF: PDF generator for Laravel
> Easily generate PDF documents from HTML right inside of Laravel using this PDF wrapper.
## Contents
- [Installation Guide](#installation-guide)
- [Configuration](#configuration)
- [Basic Usage](#basic-usage)
- [Headers and Footers](#headers-and-footers)
- [Included Fonts](#included-fonts)
- [Custom Fonts](#custom-fonts)
- [Set Protection](#set-protection)
- [Documentation](#documentation)
### Installation Guide
Require this package in your `composer.json` or install it by running:
```
composer require zanysoft/laravel-pdf
```
To start using Laravel, add the Service Provider and the Facade to your `config/app.php`:
```php
'providers' => [
// ...
ZanySoft\LaravelPDF\PdfServiceProvider::class
]
```
```php
'aliases' => [
// ...
'PDF' => ZanySoft\LaravelPDF\Facades\PDF::class
]
```
### Configuration
The defaults configuration settings are set in `config/pdf.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="ZanySoft\LaravelPDF\PdfServiceProvider"
### 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`.
```php
use ZanySoft\LaravelPDF\Facades\PDF;
$data = ['foo' => 'bar'];
$pdf = PDF::make('document.pdf');
$pdf->loadView('pdf.document', $data);
return $pdf->stream();
```
or
```php
use ZanySoft\LaravelPDF\PDF;
$pdf = new PDF();
$pdf->loadView('pdf.document', $data);
return $pdf->stream('document.pdf');
```
If you want to generate from html content:
```php
$content = "Hello this is first pdf file."
$pdf->loadHTML($content);
return $pdf->stream('document.pdf');
```
If you want to generate from files:
```php
$file = "file.txt"
$pdf->loadFile($file);
return $pdf->stream('document.pdf');
```
If you want download pdf file:
```php
return $pdf->embed('document.pdf');
```
If you want to save pdf to server:
```php
return $pdf->save('with-complete-path/document.pdf');
```
If you want add pdf file as attachment to email:
```php
return $pdf->embed('document.pdf');
```
### Headers and Footers
If you want to have headers and footers that appear on every page, add them to your `` tag like this:
```html
Your Header Content
Your Footer Content
```
Now you just need to define them with the name attribute in your CSS:
```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](https://mpdf.github.io/fonts-languages/available-fonts-v6.html).
### 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`):
```php
return [
'custom_font_path' => base_path('/resources/fonts/'), // don't forget the trailing slash!
];
```
And then:
```php
$fontdata = array(
'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.
);
$pdf->addCustomFont($fontdata, true);
// If your font file is unicode and "OpenType Layout" then set true. Default value is false.
```
Now you can use the font in CSS:
```css
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.
The passwords are optional.
There are a few permissions: `'copy'`, `'print'`, `'modify'`, `'annot-forms'`, `'fill-forms'`, `'extract'`, `'assemble'`, `'print-highres'`.
```php
use PDF;
function generate_pdf() {
$data = [
'foo' => 'bar'
];
$pdf = PDF::make();
$pdf->SetProtection(['copy', 'print'], 'user_pass', 'owner_pass')
$pdf->loadView('pdf.document', $data);
return $pdf->stream('document.pdf');
}
```
Find more information to `SetProtection()` here: https://mpdf.github.io/reference/mpdf-functions/setprotection.html
### Documentation
Visit this link for more options and settings: https://mpdf.github.io/