Laravel DOMPDF包装器技术文档

DOMPDF Laravel包装器是专为将Laravel框架与Dompdf HTML到PDF转换器集成而设计的工具。下面我们将详细介绍其安装步骤、使用方法、API示例以及配置选项。

安装指南

对于Laravel应用

1. 打开终端，通过Composer添加此包到您的项目依赖中：

   composer require barryvdh/laravel-dompdf
   

2. 自动注册服务提供者通常在新版本的Laravel中自动完成。若需要手动操作，打开config/app.php，并将以下行添加到providers数组：

   Barryvdh\DomPDF\ServiceProvider::class,
   

3. 发布配置文件以进行自定义（可选）：

   php artisan vendor:publish --provider="Barryvdh\DomPDF\ServiceProvider"
   

对于Lumen应用

1. 同样使用Composer添加依赖。
2. 在bootstrap/app.php文件中注册服务提供者：

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

3. 若要配置，将配置文件复制到您的配置目录，并在bootstrap/app.php中启用配置：

   $app->configure('dompdf');
   

使用说明

DOMPDF Laravel包装器使得生成PDF变得简单直观。以下是一些基本操作：

• 创建PDF并下载：

  use Barryvdh\DomPDF\Facade\Pdf;
  
  // 加载视图并保存为PDF文件
  $pdf = Pdf::loadView('pdf.invoice', $data);
  return $pdf->download('invoice.pdf');
  

• 直接在浏览器显示PDF：

  $pdf = App::make('dompdf.wrapper');
  $pdf->loadHTML('<h1>测试文档</h1>');
  return $pdf->stream();
  

• 高级使用：链式调用与设置：

  Pdf::loadFile(public_path().'/myfile.html')
      ->save('/path-to/my_stored_file.pdf')
      ->stream('下载.pdf');
  

• 调整页面属性：

  $htmlContent = "...";
  $pdf = Pdf::loadHTML($htmlContent)
      ->setPaper('a4', 'landscape')
      ->setWarnings(false)
      ->save('myfile.pdf');
  

• 获取PDF字符串： 创建PDF后，可以使用output()方法获取PDF作为字符串来进一步处理。

API使用文档

• 设置选项：在生成PDF之前，可以通过setOption动态设定各种选项，例如：

  Pdf::setOption(['dpi' => 150, 'defaultFont' => 'sans-serif']);
  

配置选项

• 配置文件位于config/dompdf.php，您可以在此处修改默认设置，如纸张大小、字体等。
• 可以通过发布命令更新配置：

  php artisan vendor:publish --provider="Barryvdh\DomPDF\ServiceProvider"
  

注意事项

• 自3.x版本起，默认禁用了远程访问以增强安全性。
• 确保模板支持UTF-8编码，以避免乱码问题。

许可证

此DOMPDF Laravel包装器遵循MIT许可协议，开放源代码，可供自由使用和分发。

通过上述步骤和说明，您应该能够顺利地将DOMPDF集成到您的Laravel或Lumen项目中，轻松实现HTML内容到PDF的转换。