elibyy / tcpdf-laravel
tcpdf support for Laravel 6, 7, 8, 9, 10, 11
Installs: 1 758 655
Dependents: 7
Suggesters: 0
Security: 0
Stars: 312
Watchers: 13
Forks: 74
Open Issues: 18
Requires
- illuminate/support: ^6.0|^7.0|^8.0|^9.0|^10.0|^11.0
- tecnickcom/tcpdf: 6.2.*|6.3.*|6.4.*|6.5.*|6.6.*|6.7.*|dev-main
- dev-master
- 11.1.0
- 11.0.1
- 11.0.0
- 10.0.3
- 10.0.2
- 10.0.1
- 10.0.0
- 9.3.0
- 9.2.0
- 9.1.0
- 9.0.0
- 8.1.2
- 8.1.1
- 8.1.0
- 8.0.1
- 8.0.0
- 7.0.0
- 6.0.x-dev
- 6.0.4
- 6.0.3
- 6.0.2
- 6.0.1
- 6.0.0
- 5.8.x-dev
- 5.8.0
- 5.7.x-dev
- 5.7.0
- 5.6.x-dev
- 5.6.4
- 5.6.3
- 5.6.2
- 5.6.1
- 5.6.0
- 5.5.x-dev
- 5.5.6
- 5.5.5
- 5.5.4
- 5.5.3
- 5.5.2
- 5.5.1
- 5.5.0
- 5.4.x-dev
- 5.4.6
- 5.4.5
- 5.4.4
- 5.4.3
- 5.4.2
- 5.4.1
- 5.4.0
- 5.3.x-dev
- 5.3.7
- 5.3.6
- 5.3.5
- 5.3.4
- 5.3.3
- 5.3.1
- 5.3.0
- 5.2.x-dev
- 5.2.9
- 5.2.8
- 5.2.7
- 5.2.6
- 5.2.5
- 5.2.4
- 5.2.3
- 5.2.2
- 5.2.1
- 5.2.0
- 5.1.x-dev
- 5.1.9
- 5.1.8
- 5.1.7
- 5.1.6
- 5.1.5
- 5.1.4
- 5.1.3
- 5.1.2
- 5.1.1
- 5.1.0
- 5.0.x-dev
- 5.0.8
- 5.0.7
- 5.0.6
- 5.0.5
- 5.0.4
- 5.0.3
- 5.0.2
- 5.0.1
- 5.0.0
This package is auto-updated.
Last update: 2024-09-26 08:58:59 UTC
README
A simple Laravel 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.
Installation
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)
composer require elibyy/tcpdf-laravel
or
Laravel 5.5+ will use the auto-discovery function.
{ "require": { "elibyy/tcpdf-laravel": "^9.0" } }
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
Configuration
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 --provider="Elibyy\TCPDF\ServiceProvider"
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
Header/Footer helpers
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){})