KnpSnappyBundle

KnpSnappyBundle

Snappy 是 wkhtmltopdf 转换实用程序的 PHP 包装器。它允许您使用 webkit 引擎从 html 文档生成 pdf 或图像文件。

KnpSnappyBundle 为您的 Symfony 项目提供了简单的集成。

局限性

如果您使用 JavaScript 来渲染页面，您可能会遇到一些问题，因为 wkhtmltopdf 与 ES6 api 不完全兼容。解决这个问题的唯一方法是提供polyfills来修复现代ES6 api和wkhtmltopdf渲染引擎之间的差距。

安装

对于作曲家，需要：

composer require knplabs/knp-snappy-bundle

如果您不使用 Flex，请在内核中启用它：

 // config/bundles.php
<?php

return [
    //...
    Knp  Bundle  SnappyBundle KnpSnappyBundle::class => [ ' all ' => true ],
    //...
];

配置

如果您需要更改二进制文件、更改实例选项甚至禁用一项或两项服务，您可以通过配置来完成。

 # config/packages/knp_snappy.yaml
knp_snappy :
    pdf :
        enabled :    true
        binary :     /usr/local/bin/wkhtmltopdf # ""C:\Program Files\wkhtmltopdf\bin\wkhtmltopdf.exe"" for Windows users
        options :    []
    image :
        enabled :    true
        binary :     /usr/local/bin/wkhtmltoimage # ""C:\Program Files\wkhtmltopdf\bin\wkhtmltoimage.exe"" for Windows users
        options :    []

如果您想更改默认的临时文件夹sys_get_temp_dir() ，您可以使用

 # config/packages/knp_snappy.yaml
knp_snappy :
    temporary_folder : " %kernel.cache_dir%/snappy "

您还可以使用process_timeout配置生成器使用的超时：

 # config/packages/knp_snappy.yaml
knp_snappy :
    process_timeout : 20 # In seconds 

用法

该捆绑包注册了两个服务：

• knp_snappy.image服务允许您生成图像；
• knp_snappy.pdf服务允许您生成 pdf 文件。

从 URL 生成图像

 // @var KnpSnappyImage
$ knpSnappyImage -> generate ( ' http://www.google.fr ' , ' /path/to/the/image.jpg ' );

从 URL 生成 pdf 文档

 // @var KnpSnappyPdf
$ knpSnappyPdf -> generate ( ' http://www.google.fr ' , ' /path/to/the/file.pdf ' );

从多个 URL 生成 pdf 文档

 // @var KnpSnappyPdf
$ knpSnappyPdf -> generate ( array ( ' http://www.google.fr ' , ' http://www.knplabs.com ' , ' http://www.google.com ' ), ' /path/to/the/file.pdf ' );

从树枝视图生成 pdf 文档

 // @var KnpSnappyPdf
$ knpSnappyPdf -> generateFromHtml (
    $ this -> renderView (
        ' MyBundle:Foo:bar.html.twig ' ,
        array (
            ' some '  => $ vars
        )
    ),
    ' /path/to/the/file.pdf '
);

渲染图像作为控制器的响应

 use Knp  Bundle  SnappyBundle  Snappy  Response  JpegResponse ;
use Symfony  Bundle  FrameworkBundle  Controller  AbstractController ;

class SomeController extends AbstractController
{
    public function imageAction ( Knp  Snappy  Image $ knpSnappyImage )
    {
        $ html = $ this -> renderView ( ' MyBundle:Foo:bar.html.twig ' , array (
            ' some '  => $ vars
        ));

        return new JpegResponse (
            $ knpSnappyImage -> getOutputFromHtml ( $ html ),
            ' image.jpg '
        );
    }
}

渲染 pdf 文档作为控制器的响应

 use Knp  Bundle  SnappyBundle  Snappy  Response  PdfResponse ;
use Symfony  Bundle  FrameworkBundle  Controller  AbstractController ;

class SomeController extends AbstractController
{
    public function pdfAction ( Knp  Snappy  Pdf $ knpSnappyPdf )
    {
        $ html = $ this -> renderView ( ' MyBundle:Foo:bar.html.twig ' , array (
            ' some '  => $ vars
        ));

        return new PdfResponse (
            $ knpSnappyPdf -> getOutputFromHtml ( $ html ),
            ' file.pdf '
        );
    }
}

渲染一个 pdf 文档，其中包含相对 url，就像 css 文件一样

 use Knp  Bundle  SnappyBundle  Snappy  Response  PdfResponse ;
use Symfony  Bundle  FrameworkBundle  Controller  AbstractController ;

class SomeController extends AbstractController
{
    public function pdfAction ( Knp  Snappy  Pdf $ knpSnappyPdf )
    {
        $ pageUrl = $ this -> generateUrl ( ' homepage ' , array (), true ); // use absolute path!

        return new PdfResponse (
            $ knpSnappyPdf -> getOutput ( $ pageUrl ),
            ' file.pdf '
        );
    }
}

维护者

KNPLabs 正在寻找维护人员（看看原因）。

如果您有兴趣，请随时打开 PR 要求添加为维护者。

我们很高兴收到您的来信:)

制作人员

SnappyBundle 和 Snappy 基于出色的 wkhtmltopdf。 SnappyBundle 由 KnpLabs 开发。