PHP WkHtmlToPdf 使用教程

项目介绍

PHP WkHtmlToPdf 是一个围绕 wkhtmltopdf 命令行工具的轻量级 PHP 封装库，提供了简单易用的面向对象接口，方便用户在 PHP 项目中生成 PDF 文件。wkhtmltopdf 和 wkhtmltoimage 命令行工具必须安装并正常工作在您的系统上。

项目快速启动

安装

首先，通过 Composer 安装 PHP WkHtmlToPdf：

composer require mikehaertl/phpwkhtmltopdf

基本使用

以下是一个生成单页 PDF 的简单示例：

<?php
use mikehaertl\wkhtmlto\Pdf;

// 创建 Pdf 实例，可以传递文件路径、HTML 字符串、URL 或选项数组
$pdf = new Pdf('/path/to/page.html');

// 如果需要，设置 wkhtmltopdf 可执行文件的路径
// $pdf->binary = 'C:\path\to\wkhtmltopdf';

// 保存 PDF 文件
if (!$pdf->saveAs('/path/to/page.pdf')) {
    $error = $pdf->getError();
    // 处理错误
}

应用案例和最佳实践

多页 PDF 生成

以下是一个生成包含目录和封面页的多页 PDF 的示例：

<?php
use mikehaertl\wkhtmlto\Pdf;

$pdf = new Pdf([
    'page' => 'http://example.com',
    'toc' => [],
    'cover' => 'http://example.com/cover.html',
]);

if (!$pdf->saveAs('/path/to/report.pdf')) {
    $error = $pdf->getError();
    // 处理错误
}

最佳实践

1. 确保 wkhtmltopdf 安装正确：在开始使用 PHP WkHtmlToPdf 之前，确保 wkhtmltopdf 已正确安装并可以在命令行中运行。
2. 设置正确的路径：如果 wkhtmltopdf 不在系统 PATH 中，确保在代码中设置正确的二进制文件路径。
3. 处理错误：始终检查 saveAs 方法的返回值，并处理可能的错误。

典型生态项目

PHP WkHtmlToPdf 可以与以下项目结合使用，以增强功能和性能：

1. Laravel：在 Laravel 框架中，可以使用 PHP WkHtmlToPdf 生成 PDF 报告。
2. Symfony：在 Symfony 项目中，通过服务容器集成 PHP WkHtmlToPdf。
3. CodeIgniter：在 CodeIgniter 中，通过 Composer 安装并使用 PHP WkHtmlToPdf。

这些生态项目提供了更高级的功能和更好的开发体验，使得 PHP WkHtmlToPdf 更加强大和易用。