README

Laravel 的 Dompdf HTML 到 PDF 转换器 包装器

安装

Laravel

在 composer.json 中要求此包并更新 composer。这将下载该包以及 dompdf + fontlib 库。

composer require barryvdh/laravel-dompdf

Lumen

更新 composer 后，将以下行添加到 bootstrap/app.php 中以注册提供者

$app->register(\Barryvdh\DomPDF\ServiceProvider::class);

要更改配置，将配置文件复制到您的配置文件夹，并在 bootstrap/app.php 中启用它

$app->configure('dompdf');

使用

您可以创建一个新的 DOMPDF 实例并加载一个 HTML 字符串、文件或视图名称。您可以将其保存到文件中、通过流（在浏览器中显示）或下载。

    use Barryvdh\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="Barryvdh\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: 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 中可用)
• pdflibLicense: ""
• adminUsername: "user"
• adminPassword: "password"
• artifactPathValidation: null (在 config/dompdf.php 中可用)

注意：从3.x版本开始，默认禁用远程访问，以提高安全性。请谨慎使用！

提示：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许可证