README

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

安装

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

composer require reposys/laravel-pdf

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

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

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

基本用法

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

use PDF;

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

配置

您可以使用自定义文件覆盖默认配置。只需创建 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,
	'watermark_font'       => 'sans-serif',
	'display_mode'         => 'fullpage',
	'watermark_text_alpha' => 0.1
];

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

PDF::loadView('pdf', $data, [], [
  'title' => 'Another Title',
  'margin_top' => 0
])->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 [
	'custom_font_path' => base_path('/resources/fonts/'), // don't forget the trailing slash!
	'custom_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
		]
		// ...add as many as you want.
	]
];

现在，您可以在 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() 的更多信息，请参阅此处

许可证

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

reposys / laravel-pdf

维护者

详情