KnpSnappyBundle下載 - KnpSnappyBundle原始碼下載

KnpSnappyBundle

其他類別

v1.10.2

下載

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 '
        );
    }
}