chicorycom / laravel-dompdf
您的系统和安全网络集成商
Requires
- php: >=5.5.9
- dompdf/dompdf: ^0.8
- illuminate/support: 5.1.x|5.2.x|5.3.x|5.4.x|5.5.x
This package is auto-updated.
Last update: 2024-09-13 01:59:01 UTC
README
针对Laravel 4.x,请检查0.4分支!
在您的composer.json中要求此包,并更新composer。这将下载包以及dompdf + 字体库。
composer require Chicorycom/laravel-dompdf:dev-master
安装
Laravel 5.x
更新composer后,将服务提供者在config/app.php中的提供者数组中添加
Chicorycom\DomPDF\ServiceProvider::class,
您可能可以使用门面来编写更简洁的代码。将以下内容添加到您的门面中
'PDF' => Chicorycom\DomPDF\Facade::class,
Lumen
更新composer后,在bootstrap/app.php中添加以下行以注册到提供者
$app->register(\Barryvdh\DomPDF\ServiceProvider::class);
要修改配置,请将配置文件复制到您的配置目录,并激活bootstrap/app.php
$app->configure('dompdf');
使用
您可以创建一个新的DOMPDF实例并加载一个HTML字符串、文件或视图名。您可以将其保存到文件中,或发布(在浏览器中显示)或下载。
$pdf = App::make('dompdf.wrapper');
$pdf->loadHTML('<h1>Test</h1>');
return $pdf->stream();
或者使用门面
$pdf = PDF::loadView('pdf.invoice', $data);
return $pdf->download('invoice.pdf');
您可以将方法链接起来
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="Barryvdh\DomPDF\ServiceProvider"
您仍然可以在生成PDF之前使用此命令修改dompdf的选项
PDF::setOptions(['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 元标签
<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>
许可证
这个 Laravel 的 DOMPDF 包装器是开源软件,遵循 MIT 许可证 "# laravel-dompdf"。