mPDF is a PHP library which generates PDF files from UTF-8 encoded HTML.
It is based on FPDF and HTML2FPDF (see CREDITS), with a number of enhancements. mPDF was written by Ian Back and is released under the GNU GPL v2 licence.
Note: If you are viewing this file on mPDF Github repository homepage or on Packagist, please note that the default repository branch is
development
which can differ from the last stable release.
Requirements
mPDF 7.0 requires PHP ^5.6 || ~7.0.0 || ~7.1.0
. PHP mbstring
and gd
extensions have to be loaded.
Additional extensions may be required for some advanced features such as zlib
for compression of output and
embedded resources such as fonts, bcmath
for generating barcodes or xml
for character set conversion
and SVG handling.
Support us
Consider supporting development of mPDF with a donation of any value. Donation button can be found on the main page of the documentation.
Installation
Official installation method is via composer and its packagist package mpdf/mpdf.
$ composer require mpdf/mpdf
Usage
The simplest usage (since version 7.0) of the library would be as follows:
<?php
require_once __DIR__ . '/vendor/autoload.php';
$mpdf = new \Mpdf\Mpdf();
$mpdf->WriteHTML('<h1>Hello world!</h1>');
$mpdf->Output();
This will output the PDF inline to the browser as application/pdf
Content-type.
Setup & Configuration
All configuration directives can
be set by the $config
parameter of the constructor.
It is recommended to set one's own temporary directory via tempDir
configuration variable.
The directory must have write permissions (mode 775
is recommended) for users using mPDF
(typically cli
, webserver
, fpm
).
<?php
$mpdf = new \Mpdf\Mpdf(['tempDir' => __DIR__ . '/tmp']);
By default, the temporary directory will be inside vendor directory and will have correct permissions from
post_install
composer script.
For more information about custom temporary directory see the note on Folder for temporary files in the section on Installation & Setup in the manual.
If you have problems, please read the section on troubleshooting in the manual.
Online manual
Online manual is available at https://mpdf.github.io/.
Contributing
See CONTRIBUTING.md file in the project.
Unit Testing
Unit testing for mPDF is done using PHPUnit.
To get started, run composer install
from the command line while in the mPDF root directory
(you'll need composer installed first).
To execute tests, run vendor/bin/phpunit
from the command line while in the mPDF root directory.
Any assistance writing unit tests for mPDF is greatly appreciated. If you'd like to help, please
note that any PHP file located in the /tests/
directory will be autoloaded when unit testing.