Snappy ist ein PHP-Wrapper für das Konvertierungsdienstprogramm wkhtmltopdf. Mit der Webkit-Engine können Sie aus Ihren HTML-Dokumenten entweder PDF- oder Bilddateien generieren.
Das KnpSnappyBundle bietet eine einfache Integration für Ihr Symfony-Projekt.
Wenn Sie JavaScript zum Rendern Ihrer Seiten verwenden, können Probleme auftreten, da wkhtmltopdf nicht vollständig mit ES6-APIs kompatibel ist. Die einzige Möglichkeit, dieses Problem zu lösen, besteht darin, Polyfills bereitzustellen, die die Lücken zwischen modernen ES6-APIs und der wkhtmltopdf-Rendering-Engine schließen.
Mit Composer benötigen Sie:
composer require knplabs/knp-snappy-bundle
Wenn Sie Flex nicht verwenden, aktivieren Sie es in Ihrem Kernel:
// config/bundles.php
<?php
return [
//...
Knp Bundle SnappyBundle KnpSnappyBundle::class => [ ' all ' => true ],
//...
];
Wenn Sie die Binärdateien ändern, die Instanzoptionen ändern oder sogar einen oder beide Dienste deaktivieren müssen, können Sie dies über die Konfiguration tun.
# 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 : []
Wenn Sie den temporären Ordner ändern möchten, der standardmäßig sys_get_temp_dir()
ist, können Sie verwenden
# config/packages/knp_snappy.yaml
knp_snappy :
temporary_folder : " %kernel.cache_dir%/snappy "
Sie können das von den Generatoren verwendete Timeout auch mit process_timeout
konfigurieren:
# config/packages/knp_snappy.yaml
knp_snappy :
process_timeout : 20 # In seconds
Das Bundle registriert zwei Dienste:
knp_snappy.image
können Sie Bilder generieren.knp_snappy.pdf
können Sie PDF-Dateien generieren. // @var KnpSnappyImage
$ knpSnappyImage -> generate ( ' http://www.google.fr ' , ' /path/to/the/image.jpg ' );
// @var KnpSnappyPdf
$ knpSnappyPdf -> generate ( ' http://www.google.fr ' , ' /path/to/the/file.pdf ' );
// @var KnpSnappyPdf
$ knpSnappyPdf -> generate ( array ( ' http://www.google.fr ' , ' http://www.knplabs.com ' , ' http://www.google.com ' ), ' /path/to/the/file.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 '
);
}
}
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 '
);
}
}
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 sucht Betreuer (siehe warum).
Wenn Sie interessiert sind, können Sie gerne eine PR eröffnen und darum bitten, als Betreuer hinzugefügt zu werden.
Wir freuen uns, von Ihnen zu hören :)
SnappyBundle und Snappy basieren auf dem großartigen wkhtmltopdf. SnappyBundle wurde von KnpLabs entwickelt.