wemersonjanuario / laravelpdf
Another HTML to PDF Converter for Laravel
Installs: 12 514
Dependents: 1
Suggesters: 7
Security: 0
Stars: 28
Watchers: 2
Forks: 3
Open Issues: 7
Requires
- php: >=5.4.0
- illuminate/http: 5.x
- illuminate/view: 5.x
- wemersonjanuario/pdf: 1.x
Suggests
This package is not auto-updated.
Last update: 2024-11-20 16:29:05 UTC
README
This is a yet another html to pdf converter for Laravel 5(see Laravel 4 here cangelis/l4pdf). This package uses wkhtmltopdf as a third-party tool so proc_*()
functions has to be enabled in your php configurations and wkhtmltopdf
tool should be installed in your machine (You can download it from here).
If you are not a Laravel user, check out here
Installation
Step 1
Add this to your composer.json
{
"require": {
"wemersonjanuario/laravelpdf": "1.1.*"
}
}
Step 2
Add this line to providers
array in your config/app.php
Novanti\LaravelPDF\PDFServiceProvider::class
Step 3
Add this line to aliases
array in your config/app.php
'PDF' => Novanti\LaravelPDF\PDFFacade::class,
Step 4
Run this command to publish the configurations of this package
php artisan vendor:publish
Step 5
Configure your wkhtmltopdf
executable path under config/laravelpdf.php
'executable' => '/usr/bin/wkhtmltopdf'
Some examples
PDF::loadView('pdf.invoice')->download('invoice.pdf');
PDF::loadURL('http://www.laravel.com')->grayscale()->pageSize('A3')->orientation('Landscape')->stream('laravel.pdf')
Route::get('/', function() {
return PDF::loadHTML('<strong>Hello World</strong>')->lowquality()->pageSize('A2')->download();
});
Since 1.0.3 the library supports generating PDF from multiple Laravel views of HTML pieces. Each part begins from a new page. Examples of using this feature:
PDF::loadViews(['pdf.order', 'pdf.invoice', 'pdf.wiretransfer'])->download('payment-bundle.pdf');
$htmlPages[] = getMainReport();
$htmlPages[] = getAdditionalReport();
PDF::loadHTMLs($htmlPages)->download('consolidated-report.pdf');
## Saving the PDF
laravelpdf uses League\Flysystem to save the file to the local or remote filesystems.
Usage
$pdfObject->save(string $filename, League\Flysystem\AdapterInterface $adapter, $overwrite)
filename
: the name of the file you want to save with
adapter
: FlySystem Adapter
overwrite
: If set to true
and the file exists it will be overwritten, otherwise an Exception will be thrown.
Examples
// Save the pdf to the local file system
PDF::loadHTML('<b>Hello World</b>')
->save("invoice.pdf", new League\Flysystem\Adapter\Local(__DIR__.'/path/to/root'));
// Save to AWS S3
$client = S3Client::factory([
'key' => '[your key]',
'secret' => '[your secret]',
]);
PDF::loadHTML('<b>Hello World</b>')
->save("invoice.pdf", new League\Flysystem\Adapter\AwsS3($client, 'bucket-name', 'optional-prefix'));
// Save to FTP
$ftpConf = [
'host' => 'ftp.example.com',
'username' => 'username',
'password' => 'password',
/** optional config settings */
'port' => 21,
'root' => '/path/to/root',
'passive' => true,
'ssl' => true,
'timeout' => 30,
];
PDF::loadHTML('<b>Hello World</b>')
->save("invoice.pdf", new League\Flysystem\Adapter\Ftp($ftpConf));
// Save to the multiple locations and stream it
return PDF::loadHTML('<b>Hello World</b>')
->save("invoice.pdf", new League\Flysystem\Adapter\Ftp($ftpConf))
->save("invoice.pdf", new League\Flysystem\Adapter\AwsS3($client, 'bucket-name', 'optional-prefix'))
->save("invoice.pdf", new League\Flysystem\Adapter\Local(__DIR__.'/path/to/root'))
->download();
Please see all the available adapters on the League\Flysystem's documentation
Documentation
You can see all the available methods in the full documentation file
Contribution
Feel free to contribute!
Thanks
Thanks Can Geliş who made Laravel 4 support cangelis/l4pdf