README

使用 Laravel 的 Blade 模板和 MPDF 库轻松生成 PDF 文件。该包自 Laravel 5.4 以来已过测试。

安装

在您的 Laravel 应用程序中运行此 Composer 命令

composer require carlos-meneses/laravel-mpdf

重要提示

请始终检查官方 MPDF 文档
在单线程服务器（如 php -S 或 artisan serve）上使用时，mPDF 在获取外部 HTTP 资源时将超时。使用适当的 Web 服务器以获得完整功能。

要开始使用 Laravel，请将 Service Provider 和 Facade 添加到您的 config/app.php

注意：此包支持 Laravel 5.5+ 的自动发现功能，如果您在低于 5.5 的 Laravel 版本上工作，则只需手动添加服务提供者和别名。

'providers' => [
    // ...
    Mccarlosen\LaravelMpdf\LaravelMpdfServiceProvider::class
]

'aliases' => [
    // ...
    'PDF' => Mccarlosen\LaravelMpdf\Facades\LaravelMpdf::class
]

基本用法

要在 Laravel Mpdf 中使用，请在您的控制器中添加类似的内容。您可以将数据传递到 /resources/views 中的视图。

//....

use PDF;

class ReportController extends Controller 
{
    public function viewPdf()
    {
        $data = [
            'foo' => 'bar'
        ];

        $pdf = PDF::loadView('pdf.document', $data);

        return $pdf->stream('document.pdf');
    }

}

配置

您可以使用自定义文件来覆盖默认配置。只需执行 php artisan vendor:publish --tag=mpdf-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',
    'margin_top' => 0
])->save($pdfFilePath);

获取 Mpdf 实例

您可以通过 getMpdf 方法通过 mpdf 实例访问所有 mpdf 方法。

use PDF;

$pdf = PDF::loadView('pdf.document', $data);
$pdf->getMpdf()->AddPage(/*...*/);

页眉和页脚

如果您希望在每一页上都有页眉和页脚，请按如下方式将其添加到您的 <body> 标签中

<htmlpageheader name="page-header">
    Your Header Content
</htmlpageheader>

<htmlpagefooter name="page-footer">
    Your Footer Content
</htmlpagefooter>

现在您只需要使用 CSS 中的名称属性定义它们

@page {
  header: page-header;
  footer: page-footer;
}

在页眉和页脚中，{PAGENO} 可以用来显示页码。

包含的字体

默认情况下，您可以使用与 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 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>

添加了对可宏化特质的支持

您可以在 AppServiceProvider 提供者文件中配置宏。

//...
use Mccarlosen\LaravelMpdf\LaravelMpdf;

class AppServiceProvider extends ServiceProvider
{
  //...

    public function boot()
    {
        LaravelMpdf::macro('hello', function () {
            return "Hello, World!";
        });
    }

  //...
}

现在

PDF::loadView(/* ... */)->hello();

许可证

Laravel Mpdf 是开源软件，根据 MIT 许可证授权。

carlos-meneses / laravel-mpdf

维护者

详细信息