
zuojiankuohaophpcnp>本文档旨在详细介绍 Dompdf 中 `$pdf` 变量的含义及其用法,并深入探讨如何利用 `page_text` 函数在生成的 PDF 文档中添加自定义文本,特别是在需要进行分页和在特定页面添加内容时。通过本文,您将能够理解如何在 PHP 代码和 HTML 模板中使用这些功能,并掌握 Dompdf 的高级用法,从而更好地控制 PDF 文档的生成。</p>
## 理解 Dompdf 中的 $pdf 变量
在 Dompdf 中,`$pdf` 变量是一个在页面脚本中可用的特殊变量,它代表了 `Canvas` 对象的一个引用。`Canvas` 对象提供了对底层 PDF 写入后端(如 `CPDF`)的直接访问。因此,你可以使用 `$pdf` 变量以及 `Canvas` 对象提供的方法来直接操作 PDF 文档的内容。
需要注意的是,`Canvas` 对象主要用于绘制原始的 PDF 元素,例如文本、线条和形状。它**不**支持直接渲染 HTML 代码。这意味着你不能像使用 HTML 元素那样,直接将包含样式信息的 HTML 代码传递给 `Canvas` 对象的方法。所有文本的样式,例如字体、大小和颜色,都必须手动设置。
## 使用 page_text 函数添加文本
`page_text` 函数是 `Canvas` 对象的一个方法,它允许你在 PDF 文档的每一页上添加文本。与 `Canvas` 对象的其他方法(如 `text`)不同,`page_text` 函数是在 HTML 文档完全渲染后,针对每一页执行的。这使得它非常适合添加页眉、页脚、页码等需要在每一页上重复出现的内容。
以下是如何使用 `page_text` 函数的示例:
**PHP 代码中:**
“`php
<?php
use Dompdf/Dompdf;
use Dompdf/FontMetrics;
// 实例化 Dompdf 对象
$dompdf = new Dompdf([‘isPhpEnabled’ => true]);
// 加载 HTML 内容
$html = ‘<html><body><h1>Hello, Dompdf!</h1><p>This is page 1.</p><div style=”page-break-after: always;”></div><p>This is page 2.</p></body></html>’;
$dompdf->loadHtml($html);
// (Optional) 设置纸张大小和方向
$dompdf->setPaper(‘A4’, ‘portrait’);
// 渲染 HTML 为 PDF
$dompdf->render();
// 获取 Canvas 对象
$canvas = $dompdf->getCanvas();
// 获取 FontMetrics 对象
$fontMetrics = $dompdf->getFontMetrics();
// 使用 page_script 添加页码
$canvas->page_script(function($pageNumber, $pageCount, $fontMetrics) use ($canvas) {
$font = $fontMetrics->get_font(“helvetica”, “bold”);
$canvas->page_text(540, 815, “Page $pageNumber of $pageCount”, $font, 8, array(0,0,0));
});
// 输出 PDF 到浏览器
$dompdf->stream(“dompdf_output.pdf”, [“Attachment” => false]);
?>
html 代码中(需要启用 php):
<script type="text/php">
if ( isset($pdf) ) {
$font = Font_Metrics::get_font("helvetica", "bold");
$pdf->page_text(72, 18, "Header: {PAGE_NUM} of {PAGE_COUNT}",
$font, 6, array(0,0,0));
}
</script>
在上面的例子中,PAGE_NUM 和 PAGE_COUNT 是 Dompdf 提供的预定义常量,分别代表当前页码和总页数。这些常量只能在 HTML 嵌入的 PHP 脚本中使用。
注意事项:
- 为了在 HTML 代码中使用 PHP 脚本,你需要在实例化 Dompdf 对象时启用 isPhpEnabled 选项。
- Font_Metrics::get_font() 方法用于获取字体对象,你需要指定字体名称和样式(例如 “helvetica”, “bold”)。
- $pdf->page_text() 方法的参数依次为:x 坐标、y 坐标、文本内容、字体对象、字体大小和颜色(RGB 数组)。
在特定页面添加内容
你可以结合条件判断语句,在特定页面上添加内容。例如,以下代码只会在第二页上添加页眉:
<script type="text/php">
if ( isset($pdf) && PAGE_NUM === 2 ) {
$font = Font_Metrics::get_font("helvetica", "bold");
$pdf->page_text(72, 18, "Header: Page 2",
$font, 6, array(0,0,0));
}
</script>
使用 Canvas 对象直接操作 PDF
除了使用 page_text 函数,你还可以使用 Canvas 对象的其他方法来直接操作 PDF 文档。例如,你可以使用 text 方法在当前页面的指定位置添加文本,使用 line 方法绘制线条,使用 rectangle 方法绘制矩形等等。
以下是一个使用 text 方法添加文本的例子:
<?php
use Dompdf/Dompdf;
// 实例化 Dompdf 对象
$dompdf = new Dompdf();
// 加载 HTML 内容
$html = '<html><body><h1>Hello, Dompdf!</h1></body></html>';
$dompdf->loadHtml($html);
// 渲染 HTML 为 PDF
$dompdf->render();
// 获取 Canvas 对象
$canvas = $dompdf->getCanvas();
// 获取 FontMetrics 对象
$fontMetrics = $dompdf->getFontMetrics();
// 添加文本
$font = $fontMetrics->get_font("helvetica", "bold");
$canvas->text(72, 18, "This is a test text.", $font, 10, array(0, 0, 0));
// 输出 PDF 到浏览器
$dompdf->stream("dompdf_output.pdf", ["Attachment" => false]);
?>
总结
通过本文,你应该对 Dompdf 中 $pdf 变量的含义、page_text 函数的用法以及如何使用 Canvas 对象直接操作 PDF 文档有了更深入的了解。掌握这些知识,你将能够更加灵活地控制 PDF 文档的生成,并实现各种自定义需求。记住,Canvas 对象主要用于绘制原始的 PDF 元素,而 page_text 函数则是在每一页上添加重复内容的最佳选择。在实际应用中,你可以根据具体需求选择合适的方法。
以上就是# Dompdf 中 $pdf 变量和 page_text 函数的使用详解的详细内容,更多请关注php中文网其它相关文章!


