如何使用 wkhtmltopdf 获取 html 生成的 pdf 中的页码

Posted

技术标签:

【中文标题】如何使用 wkhtmltopdf 获取 html 生成的 pdf 中的页码【英文标题】:How to get page numbers in pdf generated by html with wkhtmltopdf 【发布时间】:2015-09-07 17:54:24 【问题描述】:

这是我们的答案:

我们目前正在使用wkhtmltopdf 从给定的 html 模板生成 PDF。

一些背景信息:

我们使用Sulu CMF 来构建我们的后端,它基于Symfony2。 KnpSnappy Bundle 用作 wkhtmltopdf 的 Symfony 包装器。

我们如何生成 PDF:

由于许多 PDF 共享相同的页眉和页脚,我们创建了一个 BasePDFBundle,它提供了一个 PDFManager,可以通过给定的 TWIG 模板动态构建 PDF。默认情况下,包含通用页眉和页脚(通常带有客户的姓名和徽标)。

页脚问题/页脚(或页眉)中的页码:

在 PDF 中添加页码非常有用,例如。对于订单,我们的大部分内容都是动态添加的(例如产品列表)。由于 PDF 的样式可以更改并且内容本身是动态添加的,因此必须有一种快速简便的方法将当前页面和总页面添加到生成的 PDF 中。这是我们所做的:

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN">
<html>
<head>
    <base href=" app.request.schemeAndHttpHost " />
    <meta charset="utf-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
    <link rel="stylesheet" href=" asset('bundles/pdfbase/css/pdfstyles.css') "/>
</head>
<body class="footer">
    <div class="footer-container">
        <div class="footer-widget">
            <b>FooBar Company Name</b>
        </div>
        <div class="text-align-right">
            <span class="page"></span>/<span class="topage"></span>
        </div>
    </div>

    <script type="text/javascript">
     (function() 
       // get all url parameters and transform it to a list
       // pdf generator adds a param for current and the total page sum
       // add the value to the html elements
       var urlParams = document.location.search.substring(1).split('&');
       var urlParamsList = ;
       var pagingElements = ['topage', 'page'];

       for (var i in urlParams) 
         var param = urlParams[i].split('=', 2);
         urlParamsList[param[0]] = unescape(param[1]);
       

       for (var i in pagingElements) 
         var elem = document.getElementsByClassName(pagingElements[i]);
         for (var j = 0; j < elem.length; ++j) 
           elem[j].textContent = urlParamsList[pagingElements[i]];
         
       
     )();
    </script>
 </body>

是的,pagetopage 的变量名称可能会更好,但是它们与将树枝模板合并到最终 PDF 模板时使用的 KnpSnappy 包装器相同。这是获取当前页码和总页码的最简单方法,因为您可以让包装器完成所有计算。

最后你只需要替换html标签的文本就可以了!

本地机器和服务器的区别:

当 wkh​​tmltopdf 打开一个虚拟浏览器来“渲染”树枝模板时,这可能会导致您在服务器上生成 pdf 时出错。我们发现使用 &lt;body onload="doSomething()"&gt; 之类的事件标签不是一个好主意,您应该像我们在上面的示例中那样触发您的 javascript 代码。

【问题讨论】:

我错过了一个问题吗?还是这是寻求问题的答案? 这个问题直接回答了=) 关键是不要使用onload="doSomething"。我见过的所有例子都在使用这种方法,但它不起作用。这样做。谢谢! 【参考方案1】:

如果您使用 KnpSnappy 作为 wkhtmltopdf 的包装器,那么您可以为您的 pdf 设置各种选项。

请参阅 wkhtmltopdf 文档中的“页脚和页眉:”部分,此处为 http://wkhtmltopdf.org/usage/wkhtmltopdf.txt

[page] 替换为当前正在打印的页数

[topage] 替换为要打印的最后一页的编号

以下是 Symfony2 控制器的示例,检查 $pdfOptions 数组中的 footer-html 选项,其中我使用了两个占位符来打印 pdf 文件每页页脚的页码。

<?php

namespace Rm\PdfBundle\Controller;

use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Bundle\FrameworkBundle\Controller\Controller;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Method;

/**
 * Pdf controller
 */
class PdfController extends Controller

    /**
     * Serve pdf
     *
     * @Route("/article/slug", name="rm_pdf_view")
     * @Method("GET")
     */
    public function viewAction(Request $request, $slug)
    

        // build html
        $html = $this->renderView('RmPdfBundle:Pdf:view.html.twig', array(
            'data'  => $yourDataToTemplate,
        ));


        // prepare pdf options
        $pdfOptions = array(

            'footer-html'      => '<p>Page : [page] of [pageTo]</p>',

            'footer-font-size' => '10',
            'page-size'        => 'A4',
            'orientation'      => 'Portrait',
            'margin-top'       => 10,
            'margin-bottom'    => 20,
            'margin-left'      => 15,
            'margin-right'     => 15,
            );

        // file name of pdf
        $pdfFileName = "nameOfYourPdfFile.pdf";

        // server pdf file to user using knp_snappy.pdf service
        return new Response(
            $this->get('knp_snappy.pdf')->getOutputFromHtml($html, $pdfOptions),
            200,
            array(
                'Content-Type'          => 'application/pdf',
                'Content-Disposition'   => 'attachment; filename="'.$pdfFileName.'"',
            )
        );

    

【讨论】:

以上是关于如何使用 wkhtmltopdf 获取 html 生成的 pdf 中的页码的主要内容,如果未能解决你的问题,请参考以下文章

如何在 ASP.net 中使用 wkhtmltopdf.exe [重复]

如何在页面底部添加页脚 wkhtmltopdf

wkhtmltopdf 内部链接

《html转pdf-----wkhtmltopdf踩坑总结》

java完成HTML转PDF wkhtmltopdf

使用 wkhtmltopdf 从 HTML 生成 Google Web 字体和 PDF