README

这是对 pdf-invoicr 的精简分支。

变更记录

PHP 7.3 - 8.0 支持
PSR-4 兼容
作为composer包提供
依赖通过composer安装

PHP 兼容性

简介

PHP Invoice 是一个简单的面向对象 PHP 类，只需几行代码即可生成美观的发票、报价或订单。使用您自己的标志和主题颜色进行品牌化，添加无限项和总行数，并自动分页。您可以在用户的浏览器中交付PDF输出，保存在服务器上或强制文件下载。PHP Invoice 完全可定制，并可以集成到任何知名 CMS。

多语言和货币

PHP Invoice 内置了英语、荷兰语、法语、德语、西班牙语和意大利语的翻译（如果需要，您可以轻松添加自己的翻译），并且您可以设置每个文档所需的货币。

附加标题、段落和徽章

可以将额外的内容（标题和多行段落）添加到文档的底部。您可能将其用于付款或运输信息或其他所需的内容。

安装

composer require konekt/pdf-invoice

示例

此存储库的 examples/ 文件夹中包含 3 个示例

simple.php
example1.php
example2.php
change_timezone.php

创建新发票

在使用类之前，请确保已设置默认的 php 日期时区。

在此简单示例中，我们使用自定义标志和主题颜色生成发票。它将包含 2 个产品，底部有一个包含增值税和总价的框。然后我们在输出之前添加一个 "已支付" 徽章。

use Konekt\PdfInvoice\InvoicePrinter;

  $invoice = new InvoicePrinter();
  
  /* Header settings */
  $invoice->setLogo("images/sample1.jpg");   //logo image path
  $invoice->setColor("#007fff");      // pdf color scheme
  $invoice->setType("Sale Invoice");    // Invoice Type
  $invoice->setReference("INV-55033645");   // Reference
  $invoice->setDate(date('M dS ,Y',time()));   //Billing Date
  $invoice->setTime(date('h:i:s A',time()));   //Billing Time
  $invoice->setDue(date('M dS ,Y',strtotime('+3 months')));    // Due Date
  $invoice->setFrom(array("Seller Name","Sample Company Name","128 AA Juanita Ave","Glendora , CA 91740"));
  $invoice->setTo(array("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->addItem("PDC-E5300","2.6GHz/1GB/320GB/SMP-DVD/FDD/VB",4,0,645,0,2580);
  $invoice->addItem('LG 18.5" WLCD',"",10,0,230,0,2300);
  $invoice->addItem("HP LaserJet 5200","",1,0,1100,0,1100);
  
  $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");
  
  $invoice->render('example1.pdf','I'); 
  /* I => Display on browser, D => Force Download, F => local path save, S => return document as string */

文档

创建实例

use Konekt\PdfInvoice\InvoicePrinter;

// Default Param: Size: A4, Currency: $, Language: en
$invoice = new InvoicePrinter($size, $currency, $language);

数字格式化

您想如何显示您的数字？

$invoice->setNumberFormat($decimalpoint, $seperator, $alignment, $space, $negativeParenthesis);

颜色

设置自定义颜色以个性化您的发票。

// Hexadecimal color code
$invoice->setColor($color);

添加标志

$invoice->setLogo($image, $maxwidth, $maxheight);

文档标题

// A string with the document title, will be displayed
// in the right top corner of the document (e.g. 'Invoice' or 'Quote')
$invoice->setType($title);

发票号

// Document reference number that will be displayed in
// the right top corner of the document (e.g. 'INV29782')
$invoice->setReference($number);

日期

//A string with the document's date
$invoice->setDate($date);

到期日

// A string with the document's due date
$invoice->setDue($duedate);

发行者信息

设置您的公司详细信息。

// An array with your company details. The first value of
// the array will be bold on the document so it's suggested
// to use your company's name. You can add as
// many lines as you need.
/** Example: */
$invoice->setFrom([
    'My Company',
    'Address line 1',
    'Address line 2',
    'City and zip',
    'Country',
    'VAT number'    
]);

客户信息

// An array with your clients' details. The first value of the
// array will be bold on the document so we suggest you to use
// the company's name. You can add as many lines as you need.
/** Example */
$invoice->setTo([
   'My Client',
   'Address line 1',
   'Address line 2',
   'City and zip',
   'Country',
   'VAT number'    
]);

切换

切换公司和客户信息的水平位置。默认情况下，您的公司详细信息在左侧。

$invoice->flipflop();

发行者和客户标题

隐藏发行者和客户标题行

$invoice->hideToFromHeaders();

添加项目

在公司和客户信息下方添加新产品或服务行到您的文档中。PHP Invoice 具有自动分页功能，因此没有绝对的限制。

$invoice->addItem(name,description,amount,vat,price,discount,total);

name {string} 产品或服务名称的字符串。
description {string} 描述字符串，支持多行。使用 <br> 或 \n 添加换行符。
amount {decimal} 表示此项目的整数值。
vat {string} 或 {decimal} 如果您想显示金额，则传递字符串（例如 "21%"，或您可能喜欢的任何其他文本）或十进制数（例如 124.30）。
price {decimal} 单价的小数。
discount {string}, {decimal} 或 {boolean} 可选。传递字符串（例如 "10%"，或您可能喜欢的任何其他文本）或小数（例如 50.00），如果在此字段中输入布尔值 false，则表示不提供折扣。注意：当所有产品都没有设置折扣时，最终输出将不会显示折扣列。
total {decimal} 产品或服务总价格的小数。

项目行描述字体大小

更改产品描述的字体大小。默认为 7。

$invoice->setFontSizeProductDescription(9);

添加总计

在产品和服务的下方添加一行，用于计算和总计。您可以添加无限行。

$invoice->addTotal(name,value,background);

name {string} 用于显示总计字段显示名称的字符串。
value {decimal} 表示价值的十进制数。
background {boolean} 可选。设置为true，将主题颜色设置为行的背景颜色。

添加徽章

在产品和服务的下方添加徽章到您的发票。例如，您可以用来显示发票已被支付。

$invoice->addBadge($badge);

badge {string} 包含徽章文本的字符串。

您可以将徽章的颜色设置为第二个参数

$invoice->addBadge('Paid', '#00ff00');
// Short hex variant is also supported
$invoice->addBadge('Payment pending', '#f00');

CSS颜色名称（'red'、'cyan'、'fuchsia'等）不受支持

添加标题

您可以在底部部分添加标题和段落以显示信息，例如付款详情或运输信息。

$invoice->addTitle($title);

title {string} 包含要显示在徽章中的标题的字符串。

添加段落