README

警告
niklasravnsborg/laravel-pdf 已不再维护！此仓库已于 2023-08-22 废弃并归档。请查看 https://github.com/misterspelik/laravel-pdf 以寻找可能的替代方案。

Laravel PDF: Laravel 5 的 mPDF 包装器

使用此 mPDF 包装器，您可以在 Laravel 内部轻松地从 HTML 生成 PDF 文档。

安装

在您的 composer.json 中要求此包，或通过运行以下命令进行安装

composer require niklasravnsborg/laravel-pdf

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

要开始使用 Laravel，请将服务提供者和外观添加到您的 config/app.php

'providers' => [
	// ...
	niklasravnsborg\LaravelPdf\PdfServiceProvider::class
]

'aliases' => [
	// ...
	'PDF' => niklasravnsborg\LaravelPdf\Facades\Pdf::class
]

现在，您应该使用以下命令将包的配置文件发布到您的配置目录

php artisan vendor:publish

基本用法

要使用 Laravel PDF，请将以下内容添加到您的控制器之一。您可以将数据传递到 /resources/views 中的视图。

use PDF;

function generate_pdf() {
	$data = [
		'foo' => 'bar'
	];
	$pdf = PDF::loadView('pdf.document', $data);
	return $pdf->stream('document.pdf');
}

其他方法

您还可以在 pdf 对象上使用以下方法

output()：将 PDF 输出为字符串。
save($filename)：将 PDF 保存到文件。
download($filename)：让用户可以下载 PDF。
stream($filename)：返回一个包含 PDF 的响应，以便在浏览器中显示。

配置

如果您已发布配置文件，您可以在 config/pdf.php 文件中更改默认设置

return [
	'format'           => 'A4', // See https://mpdf.github.io/paging/page-size-orientation.html
	'author'           => 'John Doe',
	'subject'          => 'This Document will explain the whole universe.',
	'keywords'         => 'PDF, Laravel, Package, Peace', // Separate values with comma
	'creator'          => 'Laravel Pdf',
	'display_mode'     => 'fullpage'
];

要基于文件覆盖此配置，请在初始化调用中使用第四个参数，如下所示

PDF::loadView('pdf', $data, [], [
  'format' => 'A5-L'
])->save($pdfFilePath);

您可以使用具有 'instanceConfigurator' 键的回调来访问 mPDF 函数

$config = ['instanceConfigurator' => function($mpdf) {
    $mpdf->SetImportUse();
    $mpdf->SetDocTemplate(/path/example.pdf, true);
}]
 
PDF::loadView('pdf', $data, [], $config)->save($pdfFilePath);

页眉和页脚

如果您想要在每一页上都有页眉和页脚，请将它们添加到您的 <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 [
	// ...
	'font_path' => base_path('resources/fonts/'),
	'font_data' => [
		'examplefont' => [
			'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
			//'useOTL' => 0xFF,    // required for complicated langs like Persian, Arabic and Chinese
			//'useKashida' => 75,  // required for complicated langs like Persian, Arabic and Chinese
		]
		// ...add as many as you want.
	]
	// ...
];

注意：如果您使用 laravel-pdf 生成复杂语言（如波斯语、阿拉伯语或中文）的 PDF 文档，您应该在自定义字体定义数组中包含 useOTL 和 useKashida 索引。如果不使用这些索引，生成的 PDF 中字符将显示为分散且不正确。

现在您可以在 CSS 中使用此字体

body {
	font-family: 'examplefont', sans-serif;
}

设置保护

要设置保护，只需调用 SetProtection() 方法并传递一个包含权限、用户密码和所有者密码的数组。

密码是可选的。

有一些权限：'copy'、'print'、'modify'、'annot-forms'、'fill-forms'、'extract'、'assemble'、'print-highres'。

use PDF;

function generate_pdf() {
	$data = [
		'foo' => 'bar'
	];
	$pdf = PDF::loadView('pdf.document', $data);
	$pdf->SetProtection(['copy', 'print'], '', 'pass');
	return $pdf->stream('document.pdf');
}

在这里找到有关 SetProtection() 的更多信息：https://mpdf.github.io/reference/mpdf-functions/setprotection.html

测试

要使用测试套件，您需要在本地PHP上安装一些扩展和二进制文件。在macOS上，您可以按以下方式安装：

brew install imagemagick ghostscript
pecl install imagick

许可证

Laravel PDF 是开源软件，受 MIT 许可证许可。

niklasravnsborg / laravel-pdf

维护者

详细信息