Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/barryvdh/laravel-dompdf
A DOMPDF Wrapper for Laravel
https://github.com/barryvdh/laravel-dompdf
hacktoberfest laravel pdf
Last synced: 4 days ago
JSON representation
A DOMPDF Wrapper for Laravel
- Host: GitHub
- URL: https://github.com/barryvdh/laravel-dompdf
- Owner: barryvdh
- License: mit
- Created: 2013-06-23T11:27:07.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2024-08-09T12:44:48.000Z (4 months ago)
- Last Synced: 2024-10-29T19:19:34.411Z (about 1 month ago)
- Topics: hacktoberfest, laravel, pdf
- Language: PHP
- Homepage:
- Size: 172 KB
- Stars: 6,731
- Watchers: 111
- Forks: 969
- Open Issues: 98
-
Metadata Files:
- Readme: readme.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-laravel4 - Laravel Dompdf
- awesome-laravel - Laravel DOMPDF - Genera un PDF a partir de HTML usando [dompdf](https://github.com/dompdf/dompdf) (Paquetes utiles)
- awesome-pdf - laravel dompdf
- laravel-awesome - Laravel DOMPDF - HTML to PDF generator using [dompdf](https://github.com/dompdf/dompdf) (Popular Packages)
- awesome-laravel - Laravel DOMPDF - HTML to PDF generator using [dompdf](https://github.com/dompdf/dompdf) (Popular Packages)
README
## DOMPDF Wrapper for Laravel
### Laravel wrapper for [Dompdf HTML to PDF Converter](https://github.com/dompdf/dompdf)
[](https://github.com/barryvdh/laravel-dompdf/actions)
[](http://choosealicense.com/licenses/mit/)
[](https://packagist.org/packages/barryvdh/laravel-dompdf)
[](https://packagist.org/packages/barryvdh/laravel-dompdf)
[](https://fruitcake.nl/)
## Installation
### Laravel
Require this package in your composer.json and update composer. This will download the package and the dompdf + fontlib libraries also.
composer require barryvdh/laravel-dompdf
### Lumen
After updating composer add the following lines to register provider in `bootstrap/app.php`
```
$app->register(\Barryvdh\DomPDF\ServiceProvider::class);
```
To change the configuration, copy the config file to your config folder and enable it in `bootstrap/app.php`:
```
$app->configure('dompdf');
```
## Using
You can create a new DOMPDF instance and load a HTML string, file or view name. You can save it to a file, or stream (show in browser) or download.
```php
use Barryvdh\DomPDF\Facade\Pdf;
$pdf = Pdf::loadView('pdf.invoice', $data);
return $pdf->download('invoice.pdf');
```
or use the App container:
```php
$pdf = App::make('dompdf.wrapper');
$pdf->loadHTML('
Test
');
return $pdf->stream();
```
Or use the facade:
You can chain the methods:
```php
return Pdf::loadFile(public_path().'/myfile.html')->save('/path-to/my_stored_file.pdf')->stream('download.pdf');
```
You can change the orientation and paper size, and hide or show errors (by default, errors are shown when debug is on)
```php
Pdf::loadHTML($html)->setPaper('a4', 'landscape')->setWarnings(false)->save('myfile.pdf')
```
If you need the output as a string, you can get the rendered PDF with the output() function, so you can save/output it yourself.
Use `php artisan vendor:publish` to create a config file located at `config/dompdf.php` which will allow you to define local configurations to change some settings (default paper etc).
You can also use your ConfigProvider to set certain keys.
### Configuration
The defaults configuration settings are set in `config/dompdf.php`. Copy this file to your own config directory to modify the values. You can publish the config using this command:
```shell
php artisan vendor:publish --provider="Barryvdh\DomPDF\ServiceProvider"
```
You can still alter the dompdf options in your code before generating the pdf using this command:
```php
Pdf::setOption(['dpi' => 150, 'defaultFont' => 'sans-serif']);
```
Available options and their defaults:
* __rootDir__: "{app_directory}/vendor/dompdf/dompdf"
* __tempDir__: "/tmp" _(available in config/dompdf.php)_
* __fontDir__: "{app_directory}/storage/fonts" _(available in config/dompdf.php)_
* __fontCache__: "{app_directory}/storage/fonts" _(available in config/dompdf.php)_
* __chroot__: "{app_directory}" _(available in config/dompdf.php)_
* __logOutputFile__: "/tmp/log.htm"
* __defaultMediaType__: "screen" _(available in config/dompdf.php)_
* __defaultPaperSize__: "a4" _(available in config/dompdf.php)_
* __defaultFont__: "serif" _(available in config/dompdf.php)_
* __dpi__: 96 _(available in config/dompdf.php)_
* __fontHeightRatio__: 1.1 _(available in config/dompdf.php)_
* __isPhpEnabled__: false _(available in config/dompdf.php)_
* __isRemoteEnabled__: false _(available in config/dompdf.php)_
* __isJavascriptEnabled__: true _(available in config/dompdf.php)_
* __isHtml5ParserEnabled__: true _(available in config/dompdf.php)_
* __allowedRemoteHosts__: null _(available in config/dompdf.php)_
* __isFontSubsettingEnabled__: false _(available in config/dompdf.php)_
* __debugPng__: false
* __debugKeepTemp__: false
* __debugCss__: false
* __debugLayout__: false
* __debugLayoutLines__: true
* __debugLayoutBlocks__: true
* __debugLayoutInline__: true
* __debugLayoutPaddingBox__: true
* __pdfBackend__: "CPDF" _(available in config/dompdf.php)_
* __pdflibLicense__: ""
* __adminUsername__: "user"
* __adminPassword__: "password"
* __artifactPathValidation__: null _(available in config/dompdf.php)_
#### Note: Since 3.x the remote access is disabled by default, to provide more security. Use with caution!
### Tip: UTF-8 support
In your templates, set the UTF-8 Metatag:
### Tip: Page breaks
You can use the CSS `page-break-before`/`page-break-after` properties to create a new page.
.page-break {
page-break-after: always;
}
Page 1
Page 2
### License
This DOMPDF Wrapper for Laravel is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT)