PDF Invoice 生成器使用教程

1. 项目介绍

PDF Invoice 是一个基于 PHP 的开源类库，用于生成专业的 PDF 发票、报价单或订单。这个类库非常易于使用，只需要几行代码就能创建出带有自定义标志和主题颜色的文档。它支持无限的项目和总计行，并具备自动分页功能。生成的 PDF 可以直接在用户的浏览器中显示，保存到服务器上，或者强制下载。

2. 项目快速启动

首先，确保您的开发环境已经安装了 PHP。以下是使用 PDF Invoice 的基本步骤：

安装

通过 Composer 安装 PDF Invoice：

composer require konekt/pdf-invoice

创建发票

创建一个新的发票非常简单。以下是一个基础示例：

<?php
use Konekt\PdfInvoice\InvoicePrinter;

$invoice = new InvoicePrinter();

// 设置头部信息
$invoice->setLogo("images/sample1.jpg"); // 设置公司标志
$invoice->setColor("#007fff"); // 设置 PDF 的主题颜色
$invoice->setType("Sale Invoice"); // 设置文档类型
$invoice->setReference("INV-55033645"); // 设置发票编号
$invoice->setDate(date('M dS ,Y', time())); // 设置开票日期
$invoice->setDue(date('M dS ,Y', strtotime('+3 months'))); // 设置付款截止日期

// 设置发件人和收件人信息
$invoice->setFrom([
    "Seller Name",
    "Sample Company Name",
    "128 AA Juanita Ave",
    "Glendora, CA 91740"
]);
$invoice->setTo([
    "Purchaser Name",
    "Sample Company Name",
    "128 AA Juanita Ave",
    "Glendora, CA 91740"
]);

// 添加发票条目
$invoice->addItem("AMD Athlon X2DC-7450", "2.4GHz/1GB/160GB/SMP-DVD/VB", 6, 0, 580, 0, 3480);
// ... 添加更多条目

// 添加总计
$invoice->addTotal("Total", 9460);
$invoice->addTotal("VAT 21%", 1986.6);
$invoice->addTotal("Total due", 11446.6, true);

// 添加徽章（例如：已支付）
$invoice->addBadge("Payment Paid");

// 添加底部标题和段落
$invoice->addTitle("Important Notice");
$invoice->addParagraph("No item will be replaced or refunded if you don't have the invoice with you.");

// 设置页脚注释
$invoice->setFooternote("My Company Name Here");

// 生成 PDF 并在浏览器中显示
$invoice->render('example1.pdf', 'I'); // 'I' => 在浏览器中显示, 'D' => 强制下载, 'F' => 本地保存, 'S' => 返回文档字符串
?>

确保在使用上述代码之前，已经正确设置好了 PHP 的默认时区，并且将 images/sample1.jpg 替换为您自己的公司标志文件路径。

3. 应用案例和最佳实践

• 自定义模板：根据您公司的品牌风格，自定义 PDF 文档的模板。
• 多语言支持：PDF Invoice 支持多种语言，可以轻松添加新的语言支持。
• 集成至 CMS：PDF Invoice 可以轻松集成到任何流行的内容管理系统（CMS）中。

4. 典型生态项目

在开源社区中，有许多项目使用了 PDF Invoice 或者提供了相关的扩展。探索这些项目可以帮助您更好地了解如何在自己的项目中使用 PDF Invoice。以下是一些典型的生态项目：

• PDF Invoice 扩展：提供额外的功能，如条形码生成、高级定制等。
• CMS 插件：为流行的 CMS 系统提供的 PDF Invoice 插件，如 WordPress、Drupal 等。

通过这些模块的学习和使用，您可以更好地掌握 PDF Invoice 的使用方法，并将其应用到实际项目中。