KnpSnappyBundle

KnpSnappyBundle

Snappy — это PHP-оболочка для утилиты преобразования wkhtmltopdf. Он позволяет создавать файлы PDF или изображения из ваших HTML-документов, используя движок WebKit.

KnpSnappyBundle обеспечивает простую интеграцию вашего проекта Symfony.

Ограничения

Если вы используете JavaScript для рендеринга страниц, вы можете столкнуться с некоторыми проблемами из-за того, что wkhtmltopdf не полностью совместим с API ES6. Единственный способ решить эту проблему — предоставить полифилы, устраняющие пробелы между современными API ES6 и механизмом рендеринга 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 ' );

Создать PDF-документ по URL-адресу

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

Создать PDF-документ из нескольких URL-адресов

 // @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.