Download the PHP package misterspelik/laravel-pdf without Composer
On this page you can find all versions of the php package misterspelik/laravel-pdf. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download misterspelik/laravel-pdf
More information about misterspelik/laravel-pdf
Files in misterspelik/laravel-pdf
Package laravel-pdf
Short Description Generate PDFs in Laravel with this mPDF wrapper.
License MIT
Informations about the package laravel-pdf
Laravel PDF: mPDF wrapper for Laravel
Easily generate PDF documents from HTML right inside of Laravel using this mPDF wrapper.
Supported versions
Minimum supported version is Laravel 5
Installation
Require this package in your composer.json
or install it by running:
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
:
Now, you should publish package's config file to your config directory by using following command:
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
.
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:
To override this configuration on a per-file basis use the fourth parameter of the initializing call like this:
You can use a callback with the key 'instanceConfigurator' to access mpdf functions:
Headers and Footers
If you want to have headers and footers that appear on every page, add them to your <body>
tag like this:
Now you just need to define them with the name attribute in your CSS:
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
):
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:
Custom Styles
You can use your own styles in the generated PDFs. The css file have to be located in one folder, e.g. /public/css/
. Add this to your configuration file (/config/pdf.php
):
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'
.
Find more information to SetProtection()
here: https://mpdf.github.io/reference/mpdf-functions/setprotection.html
PDF Wrapper extension
This package has own wrapper for the Mpdf\Mpdf class. But it can be also overrided or extended on the project level.
There is a setting in the config file to use a custom PdfWrapper.
The only requirement that the wrapper must implement the interface
misterspelik\LaravelPdf\PdfInterface\PdfWrapperInterface
Testing
To use the testing suite, you need some extensions and binaries for your local PHP. On macOS, you can install them like this:
License
Laravel PDF is open-sourced software licensed under the MIT license
All versions of laravel-pdf with dependencies
ext-gd Version *
ext-imagick Version *
ext-mbstring Version *
misterspelik/mpdf Version ^8.1.6
psr/http-message Version ^1.1 || ^2.0
psr/log Version ^1.1.0 || ^2.0.0 || ^3.0.0