luisinder / pdf-invoice
用于生成PDF发票的库
Requires
- php: >=5.6
- ext-iconv: *
- ext-mbstring: *
- setasign/fpdf: ~1.8.1
Requires (Dev)
- phpunit/phpunit: ~5.0
README
这是一个从 artkonekt/pdf-invoice 分支出来的版本,已经解决了西班牙语的bug。
变更记录
- PHP 7.0 支持
- PSR-4 兼容
- 作为composer包提供
- 依赖项通过composer安装
简介
PHP发票是一个简单的面向对象的PHP类,可以通过几行代码生成精美设计的发票、报价单或订单。您可以添加自己的标志和主题颜色,添加无限项和总行数,自动分页。您可以将PDF输出交付给用户的浏览器,保存在服务器上或强制下载文件。PHP发票完全可定制,并可集成到任何知名的内容管理系统。
多语言和货币
PHP发票内置了英语、荷兰语、法语、德语、西班牙语和意大利语的翻译(如果需要,您也可以轻松添加自己的翻译),您可以为每个文档设置所需的货币。
额外的标题、段落和徽章
可以将额外的内容(标题和多行段落)添加到文档的底部。您可以使用它来添加付款或运输信息或任何其他所需内容。
安装
composer require luisinder/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);
颜色
设置自定义颜色以个性化您的发票。
// 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();
添加项目
在公司和客户信息下方添加新的产品或服务行到您的文档中。PHP发票具有自动分页功能,因此绝对没有限制。
$invoice->addItem(name,description,amount,vat,price,discount,total);
name {string} 产品或服务名称的字符串。 description {string} 多行支持的描述字符串。使用以下任一
或 \n 来添加换行符。 amount {decimal} 该项目的数量。 vat {string} 或 {decimal} 传递一个字符串(例如 "21%",或您可能喜欢的任何其他文本)或一个十进制数,如果您想显示金额(例如 124.30)。 price {decimal} 单价。 discount {string}, {decimal} 或 {boolean} 可选 传递一个字符串(例如 "10%",或您可能喜欢的任何其他文本)或一个十进制数,如果您想显示金额(例如 50.00)。如果您不想提供折扣,请在此字段中输入布尔值 false。注意:当所有产品都没有设置折扣时,最终输出将不会显示折扣列。 total {decimal} 产品或服务总价。
添加总计
在产品和服务的下方添加一行进行计算和总计。您可以添加无限行。
$invoice->addTotal(name,value,background);
名称 {string} 显示整个字段的名称的字符串。值 {decimal} 表示值的十进制数。背景 {boolean} 可选 设置为 true 以将主题颜色设置为行的背景色。
添加徽章
在您的发票产品和服务下方添加徽章。例如,您可以使用此功能显示发票已付款。
$invoice->addBadge($badge);
徽章 {string} 包含徽章文本的字符串。
添加标题
您可以将标题和段落添加到文档的底部部分,以显示信息,例如付款详情或运输信息。
$invoice->addTitle($title);
标题 {string} 包含要显示在徽章中的标题的字符串。
添加段落
您可以将标题和段落添加到文档的底部部分,以显示信息,例如付款详情或运输信息。
$invoice->addParagraph($paragraph);
段落 {string} 包含多行支持的段落文本。可以使用以下任一方法添加换行符:
或 \n。
页脚
您想在文档底部左角显示的简短文本。
$invoice->setFooternote($note);
注释 {string} 包含您想在页脚中显示的信息的字符串。
渲染发票
$invoice->render($name, $output);
名称 {string} 包含您的发票名称的字符串。
示例:'invoice.pdf'
输出 {string} 选择您希望如何将发票发送给用户。以下选项可用:I(将文件内联发送到浏览器)D(发送到浏览器并强制以名称参数中给出的名称下载文件)F(保存到本地文件。确保在名称参数中设置路径)S(将文档作为字符串返回)