Créer un modèle de document PDF

Ce document décrit comment créer son propre modèle de génération de document PDF afin de personnaliser ses documents (propales, factures, etc...) Il se base sur les propositions commerciales comme exemple mais s'applique à tout type de document.

Pour savoir comment générer un modèle de document ODT, voir la page Créer un modèle de document ODT. Créer un modèle PDF requiert des connaissances en programmation PHP mais pas la création de modèles ODT.

Prérequis

Dolibarr: 3.0+
Connaissance en PHP

Trouver le modèle existant le plus proche

Dans Dolibarr, tester les modèles existants en allant dans la configuration du module puis en consultant l'aperçu en cliquant le picto "Aperçu" en fin de ligne du modèle. Consulter chacun des modèles disponibles.

Parmi ceux existant, noter le modèle le plus proche de vos besoins. Dans cet exemple, c'est le modèle azur (correspondant au fichier pdf_propale_azur.modules.php).

Pour info, tous les modèles sont dans htdocs/core/modules puis le sous-répertoire propale pour les propositions commerciales, facture pour les factures, commandes pour les commandes, etc... et enfin doc. Par exemple, un modèle personnalisé de proposition sera dans ...core/modules/propale/doc/ pour un modèle personnalisé de facture ce sera dans ...core/modules/facture/doc/ ,etc ...

Créer le nouveau modèle

Par sécurité, on conservera les modèles d'origine. Pour l'exemple, on part du principe qu'on crée un nouveau module de proposition commerciale qu'on nommera 'masocietebleu' et qui s'inspire du module 'azur':

Copier le fichier pdf_propale_azur.modules.php
Renommer la copie en pdf_propale_masocietebleu.modules.php
L'éditer et faire les modifs suivantes dans le code:

Renommer “Class pdf_propale_azur {” en “Class pdf_propale_masocietebleu {” (important : le nom de la classe et celui du fichier doivent correspondre)
Renommer la variable $this->name pour refléter le nouveau nom. Par exemple pour le modèle 'azur', changer la ligne '$this->name = "azur";' en '$this->name = "masocietebleu";'.
Sauvegarder : le modèle 'masocietebleu' est disponible dans la liste des modèles de propales de Dolibarr

Tester ce modèle en l'activant dans la page de configuration du module en rapport avec le modèle (donc la page de configuration du module des Propositions commerciales dans notre exemple) et en affichant l'aperçu...

Personnaliser votre nouveau modèle

Personnaliser le modèle créé en modifiant le code:

Toujours dans pdf_propale_masocietebleu.modules.php, chercher la fonction '_pagehead()'. C'est elle qui gère l'affichage de l'entête.

Chercher la fonction '_pagefooter()'. C'est elle qui gère l'affichage du pied de page.

Chercher la fonction 'write_file()'. C'est elle qui affiche le corps du PDF.

Librairie de manipulation de PDF

La librairie utilisée pour la création de documents en PDF se nomme TCPDF et peut être trouvée dans htdocs/includes/tcpdf/tcpdf.class.php. C'est également dans cette classe que l'on trouve les nombreuses méthodes utilisées pour générer les différents éléments des documents.

Les modèles de génération de pdf instancient un objet pdf par appel de pdf_getInstance() et utilisent ensuite ses méthodes, combinées avec les données d'une facture, d'une commande ou d'autres objets.

On retrouve généralement les appels suivants dans les scripts de création de documents:

$pdf->SetFont() - Désigne la fonte à utiliser pour le texte qui suivra
$pdf->SetXY() - Désigne le point de départ pour dessiner le prochain texte en coordonnées X,Y qui sont exprimées en millimètres de la page
$pdf->MultiCell() - Dessine une boîte pouvant contenir du texte, et dont on doit d'abord donner la largeur et la hauteur - très utilisée
$pdf->GetY() - Renvoie la position courante en Y
$pdf->SetDrawColor() - Désigne la couleur à utiliser pour le prochain texte à écrire - généralement noir (0,0,0) ou blanc (255,255,255)
$pdf->Rect() - Dessine un rectangle dont le coin supérieur gauche est au point indiqué par les deux premiers paramètres et le coin inférieur droit utilise les deux derniers paramètres en mode relatif aux deux premiers

Structure des scripts

Les scripts de génération des documents PDF, disposent des méthodes suivantes (prenant pour exemple le modèle "crabe") au sein de la classe du modèle:

__construct() - Constructeur de l'objet PDF
write_pdf_file() - Méthode générale pour la génération du fichier. Cette méthode appelle toute les suivantes après avoir initialisé quelques variables
_pagehead() - Méthode de dessin de l'en-tête du document, incluant généralement le logo, le titre du document (et la date) ainsi que les cadres de l'émetteur et du destinataire du document
_tableau() - Méthode de dessin du tableau de détails (produits, services, etc)
_tableau_info() - Méthode de dessin du tableau reprenant une liste d'informations sur la facture
_tableau_tot() - Méthode de dessin du tableau des totaux
_tableau_versement() - Méthode de dessin du tableau des règles de versement
_pagefoot() - Méthode de dessin du pied de page

Example de personnalisation

Insertion d'un logo

Ajouter l'instruction :

$pdf->Image(DOL_DOCUMENT_ROOT.'\societe\logo.jpg', 10, 5, 60.00);

Avec dans l'exemple : 10=abscisse, 5=ordonnée, 60=largeur logo

Si le logo se trouve par dessous ou dessus du texte existant, supprimer le texte existant en commentant le code qui affiche l'information ou en modifiant sa position.

Insertion d'une signature ou autre en bas de page facture

ouvrir le fichier .php à modifier et insérer

$pdf->Image(DOL_DOCUMENT_ROOT.'/mydir/signature.jpg',120,250,74);

l'image (largeur 74mm) est affichée colonne de droite juste avant le pied de page.

copier l'image dans le répertoire. il semble qu'une image png avec transparence pose problème.
générer le PDF, la signature apparaît.

Insertion de texte

Principales fonctions utilisées

$pdf->setX(float a); // fixe la position x courante
$pdf->setY(float b); // fixe la position y courante
$pdf->setXY(float a,float b); // fixe les positions x et y courantes
$pdf->SetTextColor(0,0,200); // fixe la couleur du texte
$pdf->SetFont('Arial','B',14); // fixe la police, le type ( 'B' pour gras, 'I' pour italique, '' pour normal,...)
$pdf->MultiCell(60, 8, 'Mon texte", 0, 'L'); // imprime 'Mon texte' avec saut de ligne

Rappel : l'origine des fonctions setXY est le coin supérieur gauche de la page

Pour plus d'infos

Liste des méthodes TCPDF: https://tcpdf.org/docs/srcdoc/

Proposer son modèle via un module

Si le modèle fabriqué est destiné à être livré via un module extension de Dolibarr (voir la doc pour faire un module Dolibarr), le fichier modèle ne sera pas dans le même répertoire que les autres, et ne sera donc pas détecté automatiquement. Pour le rendre détectable vous devrez ajouter cette ligne dans la fonction d'initialisation de votre module externe :

sql=array("INSERT INTO ".MAIN_DB_PREFIX."document_model (nom, type, entity) VALUES('".$MODELNAME."','".$MODEL_TARGET_MODULE."',".$conf->entity." )");

avant

 return $this->_init($sql,$option);

Puis

Dans Accueil => Configuration => Modules => Module sur lequel porte le modèle => Configurer

activer votre module qui doit apparaître parmi ceux disponible
éventuellement le mettre en modèle proposé par défaut.