README

该项目最初是一个 DOCX 模板引擎。现在它已经发展到了也支持使用 webkit 的无头版本 phantomjs 将 HTML 转换为 PDF。

DOCX 模板非常适合那些最终用户需要随时间更新和管理文档的情况，尤其是文本密集型文档。例如，我用它来自动生成一些法律合同，其中对像“名字”、“姓氏”、“公司名称”和“地址”这样的属性进行简单的替换。客户，一家保险公司，可以提供更新的模板 Word 文档，其中可能包含对政策和其他条件的细微变化。

HTML 到 PDF 引擎非常适合需要更多文档设计控制的情况。对于我们这些程序员来说，使用标准的 HTML、CSS 和一点 JavaScript，这更为自然。

如何安装

通过 composer 安装很简单

composer require gears/pdf:*

您还需要将以下内容添加到您的根 composer.json 文件中。

"scripts":
{
	"post-install-cmd": ["PhantomInstaller\\Installer::installPhantomJS"],
	"post-update-cmd": ["PhantomInstaller\\Installer::installPhantomJS"]
}

DOCX：如果您将要使用 DOCX 模板，您需要在您的宿主上安装 libre-office-headless 或 unoconv。

如何使用，基本操作

两个 API 都通过主 Pdf 类访问。

将 Word 文档转换为 PDF 而不使用任何模板

$pdf = Gears\Pdf::convert('/path/to/document.docx');

将生成的 PDF 保存到文件

Gears\Pdf::convert('/path/to/document.docx', '/path/to/document.pdf');

将 HTML 文档转换为 PDF

$pdf = Gears\Pdf::convert('/path/to/document.html');

注意：保存到文件对 HTML 文档同样有效。

DOCX 模板

默认情况下，DOCX 后端默认使用 libre-office-headless，要使用 unoconv，可以像这样覆盖转换器

$document = new Gears\Pdf('/path/to/document.docx');
$document->converter = function()
{
	return new Gears\Pdf\Docx\Converter\Unoconv();
};
$document->save('/path/to/document.pdf');

注意：目前 HTML 后端仅使用 phantomjs。

DOCX 引擎有几种模板方法。第一种是 setValue，它会将所有 ${FOO} 实例替换为 BAR。

$document->setValue('FOO', 'BAR');

要克隆整个 DOCX xml 块，你可以用类似 ${BLOCK_TO_CLONE} 和 ${/BLOCK_TO_CLONE} 的标签包围你的块。这个块内包含的内容将在生成的 PDF 中重复 3 次。

$document->cloneBlock('BLOCK_TO_CLONE', 3);

如果您需要用自定义的 DOCX xml 替换整个块，您也可以。但您需要确保您的 XML 符合 DOCX 标准。这是一个非常低级的方法，我通常不会使用它。

$document->replaceBlock('BLOCK_TO_REPLACE', '<docx><xml></xml></docx>');

要删除整个块，例如，您可能只想向某些用户显示文档的特定部分。

$document->deleteBlock('BLOCK_TO_DELETE');

最后一种方法是向表格添加新行很有用。类似于 cloneBlock 方法。您将标签放在表格的第一个单元格中。这一行将被克隆。

$document->cloneRow('ROW_TO_CLONE', 5);

有关更多示例，请参阅 单元测试。这些包含生成最终 PDF 的 PHP 代码以及原始 DOCX 模板。

注意：HTML 到 PDF 转换器没有这些相同的模板功能。显然，它只是标准 HTML，您可以按照自己的喜好进行模板化。

HTML PhantomJs 打印环境

这仍在开发中，可能会发生重大变化。因此，我目前不会记录这个部分...

鸣谢

DOCX 模板代码最初来自 PHPWord

您可能仍然想使用PHPWord来生成您的DOCX文档，然后使用此包将生成的文档转换为PDF。

由Brad Jones开发 - brad@bjc.id.au