2
edits
Changes
Jump to navigation
Jump to search
mLine 1:
Line 1: + + + + + + + + + + − + − + − + − + − + − + − + − + − + − + − + − + − + − + + + − Toutes ces opérations ne sont possibles qu'avec la version 3.2 ou plus de Dolibarr. − + + + + − = [[File:Art.png]] Création de Module avec le module builder=+ − Depuis Dolibarr 7.0.0 il est possible de créer la page principale de votre module avec le "module builder". − Pour l'activer, vous devez mettre la variable MAIN_FEATURES_LEVEL à 2 ( Configuration / Divers ) + − [[File:Mod_builer_1.png|200px|thumb|left|MAIN_FEATURES_LEVEL à 2]]]+ − puis cliquez sur l'icone "bug" qui est apparue à coté du bouton imprimé (en haut à gauche)+ − + − + − + − + + + + + + + + + + + + + + + + − + − + − + − + − + − + − + + + + − + − Lancer Dolibarr et aller sur la page '''Configuration->module''', vous devez voir apparaître 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).+ − + − le nom de votre module NE DOIT PAS CONTENIR le caractère underscore ou tiret bas : _+ − + Line 64:
Line 95: − + − + − + Line 81:
Line 112: − + − + − + + + + Line 91:
Line 125: − + − + Line 99:
Line 133: − + − + − + Line 111:
Line 145: − + − + − + Line 126:
Line 160: − + + − + − + − + − + − + + Line 138:
Line 174: − + Line 148:
Line 184: − + − + − + − + − + − + − + − + − + − + + − 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).+ Line 173:
Line 210: − 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.+ Line 191:
Line 228: − Utiliser la fonction dol_fiche_head() qui affiche les onglets contenus dans le tableau $head retourné par XX_prepare_head().+ Line 207:
Line 244: − + − + − + − + − + − Modifier le fichier afin que le main.inc.php soit trouvés+ Line 225:
Line 262: − + Line 236:
Line 273: − 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.+ − + − + − + − + + + − * 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) Line 253:
Line 291: − + + − + − + − + − + − + Line 279:
Line 318: − + Line 304:
Line 343: − + − + − + − + − + − + − + Line 321:
Line 360: − + − + Line 331:
Line 370: − + − + − + − Créer une page PHP nommée '''monmodule_setupapage.php''' qui affiche les options possibles et les met à jour.+ − Placer cette page de configuration dans le répertoire '''/admin''' également.+ − + − + − + − + − + Line 395:
Line 434: − + − + − + Line 419:
Line 458: − + − + Line 428:
Line 467: − + − + − + − + Line 444:
Line 483: − + − + − Désactiver et réactiver le module.+ − Aller dans le menu '''Accueil - Configuration - Boite'''.+ − + − + − + − + − + − + − 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é).+ − + − Choisir quelques champs et tenter une génération du fichier export.+ − + − + − + − 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.+ − + − + Line 479:
Line 518: − + − Désactiver et réactiver votre module.+ − + − + − + Line 499:
Line 538: − + − + − + − + − + − + − + − + − + − + − + − 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]].+ + − = [[File:Art.png]] 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. − * 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). − + + Line 547:
Line 585: − + + − + − + − + − + − − − − [[File:https://wiki.dolibarr.org/upload/7/72/FRDéveloppement_module.pdf]] − − − [[File:https://wiki.dolibarr.org/upload/4/45/Module_timesheet_2.0.pdf]]
Corrections orthographiques
<!-- BEGIN interlang links -->
<!-- Do NOT edit this section
Links below are automatically managed by PolyglotBot
You can edit links on the English source page : Module_development -->
[[en:Module_development]]
[[es:Desarrollo_de_un_módulo]]
[[de:Modul_Entwicklung]]
[[zh:模块开发]]
<!-- END interlang links -->
[[Category:Noyau]]
[[Category:Noyau]]
{{TemplateDocDev}}
{{TemplateDocDev}}
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:
Pour créer un nouveau module, il existe plusieurs étapes. Ce didacticiel a pour but de vous décrire chacune d'elles afin d'ajouter un module permettant d'étendre les possibilités de Dolibarr, comme par exemple ajouter une ou plusieurs des fonctionnalités suivantes:
* Ajouter de nouvelles tables en base
* Ajouter vos propres entrées dans les menus
*Ajouter de nouvelles tables en base
* Ajouter des écrans de saisie/consultation de nouvelle tables
*Ajouter vos propres entrées dans les menus
* Ajouter ou supprimer des onglets sur les pages de vues/édition des objets (facture, produit, commande, événement, ...)
*Ajouter des écrans de saisie/consultation de nouvelle tables
* Ajouter des exports prédéfinis pour la fonction export
*Ajouter ou supprimer des onglets sur les pages de vues/édition des objets (facture, produit, commande, événement, ...)
* Ajouter de nouvelles boites pour la home page
*Ajouter des exports prédéfinis pour la fonction export
* Ajouter des variables de substitutions
*Ajouter de nouvelles boites pour la home page
* Définir de nouvelles permissions
*Ajouter des variables de substitution
* Déclencher du code automatiquement sur une action Dolibarr particulière
*Définir de nouvelles permissions
* Insérer votre code aux emplacement hooks de Dolibarr
*Déclencher du code automatiquement sur une action Dolibarr particulière
* Ajouter un module de numérotation
*Insérer votre code aux emplacements hooks de Dolibarr
* Ajouter un modèle de document
*Ajouter un module de numérotation
* Ajouter un nouveau thème
*Ajouter un modèle de document
*Ajouter un nouveau thème
etc...
etc...
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.
Les chapitres suivants vous présentent comment réaliser tout cela en manuel de manière simple.
=[[File:Art.png]] Création de Module avec le générateur de module=
Depuis Dolibarr 9.0 il est possible de créer les fichiers principaux de votre module avec le "Générateur de module" (aussi appelé "Module Builder"). Pour l'activer :
*Activez le module "Générateur de Module" dans la section "Outils multi-modules"
[[File:Mod_builder_2.png|400px]]
*puis cliquez sur l’icône "bug" qui est apparue dans la barre de menu en haut à droite
[[File:Mod_builder_3.png|400px]]
= [[File:Art.png]] Exemple de modèle de module externe=
=[[File:Art.png]] Exemple de modèle de module externe=
Un bon modéle/squelette de module externe Dolibarr est disponible ici : [https://github.com/Dolibarr/dolibarr/tree/develop/htdocs/modulebuilder/template GitHub Dolibarr Module Modèle]
Un bon modéle/squelette de module externe Dolibarr est disponible ici : [https://github.com/Dolibarr/dolibarr/tree/develop/htdocs/modulebuilder/template GitHub Dolibarr Module Modèle]
= [[File:Art.png]] Créer un module =
=[[File:Art.png]] 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.
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) ==
==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).
'''Quand''' : Obligatoire dès qu'une extension est développée, quelle que soit sa vocation (sauf pour l'ajout de thèmes ou de modèles de documents).
'''Depuis Dolibarr 9.0, il est possible de créer le descripteur de votre module avec le "Générateur de module"'''
===Créer votre descripteur avec le générateur de module===
*Lancez le générateur de module en cliquant sur l’icône "bug"
[[File:Mod_builder_3.png|400px]]
*Entrez le nom de votre module sans espaces (le nom de votre module NE DOIT PAS CONTENIR le caractère underscore ou tiret bas : _)
[[File:Mod_builder_4.png|400px]]
*Vous pourrez alors modifier les paramètres du descriptif du module :
[[File:Mod_builder_5.png|400px]]
=== Créer votre descripteur ===
===Alternative : créer votre descripteur manuellement (sans utiliser le générateur de module)===
La première étape est donc de créer un fichier de description du module (descripteur). Pour cela:
La première étape est donc de créer un fichier de description du module (descripteur). Pour cela:
* 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 mod'''MyModule'''.class.php en modifiant seulement la partie '''MyModule''' (le fichier doit commencer par mod)
*Créez le répertoire '''/htdocs/''monmodule''/core/modules'''. Puis, allez dans le répertoire '''dev/skeletons''' et recopiez le fichier modMyModule.class.php dans ce répertoire '''htdocs/''monmodule''/core/modules'''.
Ensuite, modifier le contenu de ce fichier afin de remplacer:
*Renommez le fichier mod'''MyModule'''.class.php en modifiant seulement la partie '''MyModule''' (le fichier doit commencer par mod)
* les ''modMyModule'' en une valeur qui corresponde à 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: [[List of modules id|Liste des id de modules]].
Ensuite, modifiez le contenu de ce fichier afin de remplacer :
* Modifier éventuellement les autres variables définies dans le constructeurs (Voir le commentaire dans le code du squelette pour leur signification).
*les ''modMyModule'' en une valeur qui corresponde à la vocation de votre module. Cette valeur doit toujours commencer par '<nowiki/>'''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 : [[List of modules id|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.
Le descripteur de votre module est alors en place.
=== Tester votre descripteur ===
===Tester votre descripteur===
Lancez Dolibarr et allez sur la page '''Configuration->module''', vous devez voir apparaître 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.
C'est la valeur de $this->special qui détermine dans quel onglet se trouve votre module.
=== Nom de module ===
===Nom de module===
Le nom de votre module NE DOIT PAS CONTENIR le caractère underscore ou tiret bas : _
== Arborescence d'un nouveau module ==
==Arborescence d'un nouveau module==
Voici l'arborescence à respecter pour l'organisation des fichiers d'un module.
Voici l'arborescence à respecter pour l'organisation des fichiers d'un module.
{{TemplateModuleTreeSimple}}
{{TemplateModuleTreeSimple}}
Un modèle de module a été crée par un contributeur Dolibarr, il est accessible ici : [https://github.com/rdoursenaud/dolibarr-module-template]
Un bon modèle/squelette de module externe Dolibarr est disponible ici : [https://github.com/Dolibarr/dolibarr/tree/develop/htdocs/modulebuilder/template GitHub Dolibarr Module Modèle]
== Créer vos tables SQL et les classes PHP DAO (optionnel) ==
==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
'''Quand''': Si votre module a besoin de gérer des données qui lui sont propres
=== Créer vos fichiers .sql ===
===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.
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.
''Règles à respecter:''
''Règles à respecter:''
* 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/'''.
*Ajoutez 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).
* N'utilisez pas "chaine" mais 'chaine' car les guillemets doubles (") ont une signification particulière en PostGreSQL
*Les types et noms recommandés pour les champs SQL sont définis sur la page [[https://wiki.dolibarr.org/index.php/Langages_et_normes#R.C3.A8gles_de_codage_SQL]].
*Pour ce qui est des commandes permettant d'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/'''.
*N'utilisez pas "chaine" mais 'chaine' car les guillemets doubles (") ont une signification particulière en PostGreSQL
Exemple de contenu de fichier data.sql
Exemple de contenu de fichier data.sql
<source lang="sql">
<source lang="sql">
Les ordres SQL des fichiers doivent être opérationnels pour la base de données '''mysql'''.
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.
Rem: Les fichiers des autres bases ne sont pas à maintenir. Ils sont lus et convertis à la volée par le driver de la base de données.
=== Tester vos fichier .sql ===
===Tester vos fichiers .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.
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.
Si tel n'est pas le cas, vérifiez vos scripts en les passant à la main, ou consultez les logs Dolibarr.
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 ===
===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
Une fois votre ou vos tables créées en base, allez 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
<source lang="bash">php build_class_from_table.php nomtable</source>
<source lang="bash">php build_class_from_table.php nomtable</source>
Remarque: Si la commande ne fonctionne pas, essayer d'utiliser php-cli plutot que php.
Remarque : Si la commande ne fonctionne pas, essayez 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.
Ceci génèrera un fichier '''out.nomtable.class.php''' qui contient la classe de gestion de la table nomtable.
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.
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.
== Affichage des onglets (optionnel) ==
==Affichage des onglets (optionnel)==
=== Ajouter ou supprimer des onglets sur les fiches objets ===
===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...)
'''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:
Pour cela, allez dans le fichier descripteur de module précédemment créé et modifiez le tableau $this->tabs:
<source lang="php">
<source lang="php">
// Array to add new pages in new tabs or remove existing one
// Array to add new pages in new tabs or remove existing one
Le tableau doit contenir une liste de chaîne, chaque chaîne représentant un nouvel onglet.
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 6 parties séparées par ":"
Le format de la chaîne étant composé de 6 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 1 : le type d'élément (objecttype) dans lequel doit apparaître l'onglet qui est une valeur parmi celle-ci:
{{TemplateModuleTabs-fr}}
{{TemplateModuleTabs-fr}}
* 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 2 : nom de code pour l'onglet à ajouter (commence par +) ou à enlever (commence par -)
* 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 suivi de @monmodule, 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/mylangfile.lang
*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 5: Une condition à tester pour savoir si l'onglet doit être visible ou pas. Mettre '1' pour qu'il soit toujours visible.
*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 suivi de @monmodule, 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/mylangfile.lang
* Partie 6: 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.
*Partie 5 : une condition à tester pour savoir si l'onglet doit être visible ou pas. Mettre '1' pour qu'il soit toujours visible.
*Partie 6 : 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 que la déclaration soit effective, il faut désactiver et réactiver le module.
Pour que la déclaration soit effective, il faut désactiver et réactiver le module.
Pour alimenter le contenu de l'onglet avec des données issues de la base, voir le chapitre suivant.
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 ===
===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é.
'''Quand''' : Pour afficher les onglets standard d'une fiche entité (produit, tiers, etc.) sur votre propre page onglet d'une entité.
<source lang="php">require_once($url_fichier) ;</source>
<source lang="php">require_once($url_fichier) ;</source>
Voici quelques examples de fichiers à inclure (DOL_DOCUMENT_ROOT correspond au dossier dolibarr/htdocs/) :
Voici quelques exemples de fichiers à inclure (DOL_DOCUMENT_ROOT correspond au dossier dolibarr/htdocs/) :
* Entité tiers (thirdparty) :
** DOL_DOCUMENT_ROOT/societe/class/societe.class.php
*Entité tiers (thirdparty) :
** DOL_DOCUMENT_ROOT/core/lib/company.lib.php
**DOL_DOCUMENT_ROOT/societe/class/societe.class.php
* Entité produit (product) :
**DOL_DOCUMENT_ROOT/core/lib/company.lib.php
** DOL_DOCUMENT_ROOT/product/class/product.class.php
*Entité produit (product) :
** DOL_DOCUMENT_ROOT/core/lib/product.lib.php
**DOL_DOCUMENT_ROOT/product/class/product.class.php
* Entité facture (invoice) :
**DOL_DOCUMENT_ROOT/core/lib/product.lib.php
** DOL_DOCUMENT_ROOT/compta/facture/facture.class.php
*Entité facture (invoice) :
** DOL_DOCUMENT_ROOT/core/lib/invoice.lib.php
**DOL_DOCUMENT_ROOT/compta/facture/facture.class.php
**DOL_DOCUMENT_ROOT/core/lib/invoice.lib.php
'''2. Créer et charger l'objet à afficher dans votre onglet'''
'''2. Créer et charger l'objet à afficher dans votre onglet'''
Créez l'objet de la classe voulue, et récupérez 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 :''
''Exemple :''
'''3. Récupérer la liste des onglets correspondants à l'entité choisie'''
'''3. Récupérer la liste des onglets correspondants à l'entité choisie'''
Utilisez 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 :
Le tableau retourné est composé de la façon suivante :
'''4. Afficher les onglets sur votre page onglet'''
'''4. Afficher les onglets sur votre page onglet'''
Utilisez la fonction dol_fiche_head() qui affiche les onglets contenus dans le tableau $head retourné par XX_prepare_head().
<source lang="php">
<source lang="php">
Cette fonction affiche les onglets voulus et ouvre un élément ''< div class="" >'' 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.
Cette fonction affiche les onglets voulus et ouvre un élément ''< div class="" >'' 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'':
''Remarque'' :
Pour plus de détail, se référer à la [http://www.dolibarr.fr/doxygen/ documentation Doxygen] ou directement au code de Dolibarr.
Pour plus de détail, se référer à la [http://www.dolibarr.fr/doxygen/ documentation Doxygen] ou directement au code de Dolibarr.
== Créer vos pages écran PHP (optionnel) ==
==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.
'''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 ===
===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 '''modulebuilder''' (Pour le développement d'un script en ligne de commande, voir [[Développement de scripts]]).
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 '''modulebuilder''' (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.
Pour créer une nouvelle page écran utilisateur, créez 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 allez créer.
Y recopier le fichier '''myobject_page.php''' qui va servir de point de départ.
Y recopier le fichier '''myobject_page.php''' qui va servir de point de départ.
Modifiez le fichier afin que le main.inc.php soit trouvé
<source lang="php">
<source lang="php">
// Load Dolibarr environment
// Load Dolibarr environment
// Try main.inc.php into web root known defined into CONTEXT_DOCUMENT_ROOT (not always defined)
// Try main.inc.php into web root known defined into CONTEXT_DOCUMENT_ROOT (not always defined)
if (! $res && ! empty($_SERVER["CONTEXT_DOCUMENT_ROOT"])) $res=@include($_SERVER["CONTEXT_DOCUMENT_ROOT"]."/main.inc.php");
if (! $res && ! empty($_SERVER["CONTEXT_DOCUMENT_ROOT"])) $res=@include($_SERVER["CONTEXT_DOCUMENT_ROOT"]."/main.inc.php");
// Try main.inc.php into web root detected using web root caluclated from SCRIPT_FILENAME
// Try main.inc.php into web root detected using web root calculated from SCRIPT_FILENAME
$tmp=empty($_SERVER['SCRIPT_FILENAME'])?'':$_SERVER['SCRIPT_FILENAME'];$tmp2=realpath(__FILE__); $i=strlen($tmp)-1; $j=strlen($tmp2)-1;
$tmp=empty($_SERVER['SCRIPT_FILENAME'])?'':$_SERVER['SCRIPT_FILENAME'];$tmp2=realpath(__FILE__); $i=strlen($tmp)-1; $j=strlen($tmp2)-1;
while($i > 0 && $j > 0 && isset($tmp[$i]) && isset($tmp2[$j]) && $tmp[$i]==$tmp2[$j]) { $i--; $j--; }
while($i > 0 && $j > 0 && isset($tmp[$i]) && isset($tmp2[$j]) && $tmp[$i]==$tmp2[$j]) { $i--; $j--; }
if (! $res) die("Include of main fails");
if (! $res) die("Include of main fails");
</source>
</source>
Comme vous pouvez le constater, plusieurs tentatives de chargement du fichier main.inc.php (ou master.inc.php) ont été tentées. Le but est de réussir dans le plus grand nombre de cas possibles. Le minimum est de 2 lignes: une pour essayer de charger le fichier master / main.inc.php dans le répertoire racine de dolibarr et une autre pour essayer de charger le fichier afin de prendre en charge le cas où le module est déployé dans le répertoire "custom". Mais vous pouvez avoir à gérer plus de situations. L'exemple fourni devrait pouvoir charger le fichier main / master.inc.php dans presque toutes les situations / configurations.
Notez que vous pouvez ajouter plus "../" en fonction de la profondeur du fichier par rapport à l'arborescence de votre module.
C'est dans le main qu'est chargé l'environnement technique ainsi que les habilitations. Les variables objets suivantes sont alors positionnées:
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.
*$user L'objet qui contient les caractéristiques de l'utilisateur + ses droits.
* $conf L'objet qui contient la configuration de Dolibarr.
*$conf L'objet qui contient la configuration de Dolibarr.
* $db L'objet qui contient le handler de connexion ouvert à la base de données.
*$db L'objet qui contient le handler de connexion à la base de données.
* $langs L'objet qui contient la langue de l'utilisateur.
*$langs L'objet qui contient la langue de l'utilisateur.
*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 :''
''Exemple :''
<source lang="php">
<source lang="php">
</source>
</source>
* L'appel des classes fournies en standard avec Dolibarr se fera par contre par le require_once directe avec la syntaxe suivante:
*L'appel des classes fournies en standard avec Dolibarr se fera par contre par le require_once directe avec la syntaxe suivante:
''Exemple :''
''Exemple :''
<source lang="php">
<source lang="php">
require_once DOL_DOCUMENT_ROOT.'/core/class/doli.class.php';
require_once DOL_DOCUMENT_ROOT.'/core/class/doli.class.php';
</source>
</source>
La raison est que si le dol_include_once est pratique car il scanne chaque répertoire de chemin alternatifs pour trouver le fichier, il est aussi moins performant car génère des accès et recherches disque à chaque appel (en effet, PHP intègre un cache des fichiers lus mais n'intègre pas un cache des fichiers "non trouvés". Et comme un fichier donné n'est que dans une seule arborescence, il y a toujours une arborescence alternative où il ne se trouve pas et qui génère des accès superflus au disque dur, pénalisant en terme de performance. Comme pour les fichiers internes à Dolibarr, on connait toujours le chemin exacte, le require_once avec ce chemin direct doit être préféré).
La raison est que si le dol_include_once est pratique car il scanne chaque répertoire de chemin alternatif pour trouver le fichier, il est aussi moins performant car génère des accès et recherches disque à chaque appel (en effet, PHP intègre un cache des fichiers lus mais n'intègre pas un cache des fichiers "non trouvés". Et comme un fichier donné n'est que dans une seule arborescence, il y a toujours une arborescence alternative où il ne se trouve pas et qui génère des accès superflus au disque dur, pénalisant en terme de performance. Comme pour les fichiers internes à Dolibarr, on connait toujours le chemin exacte, le require_once avec ce chemin direct doit être préféré).
=== Remplacer les parties d'écrans templatés (version 3.3+) ===
===Remplacer les parties d'écrans templatés (version 3.3+)===
Certaines portion d'écran de Dolibarr sont isolés dans des fichiers templates.
Certaines portions d'écran de Dolibarr sont isolées dans des fichiers templates.
Vous pouvez développer un module pour remplacer un ou plusieurs de ces templates par les vôtres.
Vous pouvez développer un module pour remplacer un ou plusieurs de ces templates par les vôtres.
{{ToComplete}}
{{ToComplete}}
=== Accès à la base ===
===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 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:
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 un insert, update ou delete :
<source lang="php">
<source lang="php">
</source>
</source>
Pour une lecture:
Pour une lecture :
<source lang="php">
<source lang="php">
</source>
</source>
=== Définition du style ===
===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.
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:
Par exemple :
* class="'''liste_titre'''" sur les balises ''tr'' et ''td'' pour une ligne de titre de tableau.
*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 données de tableau.
*class="'''pair'''" ou class="'''impair'''" sur les balises ''tr'' et ''td'' des lignes de données de tableau.
* class="'''flat'''" sur tous les champs de saisie (''input, select, textarea''...).
*class="'''flat'''" sur tous les champs de saisie (''input, select, textarea''...).
* class="'''button'''" sur les objets de type ''input type="submit"''.
*class="'''button'''" sur les objets de type ''input type="submit"''.
=== Utiliser le sélecteur de date de Dolibarr ===
===Utilisez 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:
Si vous le désirez, vous pouvez profiter du sélecteur de date dans des écrans Dolibarr. Pour cela, utilisez la ligne suivante:
<source lang="php">
<source lang="php">
$form->select_date('','mykey',0,0,0,"myform");
$form->select_date('','mykey',0,0,0,"myform");
</source>
</source>
La chaine mykey identifie la zone date. Il faut y mettre une valeur différente s'il y a plusieurs zones.
La chaîne 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).
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.
L'affichage d'un sélecteur de date doit donc être intégré dans une zone FORM Html.
Pour récupérer la valeur, à l'issu du POST, la commande est:
Pour récupérer la valeur, à l'issu du POST, la commande est:
</source>
</source>
== Définir votre page de configuration (optionnel) ==
==Définir votre page de configuration (optionnel)==
'''Quand''': Si votre module offre plusieurs options paramétrables.
'''Quand''' : si votre module offre plusieurs options paramétrables.
=== Créer votre page d'édition de configuration ===
===Créez 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|table '''llx_const''']]).
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|table '''llx_const''']]).
Créez 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.
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.
Placez 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).
Ensuite dans le descripteur de module, modifiez 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).
<source lang="php">
<source lang="php">
$this->config_page_url = array("monmodule_setupapage.php");
$this->config_page_url = array("monmodule_setupapage.php");
</source>
</source>
=== Tester votre page ===
===Testez votre page===
Allez sur la page '''Configuration->module''', vous devez voir apparaître 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.
Allez sur la page '''Configuration->module''', vous devez voir apparaître 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) ==
==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.
'''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 ===
===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.
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 apparaîtront dans les menus une fois le module activé.
Ce tableau contient toutes les entrées qui apparaîtront dans les menus une fois le module activé.
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.
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 ===
===Testez vos entrées menus===
Désactiver et réactiver votre module sous Dolibarr, les entrées menus doivent alors apparaître (si la condition dans 'enabled' est vraie).
Désactiver et réactiver votre module sous Dolibarr, les entrées menus doivent alors apparaître (si la condition dans 'enabled' est vraie).
== Définir vos propres permissions (optionnel) ==
==Définir vos propres permissions (optionnel)==
'''Quand''': Si vous voulez ajouter de nouvelles permissions.
'''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.
La définition des permissions que gérera votre module se fait dans le fichier descripteur créé dans la première étape.
</source>
</source>
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][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 connaître 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][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][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 chaîne 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:
Dans $this->rights[$r][4] et $this->rights[$r][5], mettre une chaîne action et sous action sans espace. Vous pourrez alors tester dans le code PHP si un utilisateurs a bien les droits par la séquence suivante :
<source lang="php">
<source lang="php">
</source>
</source>
== Définir vos propres box (optionnel) ==
==Définir vos propres box (optionnel)==
'''Quand''': Si votre module amène avec lui une ou plusieurs Boxes.
'''Quand''' : si votre module amène avec lui une ou plusieurs Boxes.
=== Définissez vos box ===
===Définissez vos box===
Pour cela, modifiez les tableaux $this->boxes du fichier descripteur de module.
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'''
Il suffit d'ajouter 2 lignes par fichier box que vous allez créer dans le répertoire '''htdocs/monmodule/core/boxes'''
''Exemple:''
''Exemple :''
<source lang="php">
<source lang="php">
$this->boxes[0]['file']='mabox0.php@monmodule'
$this->boxes[0]['file']='mabox0.php@monmodule'
</source>
</source>
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''')
Ensuite créez 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 ===
===Testez la présence de vos box dans Dolibarr===
Désactivez et réactivez le module.
Allez dans le menu '''Accueil - Configuration - Boite'''.
Vos box doivent apparaître dans la liste des box activables. Activer les puis aller sur la page d'accueil et vérifier qu'elles s'affichent correctement.
Vos box doivent apparaître dans la liste des box activables. Activez les puis allez sur la page d'accueil et vérifiez qu'elles s'affichent correctement.
== Définir vos propres exports (optionnel) ==
==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).
'''Quand''' : si votre module amène avec lui des exports prédéfinis de données (pour ces propres tables ou des tables déjà existantes d'un autre module de Dolibarr).
=== Définissez l'export ===
===Définissez l'export===
Pour cela, décommenter et modifier les tableaux $this->export_xxx du votre fichier descripteur de module.
Pour cela, décommentez et modifiez les tableaux $this->export_xxx du votre fichier descripteur de module.
=== Tester votre export ===
===Testez votre export===
Allez dans le menu outils -> export de Dolibarr. Votre export doit apparaitre dans la liste des exports prédéfinis disponibles (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.
Le choisir, vous devez alors voir les champs possibles définis dans le tableau à l'étape précédente.
Choissez quelques champs et tentez une génération du fichier export.
== Définir vos styles CSS (optionnel) ==
==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é).
'''Quand''' : lorsque 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
Cette fonctionnalité est décrite mais pas encore opérationnel en 2.4
=== Créer et déclarer votre feuille de style ===
===Créez et déclarez votre feuille de style===
Créez un fichier de style css nommé '''monmodule.css''' ou '''monmodule.css.php''' et placez le 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.
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éez 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'''.
Une fois votre feuille de style prête, déclarez 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.
La valeur à renseigner ici doit être le chemin relatif de l'URL de votre fichier css.
Par exemple
Par exemple
</source>
</source>
=== Tester votre feuille de style ===
===Testez votre feuille de style===
Désactivez et réactivez votre module.
Appelez la page d'accueil de Dolibarr. Afficher la source de la page HTML.
Appelez la page d'accueil de Dolibarr. Affichez la source de la page HTML.
Vous devriez voir dans l'entête HTML, une ligne déclarant votre feuille de style.
Vous devriez voir dans l'entête HTML, une ligne déclarant votre feuille de style.
== Définir vos fonctions Javascript (optionnel) ==
==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)
'''Quand''' : lorsque 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.
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.
</source>
</source>
== Déclencher du code sur un évènement Dolibarr (optionnel) ==
==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'''.
'''Quand''' : lorsque 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_Dolibarr_vers_exterieur|Interfaces de Dolibarr vers l'exterieur]]
Voir aussi [[Interfaces_Dolibarr_vers_exterieur|Interfaces de Dolibarr vers l'exterieur]]
et [[Interfaces_Exterieur_vers_Dolibarr|Interfaces exterieures vers Dolibarr]]
et [[Interfaces_Exterieur_vers_Dolibarr|Interfaces exterieures vers Dolibarr]]
== Insérer votre code aux emplacement hooks de Dolibarr (optionnel) ==
==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).
'''Quand''' : lorsque 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]].
Voir la page [[Système de Hooks]].
== Ajouter un module de numérotation (optionnel) ==
==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.
'''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]].
Voir la page [[Créer un module de numérotation]].
== Ajouter un nouveau modèle de document (optionnel) ==
==Ajouter un nouveau modèle de document (optionnel)==
'''Quand''': Lorsque vous voulez ajouter un nouveau modèle de document.
'''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]].
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) ==
==Ajouter un thème (optionnel)==
'''Quand''': Lorsque vous voulez une interface aux couleurs personnalisées à votre cas.
'''Quand''': Lorsque vous voulez une interface aux couleurs personnalisées à votre cas.
Voir la page [[Themes]].
Voir la page [[Themes]].
= [[File:Art.png]] Quelques règles de codage et fonctions pour développeurs =
=[[File:Art.png]] Quelques règles de codage et fonctions pour développeurs=
Les règles de codage à suivre sont définis dans la [[Documentation Développeur|Documentation développeur]], rubrique "Informations Générales - Langage et normes de développement".
Les règles de codage à suivre sont définis dans la [[Documentation Développeur|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|Documentation développeur]] sous la section "Les couches techniques de Dolibarr".
De nombreuses fonctions prédéfinies pour les développeurs sont disponibles et décrites sur la page [[Documentation Développeur|Documentation développeur]] sous la section "Les couches techniques de Dolibarr".
= [[File:Art.png]] Utilisation du MDA =
=[[File:Art.png]] Créer un package pour livrer et installer votre module=
Cette procédure doit être utilisée 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.
*Allez dans le répertoire '''/build''' et recopiez 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 (prenez dans ce cas tout le répertoire build qui est un répertoire autonome et indépendant de la version).
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...)
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...)
* Lancer le script via Perl (besoin de la version Perl 5.0 ou +):
*Lancer le script via Perl (besoin de la version Perl 5.0 ou +):
<source lang="bash">
<source lang="bash">
perl makepack-dolibarrmodule.pl
perl makepack-dolibarrmodule.pl
Un fichier '''monmodule.zip''' va alors être fabriqué contenant votre module prêt pour être déployé.
Un fichier '''monmodule.zip''' va alors être fabriqué contenant votre module prêt pour être déployé.
* 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:
*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 :
<source lang="bash">
<source lang="bash">
tar -xvf monmodule.zip
tar -xvf monmodule.zip
</source>
</source>
* 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: {{LinkToPluginDownload}} (vous devez avoir créer un compte auparavant et utiliser le lien "Soumettre un module/produit").
*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: {{LinkToPluginDownload}} (vous devez avoir créé un compte auparavant et utiliser le lien "Soumettre un module/produit").
** Si votre module a été fabriqué correctement, le fichier sera validé rapidement.
**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).
**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).
= [[File:Art.png]] Validation/activation du module externe sur Dolistore =
=[[File:Art.png]] Validation/activation du module externe sur Dolistore=
Voir [[Module_Dolistore_Validation_Regles|Règles de Validation]]
Voir [[Module_Dolistore_Validation_Regles|Règles de Validation]]