mathieutu/laravel-pdflayer

A pdflayer API bridge for Laravel

2.0.1 2018-03-03 13:37 UTC

Requires

• php: >=7.0
• guzzlehttp/guzzle: ^6.3
• laravel/framework: ^5.5

Requires (Dev)

• laravel/laravel: ^5.5
• mockery/mockery: ^1.0
• phpunit/phpunit: ^7.0

MIT

• Mathieu TUDISCO

README

pdflayer.com is an HTML to PDF conversion API for developers. This package is an unofficial bridge to use this api with the PHP Laravel framework.

Installation

Require this package in your composer.json and update composer.

composer require mathieutu/laravel-pdflayer

Usage

You can create a new PDFLayer instance and load a HTML string, file, view name or even an url. You can save it to a file, stream (show in browser) or download.

To create an new instance, you can use the App class, the app() helper, use the facade, or (better) use automatic dependency injection :

$pdf = App::make('pdflayer');
$pdf = app('pdflayer');
$pdf = PDF::anyMethod();
public function downloadPdf(MathieuTu\PDFLayer\PDF $pdf) {}

You can chain the methods:

return $pdf->loadView('pdf.invoice', $data)->setPaper('a4', 'landscape')->save('/path-to/my_stored_file.pdf')->stream('download.pdf');

You can set all the parameters given by the pdflayer documentation by using the setXXX method where XXX is the parameter in StudlyCase, or just set the parameter (in original snake_case) as attribute of the object.

$pdf->loadHTML('<h1>Hello!</h1>')->setWatermarkInBackground(true);
$pdf->margin_top = 134;
$pdf->save('myfile.pdf');

If you need the output as a string, you can get the rendered PDF with the output() function, so you can directly send it by email, for example.

Configuration

The defaults configuration settings are set in config/pdflayer.php. Copy this file to your own config directory to modify the values. You can publish the config using this shell command:

php artisan vendor:publish --provider="MathieuTu\PDFLayer\PDFLayerServiceProvider"

License and thanks

This PDFLayer Bridge for Laravel is an open-sourced software licensed under the MIT license.

The developer is not affiliated in any way with the pdflayer.com service.

This Readme and some methods of the PDF class are adapted from the barryvdh/laravel-dompdf package. Thanks to him for his job.

Contributing

Issues and PRs are obviously welcomed and encouraged, as well for new features than documentation. Each piece of code added should be fully tested, but we can do that all together, so please don't be afraid by that.