Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/niklasravnsborg/laravel-pdf
📄 Laravel PDF
https://github.com/niklasravnsborg/laravel-pdf
laravel mpdf pdf-generation
Last synced: about 2 months ago
JSON representation
📄 Laravel PDF
- Host: GitHub
- URL: https://github.com/niklasravnsborg/laravel-pdf
- Owner: niklasravnsborg
- Archived: true
- Created: 2016-04-18T08:41:25.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2023-08-22T12:16:36.000Z (over 1 year ago)
- Last Synced: 2024-05-18T16:46:11.260Z (7 months ago)
- Topics: laravel, mpdf, pdf-generation
- Language: PHP
- Homepage:
- Size: 103 KB
- Stars: 707
- Watchers: 24
- Forks: 208
- Open Issues: 44
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-pdf - laravel pdf
README
> [!WARNING]
> niklasravnsborg/laravel-pdf is not maintained! This repository has been deprecated and archived on 2023-08-22.
> Look at https://github.com/misterspelik/laravel-pdf for a potential alternative.
# Laravel PDF: mPDF wrapper for Laravel 5
> Easily generate PDF documents from HTML right inside of Laravel using this mPDF wrapper.
## Installation
Require this package in your `composer.json` or install it by running:
```
composer require niklasravnsborg/laravel-pdf
```
> 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
To start using Laravel, add the Service Provider and the Facade to your `config/app.php`:
```php
'providers' => [
// ...
niklasravnsborg\LaravelPdf\PdfServiceProvider::class
]
```
```php
'aliases' => [
// ...
'PDF' => niklasravnsborg\LaravelPdf\Facades\Pdf::class
]
```
Now, you should publish package's config file to your config directory by using following command:
```
php artisan vendor:publish
```
## 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 PDF;
function generate_pdf() {
$data = [
'foo' => 'bar'
];
$pdf = PDF::loadView('pdf.document', $data);
return $pdf->stream('document.pdf');
}
```
## Other methods
It is also possible to use the following methods on the `pdf` object:
`output()`: Outputs the PDF as a string.
`save($filename)`: Save the PDF to a file
`download($filename)`: Make the PDF downloadable by the user.
`stream($filename)`: Return a response with the PDF to show in the browser.
## Config
If you have published config file, you can change the default settings in `config/pdf.php` file:
```php
return [
'format' => 'A4', // See https://mpdf.github.io/paging/page-size-orientation.html
'author' => 'John Doe',
'subject' => 'This Document will explain the whole universe.',
'keywords' => 'PDF, Laravel, Package, Peace', // Separate values with comma
'creator' => 'Laravel Pdf',
'display_mode' => 'fullpage'
];
```
To override this configuration on a per-file basis use the fourth parameter of the initializing call like this:
```php
PDF::loadView('pdf', $data, [], [
'format' => 'A5-L'
])->save($pdfFilePath);
```
You can use a callback with the key 'instanceConfigurator' to access mpdf functions:
```php
$config = ['instanceConfigurator' => function($mpdf) {
$mpdf->SetImportUse();
$mpdf->SetDocTemplate(/path/example.pdf, true);
}]
PDF::loadView('pdf', $data, [], $config)->save($pdfFilePath);
```
## 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 [
// ...
'font_path' => base_path('resources/fonts/'),
'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
//'useOTL' => 0xFF, // required for complicated langs like Persian, Arabic and Chinese
//'useKashida' => 75, // required for complicated langs like Persian, Arabic and Chinese
]
// ...add as many as you want.
]
// ...
];
```
*Note*: If you are using `laravel-pdf` for producing PDF documents in a complicated language (like Persian, Arabic or Chinese) you should have `useOTL` and `useKashida` indexes in your custom font definition array. If you do not use these indexes, your characters will be shown dispatched and incorrectly in the produced PDF.
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 fews permissions: `'copy'`, `'print'`, `'modify'`, `'annot-forms'`, `'fill-forms'`, `'extract'`, `'assemble'`, `'print-highres'`.
```php
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
## Testing
To use the testing suite, you need some extensions and binaries for your local PHP. On macOS, you can install them like this:
```
brew install imagemagick ghostscript
pecl install imagick
```
## License
Laravel PDF is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT)