lara-igniter / laraigniter-dompdf
Laraigniter的DOMPDF包装器
v1.2.1
2024-09-27 07:01 UTC
Requires
- php: ^7.4|^8.0
- ext-dom: *
- dompdf/dompdf: ^3.0
- lara-elegant/support: ^1.10
Requires (Dev)
- codeigniter/framework: ^3.1
README
Laraigniter包装了Dompdf HTML转PDF转换器
安装
Laraigniter
在composer.json中添加此包并更新composer。这将下载包以及dompdf + fontlib库。
composer require lara-igniter/laraigniter-dompdf
使用
您可以创建一个新的DOMPDF实例,加载HTML字符串、文件或视图名称。您可以将其保存到文件、流(在浏览器中显示)或下载。
use Laraigniter\DomPDF\Facade\Pdf; $pdf = Pdf::view('emails.invoice', [ 'data' => $data ]); return $pdf->download('example.pdf');
或者使用app()控制器实例
$pdf = app('dompdf.wrapper'); $pdf->html('<h1>Example PDF</h1>'); return $pdf->stream();
或者使用外观
您可以使用链式方法
return Pdf::file(public_path('emails/example.html')) ->save('example.pdf') ->stream('example.pdf');
您可以更改方向和纸张大小,并隐藏或显示错误(默认情况下,当调试开启时显示错误)
Pdf::html($html)->setPaper('a4', 'landscape') ->setWarnings(false) ->save('example.pdf')
如果您需要以字符串的形式输出,您可以使用output()函数获取渲染的PDF,然后自行保存/输出。
配置
默认配置设置在config/dompdf.php
中。
在生成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: false (在config/dompdf.php中可用)
- isJavascriptEnabled: true (在config/dompdf.php中可用)
- isHtml5ParserEnabled: true (在config/dompdf.php中可用)
- allowedRemoteHosts: null (在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中可用)
- pdflib许可证: ""
- adminUsername: "user"
- adminPassword: "password"
- artifactPathValidation: null (在config/dompdf.php中可用)
注意:默认禁用远程访问,以提高安全性。请谨慎使用!
提示:UTF-8支持
在模板中设置UTF-8元标签
<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>
许可协议
此Laraigniter的DOMPDF包装器是开源软件,许可协议为MIT许可协议