Deblan blog

Tag #PDF

Générer des PDF dans Symfony2

La génération de PDF fait souvent partie des cahiers des charges de projets de moyenne et grande envergure. Il existe quelques outils comme HTML2PDF qui repose sur FPDF ou TCPDF. Cependant, bien qu'ils soient puissants et fonctionnels, leur utilisation peut très vite devenir complexe quand il s'agit de mettre en forme précisément les contenus.

C'est pourquoi nous avons décidé d'utiliser Wkhtmltopdf. Ce petit bijou a la particularité de reposer sur un moteur de rendu Webkit. Le javascript est interprété et des plugins additionnels (comme Flash) peuvent être ajoutés. En plus de ça, il interprète extrêmement bien le CSS et toutes les balises HTML sont prises en compte.

Bon, trêve de bavardage, voici comment l'installer et l'utiliser.

Je travail avec Debian Wheezy, que ce soit sur mon poste de développement ou sur les serveurs en production. Vous devrez donc adapter la suite de l'article à votre système.

Installation de Wkhtmltopdf
Coté système
$ su - 
# aptitude update
# aptitude install wkhtmltopdf

Wkhtmltopdf a besoin d'un serveur X pour fonctionner. Comme les serveurs n'en disposent pas, nous allons installer xvfb qui permet d'en créer un virtuel.

# aptitude install xvfb

Il faut ensuite préparer un wrapper pour lancer wkhtmltopdf via xvfb :

# cat > /usr/bin/wkhtmltopdf.sh << EOF
#!/bin/sh

xvfb-run -a wkhtmltopdf "$@"
EOF
# chmod +x /usr/bin/wkhtmltopdf.sh
Coté Symfony2

KNP Labs a développé un bundle dédié à wkhtmltopdf. Ke vais passer par composer pour l'intégrer au framework :

$ cd /chemin/vers/le/projet
$ ./composer.phar require knplabs/knp-snappy-bundle

Activons à présent le bundle dans AppKernel.php :

$bundles = array(
    /* ... */
    new Knp\Bundle\SnappyBundle\KnpSnappyBundle(),
)

Il est nécessaire de le configurer en indiquant le chemin de wkhtmltopdf. Dans le fichier app/config/config.yml, ajoutez ces lignes :

knp_snappy:
    pdf:
        enabled:    true
        binary:     /usr/bin/wkhtmltopdf.sh
        options:    []

Videz le cache et lisez la doc pour savoir comme il fonctionne. Un truc intéressant à savoir : il utilise des feuilles de styles dédiées à l'impression.

Une astuce pour gérer la pagination

Bien qu'il soit ultra puissant, il n'y a pas d'outil pour gérer la pagination. Wkhtmltopdf va récupérer du code HTML et convertir le tout en PDF. En fonction de la taille de la page (qui est paramétrable) et de son format (portait ou paysage), il va enquiller le contenu et générer une page quand il sera nécessaire de le faire. Si vous souhaitez faire des sauts de page, vous devrez faire un peu de javascript. Voici la démarche que j'ai employée pour un projet.

J'ai découpé le contenu en différentes divisions portants la classe "print-page". Chaque division représente un contenu qui doit nécessairement être affiché en début de page. Dans mon projet, j'ai utilisé un rendu en A4 paysage et la zone représentant le contenu fait 1340px de largeur pour 934px de hauteur. Il suffit à présent de modifier la hauteur des divisions en calculant le nombre de pages nécessaires à leur affichage.

// Dépend de jQuery

var page_height   = 934;
var $print_pages  = $('.print-page');

$print_pages.each(function(i, v) {
	var $content    = $(this);	
	var height      = $content.height();
	var pages_count = 1;
	var newheight   = pages_count * page_height;

	while(height - 20 > newheight) {
		pages_count++;
		newheight = pages_count * page_height;
	}
	
	$content.css({height: newheight});
});

Il est également important d'indiquer des largeurs à vos contenus car j'ai eu quelques problèmes de génération avant de le faire.