mramadan0101/laravel-dompdf

Laravel的DOMPDF包装器

资助包维护!
barryvdh

安装: 4

依赖: 0

建议者: 0

安全: 0

星标: 0

关注者: 0

分支: 967

语言:HTML

v0.8.7 2020-09-07 11:50 UTC

README

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

在composer.json中添加此包并在composer中更新。这将下载包以及dompdf和fontlib库。

composer require barryvdh/laravel-dompdf

安装

Laravel 5.x

更新composer后,将ServiceProvider添加到config/app.php中的providers数组

Barryvdh\DomPDF\ServiceProvider::class,

您可以选择使用外观来缩短代码。将以下内容添加到您的外观中

'PDF' => Barryvdh\DomPDF\Facade::class,

Lumen

更新composer后,将以下行添加到bootstrap/app.php中以注册provider

$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中可用)
  • pdflib许可证: ""
  • adminUsername:"user"
  • adminPassword:"password"

提示:UTF-8支持

在您的模板中,设置UTF-8元标签

<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>

提示:页面分页

您可以使用CSS的page-break-beforepage-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许可协议