Blame view
public/vendor/barryvdh/laravel-dompdf/readme.md
4.85 KB
86143e36f Коммит вторник |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 |
## DOMPDF Wrapper for Laravel ### Laravel wrapper for [Dompdf HTML to PDF Converter](https://github.com/dompdf/dompdf) [![Tests](https://github.com/barryvdh/laravel-dompdf/workflows/Tests/badge.svg)](https://github.com/barryvdh/laravel-dompdf/actions) [![Packagist License](https://poser.pugx.org/barryvdh/laravel-dompdf/license.png)](http://choosealicense.com/licenses/mit/) [![Latest Stable Version](https://poser.pugx.org/barryvdh/laravel-dompdf/version.png)](https://packagist.org/packages/barryvdh/laravel-dompdf) [![Total Downloads](https://poser.pugx.org/barryvdh/laravel-dompdf/d/total.png)](https://packagist.org/packages/barryvdh/laravel-dompdf) [![Fruitcake](https://img.shields.io/badge/Powered%20By-Fruitcake-b2bc35.svg)](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('<h1>Test</h1>'); 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__: true _(available in config/dompdf.php)_ * __isJavascriptEnabled__: true _(available in config/dompdf.php)_ * __isHtml5ParserEnabled__: false _(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" ### Tip: UTF-8 support In your templates, set the UTF-8 Metatag: <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/> ### Tip: Page breaks You can use the CSS `page-break-before`/`page-break-after` properties to create a new page. <style> .page-break { page-break-after: always; } </style> <h1>Page 1</h1> <div class="page-break"></div> <h1>Page 2</h1> ### License This DOMPDF Wrapper for Laravel is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT) |