Développement module

Pour créer un nouveau module, il existe plusieurs étapes. Ce didacticiel a pour but de vous décrire chacune d'elle afin d'ajouter un module permettant d'étendre les possibilités de Dolibarr, comme par exemple ajouter une ou plusieurs des fonctionnalités suivantes: etc... Toutes ces opérations ne sont possibles qu'avec la version 3.2 ou plus de Dolibarr.
 * Ajouter de nouvelles tables en base
 * Ajouter vos propres entrées dans les menus
 * Ajouter des écrans de saisie/consultation de nouvelle tables
 * Ajouter ou suppimer des onglets sur les pages de vues/édition des objets (facture, produit, commande, évenement, ...)
 * Ajouter des exports prédéfinis pour la fonction export
 * Ajouter de nouvelles boites pour la home page
 * Ajouter des variables de substitutions
 * Définir de nouvelles permissions
 * Déclencher du code automatiquement sur une action Dolibarr particulière
 * Insérer votre code aux emplacement hooks de Dolibarr
 * Ajouter un module de numérotation
 * Ajouter un modèle de document
 * Ajouter un nouveau thème

Les chapitres suivants vous présentent comment réaliser tout cela en manuel de manière simple. Pour les développeurs très expérimentés, une méthode par génération MDA est en cours de mise au point. Voir le dernier chapitre pour cela.

= Exemple de modéle de module externe=

Un bon modéle de module externe Dolibarr est disponible ici : GitHub Dolibarr Module Modèle

= Créer un module = Les sous chapitres suivant décrivent les actions à faire pour créer un module Dolibarr. Les premiers chapitres sont obligatoires quelle que soit la vocation du module, les suivants dépendront de ce que doit faire le module.

Créer un descripteur de Module (obligatoire)
Quand: Obligatoire dès qu'une extension est développée, quelle que soit sa vocation (sauf pour l'ajout de thème ou de modèle de document).

Créer votre descripteur
La première étape est donc de créer un fichier de description du module (descripteur). Pour cela: Ensuite, modifier le contenu de ce fichier afin de remplacer:
 * Créer le répertoire /htdocs/monmodule/core/modules. Puis, aller dans le répertoire dev/skeletons et recopier le fichier modMyModule.class.php dans ce répertoire htdocs/monmodule/core/modules.
 * Renommez le fichier modMyModule.class.php en modifiant seulement la partie MyModule (le fichier doit commencer par mod)
 * les modMyModule en une valeur qui corresponde a la vocation de votre module. Cette valeur doit toujours commencer par 'mod' et ne contenir que des caractères alphabétiques.
 * $this->numero = 100000 par un numéro de module libre. Pour éviter tout conflit, vous pouvez consulter la page suivante pour retrouver les numéros déjà alloués: Liste des id de modules.
 * Modifier éventuellement les autres variables définies dans le constructeurs (Voir le commentaire dans le code du squelette pour leur signification).

Le descripteur de votre module est alors en place.

Tester votre descripteur
Lancer Dolibarr et aller sur la page Configuration->module, vous devez voir apparaitre une nouvelle ligne avec votre nouveau module et la possibilité de l'activer ou non (parcourez tous les onglets de chaque catégories de modules jusqu'à le retrouver). C'est la valeur de $this->special qui détermine dans quel onglet se trouve votre module.

Arborescence d'un nouveau module
Voici l'arborescence à respecter pour l'organisation des fichiers d'un module.

Rem: Seule la deuxième ligne est obligatoire.

Un modèle de module a été crée par un contributeur Dolibarr, il est accessible ici :

Créer vos tables SQL et les classes PHP DAO (optionnel)
Quand: Si votre module a besoin de gérer des données qui lui sont propres

Créer vos fichiers .sql
Si votre module a vocation à gérer des données bien à lui, qui n'existent pas en base dans la version standard de Dolibarr, il est nécessaire de définir des tables SQL pour stocker ces données.

Créer un sous-répertoire sql dans le repertoire de votre module (par exemple htdocs/monmodule/sql) afin d'y placer les scripts sql que vous allez créer.

Règles à respecter: Exemple de contenu de fichier data.sql
 * Ajouter les fichiers d'ordre de création de vos tables sur le principe d'un fichier llx_matable.sql par table accompagné éventuellement du fichier llx_matable.key.sql (voir les fichiers existants dans install/mysql/tables pour exemple).
 * Pour ce qui est des commandes pour ajouter/manipuler des données, elles doivent toutes se trouver dans un fichier nommé data.sql situé dans le même répertoire /monmodule/sql/.

Les ordres SQL des fichiers doivent être opérationnels pour la base de données mysql. Rem: Les fichiers des autres bases ne sont pas à maintenir. Ils sont lus et convertit à la volée par le driver de la base de données.

Tester vos fichier .sql
Une fois les fichiers prêts, vous pouvez retourner sous Dolibarr puis désactiver le module, dropper les tables en base et réactiver le module. Les tables doivent alors être recréées par l'activation du module. Si tel n'est pas le cas, vérifiez vos scripts en les passant à la main, ou consultez les logs Dolibarr.

Générer la classe PHP DAO d'accès aux tables
Une fois votre ou vos tables créées en base, aller dans le répertoire dev/skeletons, copiez le fichier build_class_from_table.php dans le répertoire sql/ de votre module, et lancez le script Remarque: Si la commande ne fonctionne pas, essayer d'utiliser php-cli plutot que php.

Ceci génèrera un fichier out.nomtable.class.php qui contient la classe de gestion de la table nomtable. Dans cette classe, se trouve des méthodes CRUD (Create/Read/Update/Delete) déjà opérationnelles pour faire un insert, un fetch (select), un update, un delete d'une ligne de la table. Supprimer juste le "out" du nom de fichier et placer votre fichier dans le sous-répertoire de htdocs propre à votre module (Dans htdocs/monmodule par exemple).

Un fichier out.nomtable_script.php a également été généré et contient un exemple de code pour utiliser la classe pour chacune des 4 méthodes CRUD.

Ajouter ou supprimer des onglets sur les fiches objets
Quand : Pour ajouter votre propre onglet parmi les onglets standard d'une fiche entité (facture, commande, proposition commercial, adhérent...)

Pour cela, aller dans le fichier descripteur de module précédemment créé et modifier le tableau $this->tabs:

Le tableau doit contenir une liste de chaîne, chaque chaîne représentant un nouvel onglet. Le format de la chaîne étant composé de 5 parties séparées par ":"
 * Partie 1: Le type d'élément (objecttype) dans lequel doit apparaître l'onglet qui est une valeur parmi celle-ci:


 * Partie 2: Nom de code pour l'onglet à ajouter (commence par +) ou à enlever (commence par -)
 * Partie 3: Le titre de l'onglet. Cela peut être un libellé en dur ou mieux un code traduction présent dans un fichier lang.
 * Partie 4: Le nom du fichier .lang (sans l'extension .lang) qui contient la correspondance entre le code traduction et le libellé à afficher. Si ce com est précédé de @, Dolibarr cherche le fichier dans le répertoire lang propre au module, c'est à dire htdocs/monmodule/langs/code_CODE/monmodule.lang, sinon Dolibarr cherche le fichier traduction dans htdocs/langs/code_CODE/monmodule.lang
 * Partie 5: L'url de la page à afficher quand on clique sur l'onglet. La chaine __ID__ sera remplacée automatiquement par l'Id de l'entité concernée.

Pour alimenter le contenu de l'onglet avec des données issues de la base, voir le chapitre suivant.

Ajouter les onglets standard d'un objet sur sa propre page
Quand : Pour afficher les onglets standard d'une fiche entité (produit, tiers, etc.) sur votre propre page onglet d'une entité.

Il faut appliquer la procédure suivante :

1. Inclure les fichiers définissant les fonctions utiles dans vos fichiers

Pour chaque fiche entité, il y a deux fichiers à inclure avec l'instruction

Voici la liste de ces fichiers (DOL_DOCUMENT_ROOT correspond au dossier dolibarr/htdocs/) :
 * Entité tiers (thirdparty) :
 * DOL_DOCUMENT_ROOT/societe.class.php
 * DOL_DOCUMENT_ROOT/lib/company.lib.php
 * Entité produit (product) :
 * DOL_DOCUMENT_ROOT/product.class.php
 * DOL_DOCUMENT_ROOT/lib/product.lib.php
 * Entité facture (invoice) :
 * DOL_DOCUMENT_ROOT/facture.class.php
 * DOL_DOCUMENT_ROOT/lib/invoice.lib.php

2. Créer et charger l'objet à afficher dans votre onglet

Créer l'objet de la classe voulue, et récupérer les données de l'objet à partir de la base de données. Pour cela il faut utiliser les fonctions fetch de la classe correspondante, en passant en paramètre l'identifiant de l'objet que vous récupérez depuis l'url (ex : /mononglet.php?id=1).

Exemple :

3. Récupérer la liste des onglets correspondants à l'entité choisie

Utiliser la fonction XXX_prepare_head($obj), ou XXX est le nom de l'entité, permettant de créer un tableau contenant les définitions des onglets à afficher. Le paramètre à passer est l'objet pour lequel vous voulez afficher les onglets.

Le tableau retourné est composé de la façon suivante :

Exemple :

4. Afficher les onglets sur votre page onglet

Utiliser la fonction dol_fiche_head qui affiche les onglets contenus dans le tableau $head retourné par XX_prepare_head.

Cette fonction affiche les onglets voulus et ouvre un élément   qui correspond à la zone bleue sous les onglets (si paramètre $notab = 0). Pour fermer la zone bleue, il suffit de fermer l'élément < /div > dans le code PHP.

Remarque: Pour plus de détail, se référer à la documentation Doxygen ou directement au code de Dolibarr.

Créer vos pages écran PHP (optionnel)
Quand: Si l'objet de votre module est d'ajouter des fonctionnalités qui nécessitent de nouveaux écrans.

Créer une page écran PHP brute
Vous pouvez ensuite créer vos pages PHP, qui se basent sur les données de vos tables, en utilisant les squelettes fournis comme exemple dans le répertoire dev/skeletons (Pour le développement d'un script en ligne de commande, voir Développement de scripts).

Pour créer une nouvelle page écran utilisateur, créer un sous-répertoire de htdocs (si non déjà fait) propre à votre module (Dans htdocs/monmodule par exemple) afin d'y placer les pages que vous aller créer.

Y recopier le fichier skeletons_page.php qui va servir de point de départ. Modifier le fichier afin que le main.inc.php soit trouvés Notez qu'il est possible que vous deviez ajouter plus de "../" dans les chemin, en fonction de la profondeur de vos fichiers par rapport au répertoire de votre module.

Pour tous les modules développés après la version 3.2 de Dolibarr, il convient de pouvoir placer un répertoire de module soit dans htdocs soit dans un sous répertoire comme htdocs/custom sans avoir à modifier le code source du module, c'est pour cela que cette règle doit obligatoirement être appliquée.

C'est dans le main qu'est chargé l'environnement technique ainsi que les habilitations. Les variables objets suivantes sont alors positionnées:


 * $user   L'objet qui contient les caractéristiques de l'utilisateur + ses droits.
 * $conf   L'objet qui contient la configuration de Dolibarr.
 * $db     L'objet qui contient le handler de connexion ouvert à la base de données.
 * $langs  L'objet qui contient la langue de l'utilisateur.

Exemple :
 * L'inclusion d'une classe ou librairie dédiée au module, sans savoir d'où le fichier sera appelé, se fait en utilisant une fonction de Dolibarr (et non en utilisant directement le include_once)

Exemple :
 * L'appel des classes de dolibarr utilisent la syntaxe suivante;

Remplacer les parties d'écrans templatés (version 3.3+)
Certaines portion d'écran de Dolibarr sont isolés dans des fichiers templates. Vous pouvez développer un module pour remplacer un ou plusieurs de ces templates par les votres.

Accès à la base
Si vous avez besoin de réaliser des modifications en base dans votre propre table ajoutée, utilisez la classe générée plus haut qui contient les méthodes pour cela.

Si toutefois vous voulez faire des accès dans des tables sans objet PHP dédié, ceci reste possible (par exemple pour récupérer une liste d'enregistrement). Dans ce cas, pensez à suivre ces exemples:

Pour un insert, update ou delete:

Pour une lecture:

Définition du style
Pour que le look de la page soit aligné avec le thème Dolibarr, il est nécessaire d'utiliser les styles des CSS de Dolibarr.

Par exemple:


 * class="liste_titre" sur les balises tr et td pour une ligne de titre de tableau.
 * class="pair" ou class="impair" sur les balises tr et td des lignes de donnees de tableau.
 * class="flat" sur tous les champs de saisie (input, select, textarea...).
 * class="button" sur les objets de type input type="submit".

Utiliser le sélecteur de date de Dolibarr
Si vous le désirez, vous pouvez profiter du sélecteur de date dans des écrans Dolibarr. Pour cela, utilisez la ligne suivante: La chaine mykey identifie la zone date. Il faut y mettre une valeur différente s'il y a plusieurs zones. La chaine myform est le nom de la zone FORM (dans form name="myform" de la page HTML). L'affichage d'un sélecteur de date doit donc être intégrée dans une zone FORM Html.

Pour récupérer la valeur, à l'issu du POST, la commande est:

Définir votre page de configuration (optionnel)
Quand: Si votre module offre plusieurs options paramétrables.

Creer votre page d'édition de configuration
Si votre module offre plusieurs options paramétrables, il est nécessaire de créer une page PHP pour éditer les options (qui sont stockées dans la table llx_const). Créer une page PHP nommée monmodule_setupapage.php qui affiche les options possibles et les met à jour. Il est nécessaire de prendre exemple sur une page dans /admin qui vous montre la méthode pour lire ou sauvegarder en base votre option. Placer cette page de configuration dans le répertoire /admin également. Ensuite dans le descripteur de module, modifier la variable pour indiquer le nom de cette page PHP (sans le chemin qui n'est pas nécessaire, la page étant forcément dans le rep admin).

Tester votre page
Allez sur la page Configuration->module, vous devez voir apparaitre une icône qui permet d'accéder à la page de configuration et vous devez être capable de modifier ces options et les voir conservées en base.

Définir vos entrées de menu (optionnel)
Quand: Si vous avez créé des pages PHP, il est nécessaire que ces écrans soient accessibles depuis le menu Dolibarr.

Définissez vos entrées menus
Pour cela, il vous faut définir dans le fichier descripteur de module, le tableau this->menu qui déclare les menus. Ce tableau contient toutes les entrées qui apparaitront dans les menus une fois le module activé. Le fichier de descripteur de module exemple modMonModule.class.php possède un exemple de déclaration de menu haut ainsi que de ses entrées menu gauche associées.

Voici un exemple de déclaration d'entrées de menu dans le fichier descripteur:

Pour conditionner l'accès au menu selon des permission, modifier la propriété perms du tableau. Voir le chapitre sur les permissions un peu plus loin pour savoir comment ajouter des permissions.

Tester vos entrées menus
Désactiver et réactiver votre module sous Dolibarr, les entrées menus doivent alors apparaitre (si la condition dans 'enabled' est vraie).

Définir vos propres permissions (optionnel)
Quand: Si vous voulez ajouter de nouvelles permissions.

La définition des permissions que gèrera votre module se fait dans le fichier descripteur créé dans la première étape. Modifier la ligne pour y mettre la bonne valeur de monmodule.

Ensuite remplissez le tableau $this->rights avec autant d'entrées que de permissions différentes à gérer.

Dans $this->rights[$r][0], mettre un id de permission non déjà pris (Voir dans le menu Infos Système sur une installation de Dolibarr opérationnelle pour connaitre les id déjà utilisés. Dans $this->rights[$r][3], mettre 1 si cette permission est attribué d'office par défaut quand un utilisateur est créé. Dans $this->rights[$r][1], mettre un libellé par défaut (il sera affiché si aucune traduction n'est trouvé pour votre permission dans le fichier admin.lang). Dans $this->rights[$r][4] et $this->rights[$r][5], mettre une chaine action et sousaction sans espaces. Vous pourrez alors tester dans le code PHP si un utilisateurs a bien les droits par la séquence suivante:

Définir vos propres box (optionnel)
Quand: Si votre module amène avec lui une ou plusieurs Boxes.

Définissez vos box
Pour cela, modifiez les tableaux $this->boxes du fichier descripteur de module. Il suffit d'ajouter 2 lignes par fichier box que vous allez créer dans le répertoire htdocs/monmodule/core/boxes

Exemple:

Ensuite créer les fichiers htdocs/monmodule/core/boxes/mabox0.php, htdocs/monmodule/core/boxes/mabox1.php... en prenant exemple sur des box existantes (exemple dans le répertoire htdocs/core/boxes)

Tester la présence de vos box dans Dolibarr
Désactiver et réactiver le module.

Aller dans le menu Accueil - Configuration - Boite.

Vos box doivent apparaitre dans la liste des box activables. Activer les puis aller sur la page d'accueil et vérifier qu'elles s'affichent correctement.

Définir vos propres exports (optionnel)
Quand: Si votre module amène avec lui des exports prédéfini de données (pour ces propres tables ou des tables déjà existante d'un autre module de Dolibarr).

Définissez l'export
Pour cela, décommenter et modifier les tableaux $this->export_xxx du votre fichier descripteur de module.

Tester votre export
Aller dans le menu outils -> export de Dolibarr. Votre export doit apparaitre dans la liste des exports prédéfinis disponible (si votre module est bien activé). Le choisir, vous devez alors voir les champs possible définis dans le tableau à l'étape précédente. Choisir quelques champs et tenter une génération du fichier export.

Définir vos styles CSS (optionnel)
Quand: Si dans vos écrans PHP, vous utiliser des classes de styles qui ne sont pas celle des thèmes de Dolibarr (non recommandé).

Cette fonctionnalité est décrite mais pas encore opérationnel en 2.4

Créer et déclarer votre feuille de style
Créer un fichier de style css nommé monmodule.css ou monmodule.css.php et le placer dans le répertoire monmodule dans htdocs. Il ne peut y avoir qu'un fichier css propre à chaque module. Rappelons qu'il vaut mieux utiliser les styles déjà existant de Dolibarr (le fichier css utilisé par Dolibarr étant le fichier themes/nomtheme/nomtheme.css.php. Ne créer un fichier css propre à votre module que si vous devez absolument gérer des styles non déjà existants. Une fois votre feuille de style prête, déclarer la dans votre fichier descripteur de module en modifiant la propriété $this->module_parts. La valeur à renseigner ici doit être le chemin relatif de l'URL de votre fichier css. Par exemple

Tester votre feuille de style
Désactiver et réactiver votre module.

Appelez la page d'accueil de Dolibarr. Afficher la source de la page HTML.

Vous devriez voir dans l'entête HTML, une ligne déclarant votre feuille de style.

Définir vos fonctions Javascript (optionnel)
Quand: Si dans vos écrans PHP, vous utiliser des fonctions javascript non dispo en standard (fichier lib_head.js)

Si dans vos écrans PHP, vous utilisez des fonctions javascript, il est nécessaire de faire en sorte que vos fonctions déclarées dans un fichier javascript htdocs/monmodule/js/monmodule.js soit chargées dans l'entête head html. Pour demander à Dolibarr qui gère la génération de la section header d'inclure un de vos fichiers javascript, il est nécessaire de fournir en paramètre de la fonction llxHeader appelée au début de votre page, d'inclure le paramètre qui contient l'URL vers le js à inclure.

Exemple pour la page /htdocs/monmodule/mapage.php :

Déclencher du code sur un évènement Dolibarr (optionnel)
Quand: Si vous voulez que des actions particulières s'exécutent suite au déclenchement d'actions standards de Dolibarr (exemple: je veux mettre à jour une table de mon module quand une facture se crée dans Dolibarr), il vous faut créer un fichier de triggers.

Voir aussi Interfaces de Dolibarr vers l'exterieur et Interfaces exterieures vers Dolibarr

Insérer votre code aux emplacement hooks de Dolibarr (optionnel)
Quand: Quand vous voulez modifier ou ajouter du code autrement que lors d'un évènement métier (voir le chapitre précédent pour cela).

Voir la page Système de Hooks.

Ajouter un module de numérotation (optionnel)
Quand: Lorsque vous voulez ajouter une règle de numérotation non couverte par les modules par défaut.

Voir la page Créer un module de numérotation.

Ajouter un nouveau modèle de document (optionnel)
Quand: Lorsque vous voulez ajouter un nouveau modèle de document.

La documentation au sujet de la génération de documents depuis des modèles est disponible sur la page Créer un modèle de document PDF ou Créer un modèle de document ODT.

Ajouter un thème (optionnel)
Quand: Lorsque vous voulez une interface aux couleurs personnalisées à votre cas.

Voir la page Themes.

= Quelques règles de codage et fonctions pour développeurs = Les règles de codage à suivre sont définis dans la Documentation développeur, rubrique "Informations Générales - Langage et normes de développement".

De nombreuses fonctions prédéfinies pour les développeurs sont disponibles et décrites sur la page Documentation développeur sous la section "Les couches techniques de Dolibarr".

= Utilisation du MDA = Une méthode pour générer un module fonctionnel depuis l'UML est en cours de mise au point. Plus d'informations sur la page UML2Dolibarr - Générer un module par MDA.

= Créer un package pour livrer et installer votre module = Cette procédure doit être utilisé pour fabriquer un package afin de le soumettre sur la place de marché http://www.dolistore.com. Mais vous pouvez aussi l'utiliser pour distribuer facillement votre module via votre propre réseau de distribution.

Saisissez dans ce fichier la liste des noms des nouveaux fichiers que vous avez créé pour votre module (descripteur de module, nouveaux fichiers sql de tables, page php, images, etc...)
 * Aller dans le répertoire /build et recopier le fichier makepack-dolibarrmodules.conf en makepack-monmodule.conf. Attention, ce répertoire peut ne pas être fourni dans les packages de versions stables. Si c'est le cas, il peut être récupéré dans le snapshot disponible en téléchargement sur le site web Dolibarr dans la rubrique Version de développement (prendre dans ce cas tout le répertoire build qui est un répertoire autonome et indépendant de la version).

Le script vous demande le nom de votre module, sa version majeure et mineure. Un fichier monmodule.zip va alors être fabriqué contenant votre module prêt pour être déployé.
 * Lancer le script via Perl (besoin de la version Perl 5.0 ou +):


 * La personne qui reçoit votre module doit alors placer le fichier dans son répertoire racine d'installation de Dolibarr et réaliser la commande:


 * Si vous désirez que votre module profite à tous, vous pouvez le soumettre (le fichier zip) sur la place de marché des modules complémentaires: (vous devez avoir créer un compte auparavant et utiliser le lien "Soumettre un module/produit").
 * Si votre module a été fabriqué correctement, le fichier sera validé rapidement.
 * Si la qualité est suffisante, que la licence le permet et que la fonctionnalité du module s'avère être d'un intérêt général, le code pourra être ajouté au code source de Dolibarr (sauf si vous ne le désirez pas).

= Validation/activation du module externe sur Dolistore =

Voir Régles de Validation