KnpSnappyBundle
Snappy is a PHP (5.6+) wrapper for the wkhtmltopdf conversion utility.
It allows you to generate either pdf or image files from your html documents, using the webkit engine.
The KnpSnappyBundle provides a simple integration for your Symfony project.
Installation
With composer, require:
composer require knplabs/knp-snappy-bundle
Then enable it in your kernel (optional if you are using the Flex recipe with Symfony4) :
// app/AppKernel.php
public function registerBundles()
{
$bundles = array(
//...
new Knp\Bundle\SnappyBundle\KnpSnappyBundle(),
//...
Configuration
If you need to change the binaries, change the instance options or even disable one or both services, you can do it through the configuration.
# app/config/config.yml (or config/packages/knp_snappy.yaml if using Symfony4 and the Flex recipe)
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: []
If you want to change temporary folder which is sys_get_temp_dir() by default, you can use
# app/config/config.yml (or config/packages/knp_snappy.yaml if using Symfony4 and the Flex recipe)
knp_snappy:
temporary_folder: "%kernel.cache_dir%/snappy"
You can also configure the timeout used by the generators with process_timeout:
# app/config/config.yml (or config/packages/knp_snappy.yaml if using Symfony4 and the Flex recipe)
knp_snappy:
process_timeout: 20 # In seconds
Usage
The bundle registers two services:
- the
knp_snappy.imageservice allows you to generate images; - the
knp_snappy.pdfservice allows you to generate pdf files.
Generate an image from a URL
$container->get('knp_snappy.image')->generate('http://www.google.fr', '/path/to/the/image.jpg');
Generate a pdf document from a URL
$container->get('knp_snappy.pdf')->generate('http://www.google.fr', '/path/to/the/file.pdf');
Generate a pdf document from multiple URLs
$container->get('knp_snappy.pdf')->generate(array('http://www.google.fr', 'http://www.knplabs.com', 'http://www.google.com'), '/path/to/the/file.pdf');
Generate a pdf document from a twig view
$this->get('knp_snappy.pdf')->generateFromHtml(
$this->renderView(
'MyBundle:Foo:bar.html.twig',
array(
'some' => $vars
)
),
'/path/to/the/file.pdf'
);
Render an image as response from a controller
use Knp\Bundle\SnappyBundle\Snappy\Response\JpegResponse;
class SomeController
{
public function imageAction()
{
$html = $this->renderView('MyBundle:Foo:bar.html.twig', array(
'some' => $vars
));
return new JpegResponse(
$this->get('knp_snappy.image')->getOutputFromHtml($html),
'image.jpg'
);
}
}
Render a pdf document as response from a controller
use Knp\Bundle\SnappyBundle\Snappy\Response\PdfResponse;
class SomeController extends Controller
{
public function pdfAction()
{
$html = $this->renderView('MyBundle:Foo:bar.html.twig', array(
'some' => $vars
));
return new PdfResponse(
$this->get('knp_snappy.pdf')->getOutputFromHtml($html),
'file.pdf'
);
}
}
Render a pdf document with a relative url inside like css files
use Knp\Bundle\SnappyBundle\Snappy\Response\PdfResponse;
class SomeController extends Controller
{
public function pdfAction()
{
$pageUrl = $this->generateUrl('homepage', array(), true); // use absolute path!
return new PdfResponse(
$this->get('knp_snappy.pdf')->getOutput($pageUrl),
'file.pdf'
);
}
}
Maintainers
KNPLabs is looking for maintainers (see why).
If you are interested, feel free to open a PR to ask to be added as a maintainer.
We’ll be glad to hear from you :)
Credits
SnappyBundle and Snappy are based on the awesome wkhtmltopdf.
SnappyBundle has been developed by KnpLabs.