一、需求

某一个合同需要在线生成,其中一部分内容是固定的,而另一部分内容是需要添加和编辑的。

编辑的部分是表单内容的填写,内容涵盖了:table input 两个主要的html元素

现在需要在页面编辑完合同之后,生成一份PDF文件保存在本地,同时下载一份文件

二、选择TCPDF

TCPDF 地址: https://tcpdf.org/

1. 选择的原因

不需要安装其他任何的依赖,这个是我最喜欢用它的原因。

2. 安装

使用 composer 安装即可,在 packagist 的地址是 :https://packagist.org/packages/tecnickcom/tcpdf

作者 tecnickcom 各种和 tcpdf 相关的包都有:https://packagist.org/packages/tecnickcom/

composer require tecnickcom/tcpdf

3. 使用方式

因为是在html上操作,然后生成pdf,所以使用的方式是 writeHtml()

tcpdf 官网很多例子,可以直接用,比如 writeHtml() 就有专门的例子说明:

4. 示例代码

下面的代码中需要注意的地方:

  • 我去掉了一部分的内容,如果你需要,则可以参照官方网站的例子增加

    • 比如我去掉了 页眉 页脚, 并且 页面距 都是 10
  • 最终使用的写入方式是 $pdf->writeHtml() ,参数使用推荐的参数即可
// create new PDF document
$pdf = new TCPDF(PDF_PAGE_ORIENTATION, PDF_UNIT, PDF_PAGE_FORMAT, true, 'UTF-8', false);
// set document information
$pdf->SetCreator(PDF_CREATOR);
$pdf->SetAuthor('pdf作者');
$pdf->SetTitle('PDF标题');

$pdf->setPrintHeader(false);
$pdf->setPrintFooter(false);

// set default monospaced font
$pdf->SetDefaultMonospacedFont(PDF_FONT_MONOSPACED);

// set margins
$pdf->SetMargins(10, 10, 10);
$pdf->SetHeaderMargin(PDF_MARGIN_HEADER);
$pdf->SetFooterMargin(PDF_MARGIN_FOOTER);

// set auto page breaks
$pdf->SetAutoPageBreak(TRUE, PDF_MARGIN_BOTTOM);

// set image scale factor
$pdf->setImageScale(PDF_IMAGE_SCALE_RATIO);

// Add a page
// This method has several options, check the source code documentation for more information.
$pdf->AddPage();

// set default font subsetting mode
$pdf->setFontSubsetting(true);
// Set font
// dejavusans is a UTF-8 Unicode font, if you only need to
// print standard ASCII chars, you can use core fonts like
// helvetica or times to reduce file size.
$pdf->SetFont('msyh', '', 11, '', true);

// set text shadow effect
$pdf->setTextShadow(array('enabled'=>false));
// Set some content to print
$html ='
<style>
input{
border:0;
border-bottom: 1px solid #cccccc;
padding:5px;
}
</style>
<div >
<h1>测试生成PDF</h1>
<input type="text" name="name" value="" size="20" maxlength="30" style="border:0;border-bottom: 1px;" />
<table cellspacing="0" border="1px"> 
  <tbody>
    <tr>
        <td>AAAA</td>
        <td>BBBB</td>
        <td>CCCC</td>
    </tr> 
</tbody>
</table>
</div> 
';
// Print text using writeHTMLCell()
// $pdf->writeHTMLCell(0, 0, '', '', $html, 0, 1, 0, true, '', true);
// output the HTML content
$pdf->writeHTML($html, true, false, true, false, '');
// reset pointer to the last page
$pdf->lastPage();
// ---------------------------------------------------------
// Close and output PDF document
// This method has several options, check the source code documentation for more information.
$pdf->Output('example_001.pdf', 'D');
//============================================================+
// END OF FILE
//============================================================+

5. 生成结果

p1.jpg

三、不可避免的问题

1、 XHTML

需要注意的是,在使用 writeHtml() 的时候,支持的是 XHTML 而非 HTML ,当然 HTML5 更不支持

因此在构建前端页面的html代码的时候,请使用 xhtml,否则一些内容会失效。

比如:

1) input 表单必须进行闭合

XHTML要求所有单标签必须进行自闭和,而 tcpdf 自然无法识别

像上面 如果 input 按照 html5 标准写是无法认出来的。

2) 样式如果比较少,建议写在 tag 中的内联样式 style="" ,而非写在 <style> 标签内。

虽然 TCPDF支持 <style> 这样写法,但是如 margin-top 这样的写在 <style> 标签中不生效,但是写在内联样式竟然生效!

2、 生成PDF文件的方式

最后的 $pdf->Output('example_001.pdf', 'D'); 有两个参数:

  • 第一个参数是文件名
  • 第二个参数是导出方式

1. 常用的导出方式分别是:

  • I : 直接在线预览二进制pdf文件(注意在一些PHP框架中,是无法直接显示,会显示乱码)
  • D :直接下载到客户端电脑并自动在浏览器预览
  • FD : 在服务器上存一份,并下载到当前客户端然后会在浏览器预览
  • F: 存储在服务器中,不在客户端下载

2. 如果选择 F 或者 FD 可能会遇到 fopen 啥啥啥的错误

解决方案是,如果 选择在服务器保存( F 或 FD ),第一个参数的文件名是需要一个 绝对路径 的,比如:

$pdf->Output('/data/pdf/example_001.pdf','FD');

然后就能够解决问题。

四、中文乱码

中文肯定是乱码,这个想也不用多想。

最简单的解决方案:

1. 下载tcpdf支持的的中文字体

我在 CSDN 找到的是微软雅黑的,亲测可用,下载地址:

2. 将文件进行替换

  • 压缩包中包含msyh.php,msyh.z,msyh.ctg.z三个文件,直接放入tcpdf的fonts目录下,
  • 使用setfont("msyh","",11)设置生成pdf字体大小即可

我上面的代码中已经设置了微软雅黑字体,然后中文就没问题。