eve / pdf-converter
Laravel package to convert HTML to PDF, supporting multiple drivers.
Installs: 4 065
Dependents: 0
Suggesters: 0
Security: 0
Stars: 11
Watchers: 5
Forks: 1
Open Issues: 0
Requires
- php: ^8.0
- barryvdh/laravel-dompdf: ^1.0.0
- eve/uuid: ^1.0
- illuminate/http: ^8.0|^9.0
- illuminate/log: ^8.0|^9.0
- illuminate/support: ^8.0|^9.0
- pdfcrowd/pdfcrowd: ^5.2
Requires (Dev)
- eve/coding-standard: ^1.1
- orchestra/testbench: ^6|^7.0
This package is auto-updated.
Last update: 2024-10-14 15:01:33 UTC
README
A Laravel package to help convert HTML to PDF. Supports multiple drivers.
Requirements and Installation
eve/pdf-converter requires Laravel 8.x and PHP 8.x. You can install the package via Composer:
composer require eve/pdf-converter
Next, publish the config file:
php artisan vendor:publish --provider="Eve\PdfConverter\ServiceProvider"
A pdf_converter.php
file will be copied into your application's config
folder.
Usage
eve/pdf-converter supports 4 drivers, which can be configured in .env
with the PDF_CONVERTER_DRIVER
key:
dompdf
: The default. Uses laravel-dompdf under the hood.mock
: Always returns a fixture PDF file. Doesn't do any actual conversion.log
: Logs the input HTML and the output path using Laravel's logger. Doesn't do any actual conversion.pdfcrowd
: Uses the commercial Pdfcrowd service. You'll have to set thePDFCROWD_USERNAME
andPDFCROWD_API_KEY
environment variables as well for this driver to work.
Of these drivers, mock
and log
are meant for development and/or testing purposes. dompdf
can be used for production but will most likely require some heavy configuration, when pdfcrowd
should be the best choice if you're willing to spend some bucks per month.
As eve/pdf-converter is developed first and foremost for eve's internal use, we don't have plans to add more drivers ourselves. PRs are welcome, though.
Once everything is set, the package is dead-boring. You can use either dependency injection or the facade (or both, depending on how silly you want your codebase to look).
Dependency Injection
Inject Eve\PdfConverter\PdfConverterInterface
and use it:
public function __construct(private \Eve\PdfConverter\PdfConverterInterface $converter) { $this->converter->configure('key', 'value'); // returns an \Illuminate\Http\File instance $this->converter->convertHtml('<p>Hello World</p>', '/path/to/output/file.pdf'); }
Facade
If you're a fan of Facades for whatever reason, eve/pdf-converter provides the \Eve\PdfConverter\Facades\PdfConverter
facade. This facade is even aliased to \PdfConverter
for your convenience.
public function generateInvoice(): void { \PdfConverter::configure('key', 'value'); \PdfConverter::convertHtml('<p>Free of charge</p>', '/my/invoice.pdf'); }
PDF Conversion Configuration
If you've been paying notice, the PDF conversion output can be tweaked via the configure
method:
$converter->configure(array|string $key, ...$values);
Now, the configuration options for the PDF conversion vary from driver to driver. Specifically:
-
For
log
andmock
drivers, the configurations are completely ignored. -
For
dompdf
, refer to the available options supported by laravel-dompdf itself. -
For
pdfcrowd
, refer to the official API reference. Look for thesetX()
functions. You can then useX
as the$key
argument forconfigure()
method and whateversetX()
takes as the$values
. For example:
License
MIT.