artjoker / laravel-dompdf
Laravel 的 DOMPDF 包装器
v1.0.1
2023-10-17 10:54 UTC
Requires
- php: ^7.2 || ^8.0
- artjoker/dompdf: ^1.0.1
- illuminate/support: ^6|^7|^8|^9|^10
Requires (Dev)
- nunomaduro/larastan: ^1|^2
- orchestra/testbench: ^4|^5|^6|^7|^8
- phpro/grumphp: ^1
- squizlabs/php_codesniffer: ^3.5
README
从 DOMPDF Wrapper for Laravel 分支
安装
Laravel
在 composer.json 中添加此包并更新 composer。这将下载该包以及 dompdf + fontlib 库。
composer require artjoker/laravel-dompdf
Lumen
更新 composer 后,将以下行添加到 bootstrap/app.php
中的 provider 注册中
$app->register(\Artjoker\DomPDF\ServiceProvider::class);
要更改配置,将配置文件复制到您的配置文件夹,并在 bootstrap/app.php
中启用它
$app->configure('dompdf');
使用
您可以创建一个新的 DOMPDF 实例,并加载一个 HTML 字符串、文件或视图名称。您可以将其保存到文件、流(在浏览器中显示)或下载。
use Artjoker\DomPDF\Facade\Pdf; $pdf = Pdf::loadView('pdf.invoice', $data); return $pdf->download('invoice.pdf');
或使用 App 容器
$pdf = App::make('dompdf.wrapper'); $pdf->loadHTML('<h1>Test</h1>'); return $pdf->stream();
或使用外观
您可以对方法进行链式调用
return Pdf::loadFile(public_path().'/myfile.html')->save('/path-to/my_stored_file.pdf')->stream('download.pdf');
您可以更改方向和纸张大小,并隐藏或显示错误(默认情况下,当调试开启时显示错误)
Pdf::loadHTML($html)->setPaper('a4', 'landscape')->setWarnings(false)->save('myfile.pdf')
如果您需要输出为字符串,可以使用 output() 函数获取渲染后的 PDF,然后自行保存/输出。
使用 php artisan vendor:publish
创建位于 config/dompdf.php
的配置文件,这将允许您定义本地配置以更改某些设置(默认纸张等)。您还可以使用自己的 ConfigProvider 设置某些键。
配置
默认配置设置在 config/dompdf.php
中设置。将此文件复制到您的配置目录以修改值。您可以使用此命令发布配置
php artisan vendor:publish --provider="Artjoker\DomPDF\ServiceProvider"
您仍然可以在生成 PDF 之前使用此命令修改 dompdf 选项
Pdf::setOption(['dpi' => 150, 'defaultFont' => 'sans-serif']);
可用选项及其默认值
- rootDir: "{app_directory}/vendor/dompdf/dompdf"
- tempDir: "/tmp" (在 config/dompdf.php 中可用)
- fontDir: "{app_directory}/storage/fonts" (在 config/dompdf.php 中可用)
- fontCache: "{app_directory}/storage/fonts" (在 config/dompdf.php 中可用)
- chroot: "{app_directory}" (在 config/dompdf.php 中可用)
- logOutputFile: "/tmp/log.htm"
- defaultMediaType: "screen" (在 config/dompdf.php 中可用)
- defaultPaperSize: "a4" (在 config/dompdf.php 中可用)
- defaultFont: "serif" (在 config/dompdf.php 中可用)
- dpi: 96 (在 config/dompdf.php 中可用)
- fontHeightRatio: 1.1 (在 config/dompdf.php 中可用)
- isPhpEnabled: false (在 config/dompdf.php 中可用)
- isRemoteEnabled: true (在 config/dompdf.php 中可用)
- isJavascriptEnabled: true (在 config/dompdf.php 中可用)
- isHtml5ParserEnabled: false (在 config/dompdf.php 中可用)
- isFontSubsettingEnabled: false (在 config/dompdf.php 中可用)
- debugPng: false
- debugKeepTemp: false
- debugCss: false
- debugLayout: false
- debugLayoutLines: true
- debugLayoutBlocks: true
- debugLayoutInline: true
- debugLayoutPaddingBox: true
- pdfBackend: "CPDF" (在 config/dompdf.php 中可用)
- pdflibLicense: ""
- adminUsername: "user"
- adminPassword: "password"
提示:UTF-8 支持
在您的模板中,设置 UTF-8 Metatag
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
提示:页面分隔符
您可以使用 CSS page-break-before
/page-break-after
属性创建新页面。
<style>
.page-break {
page-break-after: always;
}
</style>
<h1>Page 1</h1>
<div class="page-break"></div>
<h1>Page 2</h1>
许可证
此 DOMPDF Wrapper for Laravel 是开源软件,许可协议为 MIT 许可协议