ashik / pdf
使用mPDF、Facades和包装器生成PDF的自定义Laravel包
Requires
- php: ^8.0
- mpdf/mpdf: v8.2.1
README
使用此mPDF包装器,可以直接在Laravel中从HTML生成PDF文档。
安装
在您的 composer.json
中要求此包,或通过运行以下命令安装
composer require ashik/pdf
注意:此包支持Laravel 5.5+的自动发现功能,如果您的Laravel版本低于7.0,则需要手动添加服务提供者和别名
要开始使用Laravel,请将服务提供者和外观添加到您的 config/app.php
'providers' => [ // ... Ashik\Pdf\PdfServiceProvider::class ]
'aliases' => [ // ... 'PDF' => Ashik\Pdf\Facades\Mpdf::class ]
现在,您应通过以下命令将包的配置文件发布到您的配置目录
php artisan vendor:publish --tag=pdf-config
基本用法
要使用Laravel PDF,请将以下内容添加到您的控制器之一中。您可以将数据传递到 /resources/views
中的视图。
use Ashik\Pdf\Facades\Pdf; class ReportController extends Controller { public function viewPdf() { $pdf = PDF::loadView('pdf.document', [ 'foo' => 'bar' ]); return $pdf->stream('document.pdf'); } }
配置
您可以使用自定义文件覆盖默认配置。只需执行 php artisan vendor:publish --tag=pdf-config
或创建 config/pdf.php
并添加以下内容
return [ 'mode' => '', 'format' => 'A4', 'default_font_size' => '12', 'default_font' => 'sans-serif', 'margin_left' => 10, 'margin_right' => 10, 'margin_top' => 10, 'margin_bottom' => 10, 'margin_header' => 0, 'margin_footer' => 0, 'orientation' => 'P', 'title' => 'Laravel mPDF', 'author' => '', 'watermark' => '', 'show_watermark' => false, 'show_watermark_image' => false, 'watermark_font' => 'sans-serif', 'display_mode' => 'fullpage', 'watermark_text_alpha' => 0.1, 'watermark_image_path' => '', 'watermark_image_alpha' => 0.2, 'watermark_image_size' => 'D', 'watermark_image_position' => 'P', 'custom_font_dir' => '', 'custom_font_data' => [], 'auto_language_detection' => false, 'temp_dir' => storage_path('app'), 'pdfa' => false, 'pdfaauto' => false, 'use_active_forms' => false, ];
要基于文件覆盖此配置,请在初始化调用中使用第四个参数,如下所示
// ... PDF::loadView('pdf', $data, [], [ 'title' => 'Another Title', ])->save($pdfFilePath);
包含的字体
默认情况下,您可以使用Mpdf携带的所有字体 (请参阅此处)。
自定义字体
您可以在生成的PDF中使用自己的字体。TTF文件必须位于一个文件夹中,例如 resources/fonts/
。将以下内容添加到您的配置文件(/config/pdf.php
)中
return [ 'custom_font_dir' => base_path('resources/fonts/'), // don't forget the trailing slash! 'custom_font_data' => [ 'examplefont' => [ // must be lowercase and snake_case 'R' => 'ExampleFont-Regular.ttf', // regular font 'B' => 'ExampleFont-Bold.ttf', // optional: bold font 'I' => 'ExampleFont-Italic.ttf', // optional: italic font 'BI' => 'ExampleFont-Bold-Italic.ttf' // optional: bold-italic font ] // ...add as many as you want. ] ];
现在您可以在CSS中使用此字体
body { font-family: 'examplefont', sans-serif; }
块HTML
对于大型HTML,您可能会遇到 Uncaught Mpdf\MpdfException: The HTML code size is larger than pcre.backtrack_limit xxx
错误,或者您可能会遇到 空白或空白的结果。在这些情况下,您可以在添加分隔符到您的HTML的同时使用块方法
//.... use Ashik\Pdf\Facades\Pdf; class ReportController extends Controller { public function generate_pdf() { $data = [ 'foo' => 'hello 1', 'bar' => 'hello 2' ]; $pdf = PDF::chunkLoadView('<html-separator/>', 'pdf.document', $data); return $pdf->stream('document.pdf'); } }
<div> <h1>Hello World</h1> <table> <tr><td>{{ $foo }}</td></tr> </table> <html-separator/> <table> <tr><td>{{ $bar }}</td></tr> </table> <html-separator/> </div>
许可协议
Laravel Mpdf是开源软件,许可协议为 MIT