A simple Laravel 5 service provider with some basic configuration for including the TCPDF library
TCPDF is not really supported in PHP 7 but there's a plan for supporting it, check this out.
The Laravel TCPDF service provider can be installed via composer by requiring the elibyy/tcpdf-laravel
package in your project's composer.json
. (The installation may take a while, because the package requires TCPDF. Sadly its .git folder is very heavy)
Laravel 5.5+ will use the auto-discovery function.
{
"require": {
"elibyy/tcpdf-laravel": "5.7.*"
}
}
If you don't use auto-discovery you will need to include the service provider / facade in config/app.php
.
'providers' => [
//...
Elibyy\TCPDF\ServiceProvider::class,
]
//...
'aliases' => [
//...
'PDF' => Elibyy\TCPDF\Facades\TCPDF::class
]
(Please note: TCPDF cannot be used as an alias)
for lumen you should add the following lines:
$app->register(Elibyy\TCPDF\ServiceProvider::class);
class_alias(Elibyy\TCPDF\Facades\TCPDF::class, 'PDF');
That's it! You're good to go.
Here is a little example:
use PDF; // at the top of the file
PDF::SetTitle('Hello World');
PDF::AddPage();
PDF::Write(0, 'Hello World');
PDF::Output('hello_world.pdf');
another example for generating multiple PDF's
use PDF; // at the top of the file
for ($i = 0; $i < 5; $i++) {
PDF::SetTitle('Hello World'.$i);
PDF::AddPage();
PDF::Write(0, 'Hello World'.$i);
PDF::Output(public_path('hello_world' . $i . '.pdf'), 'F');
PDF::reset();
}
For a list of all available function take a look at the TCPDF Documentation
Laravel-TCPDF comes with some basic configuration. If you want to override the defaults, you can publish the config, like so:
php artisan vendor:publish
Now access config/tcpdf.php
to customize.
- use_original_header is to used the original
Header()
from TCPDF.- Please note that
PDF::setHeaderCallback(function($pdf){})
overrides this settings.
- Please note that
- use_original_footer is to used the original
Footer()
from TCPDF.- Please note that
PDF::setFooterCallback(function($pdf){})
overrides this settings.
- Please note that
- use_fpdi is so that our internal helper will extend
TcpdfFpdi
instead ofTCPDF
.- Please note fpdi is not a dependency in my project so you will have to follow their install instructions here
I've got a pull-request asking for this so I've added the feature
now you can use PDF::setHeaderCallback(function($pdf){})
or PDF::setFooterCallback(function($pdf){})