Dolibarr ERP CRM Wiki - User contributions [en]

Développement module

2016-10-27T08:30:06Z

Induslab: /* Créer et déclarer votre feuille de style */

[[Category:Noyau]]
{{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:
* 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 supprimer des onglets sur les pages de vues/édition des objets (facture, produit, commande, événement, ...)
* 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
etc...
Toutes ces opérations ne sont possibles qu'avec la version 3.2 ou plus de Dolibarr.

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.

= [[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/rdoursenaud/dolibarr-module-template GitHub Dolibarr Module Modèle]

= [[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.

== 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:
* 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)
Ensuite, modifier le contenu de ce fichier afin de remplacer:
* 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]].
* 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 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.

== 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.
{{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]

== 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 répertoire de votre module (par exemple '''htdocs/monmodule/sql''') afin d'y placer les scripts sql que vous allez créer.

Ensuite, vérifiez dans votre fichier descripteur de module, dans la fonction '''init''' que la ligne

<source lang="php">$this->_load_tables('/mymodule/sql/');</source>

n'est pas commentée.

''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/'''.
Exemple de contenu de fichier data.sql
<source lang="sql">
delete from llx_const where name='MONMODULE_IT_WORKS' and entity='__ENTITY__';
insert into llx_const (name, value, type, note, visible, entity) values ('MONMODULE_IT_WORKS','1','chaine','A constant for my module',1,'__ENTITY__');
</source>

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
<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.

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.

== Affichage des onglets (optionnel) ==

=== 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:
<source lang="php">
// Array to add new pages in new tabs or remove existing one
$this->tabs = array('objecttype:+tabname1:Title1:mylangfile@monmodule:$user->rights->monmodule->read:/monmodule/mapagetab1.php?id=__ID__' // To add a new tab identified by code tabname1
'objecttype:+tabname2:Title2:mylangfile@monmodule:$user->rights->monmodule->read:/monmodule/mapagetab2.php?id=__ID__', // To add a new tab identified by code tabname2
'objecttype:-tabname'); // To remove an existing tab identified by code tabname
</source>

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 ":"
* Partie 1: Le type d'élément (objecttype) dans lequel doit apparaître l'onglet qui est une valeur parmi celle-ci:
{{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 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 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 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
<source lang="php">require_once($url_fichier) ;</source>

Voici quelques examples de fichiers à inclure (DOL_DOCUMENT_ROOT correspond au dossier dolibarr/htdocs/) :
* Entité tiers (thirdparty) :
** DOL_DOCUMENT_ROOT/societe/class/societe.class.php
** DOL_DOCUMENT_ROOT/core/lib/company.lib.php
* Entité produit (product) :
** DOL_DOCUMENT_ROOT/product/class/product.class.php
** DOL_DOCUMENT_ROOT/core/lib/product.lib.php
* Entité facture (invoice) :
** 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'''

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 :''
<source lang="php">
$id=GETPOST('id','int');
$ref=GETPOST('ref','alpha');
$product = new Product($db) ;
$result = $product->fetch($id, $ref) ; //Tester $result pour vérifier que l'accès à la base s'est bien passée
</source>

'''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 :
<source lang="php">
$head // Tableau des onglets
$head[$h] // Élément décrivant un onglet. Il y aura autant de $h que d'onglets à afficher
$head[$h][0] // Url de la page affichée quand on clique sur l'onglet
$head[$h][1] // Titre de l’onglet
$head[$h][2] // Code de l'onglet, à utiliser pour choisir quel onglet sera 'actif' (voir paragraphe suivant)
</source>

''Exemple :''
<source lang="php">
$head = product_prepare_head($product, $user) ; //le paramètre $user n'est pas présent sur certaines fonctions
</source>

'''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().

<source lang="php">
dol_fiche_head($links, $active='0', $title='', $notab=0, $picto='')
//$links // Tableau des onglets, appelé $head plus haut.
//$active // Onglet actif (mettre le nom de l'onglet défini dans votre fichier de module, ou un nom contenu dans $head[$h][2]). Cet onglet sera mis en surbrillance
//$title // ?
//$notab // Mettre ce paramètre à 1 permet de ne pas afficher de zone bleue en dessous des onglets.
//$picto // Nom de l'image à utiliser au début de la barre des onglet. Les choix suivant sont possibles :
// product
// service
// company
</source>

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'':
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) ==
'''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 '''skeleton_page.php''' qui va servir de point de départ.
Modifier le fichier afin que le main.inc.php soit trouvés
<source lang="php">
$res=0;
if (! $res && file_exists("../main.inc.php")) $res=@include("../main.inc.php"); // to work if your module directory is into dolibarr root htdocs directory
if (! $res && file_exists("../../main.inc.php")) $res=@include("../../main.inc.php"); // to work if your module directory is into a subdir of root htdocs directory
if (! $res) die("Include of main fails");
</source>
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.

* 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 :''
<source lang="php">
dol_include_once('/monmodule/class/maclasse.class.php', 'MaClasse');
</source>

* L'appel des classes fournies en standard avec Dolibarr se fera par contre par le require_once directe avec la syntaxe suivante:
''Exemple :''
<source lang="php">
require_once DOL_DOCUMENT_ROOT.'/core/class/doli.class.php';
</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é).

=== 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 vôtres.
{{ToComplete}}

=== 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:

<source lang="php">
$db->begin(); // Debut transaction
$db->query("Ma requete insert, update ou delete");
$db->commit(); // Valide
ou $db->rollback() // Annule
</source>

Pour une lecture:

<source lang="php">
$resql=$db->query("Ma requete select");
if ($resql)
{
$num = $db->num_rows($resql);
$i = 0;
if ($num)
{
while ($i < $num)
{
$obj = $db->fetch_object($resql);
if ($obj)
{
// You can use here results
print $obj->field1;
print $obj->field2;
}
$i++;
}
}
}
</source>

=== 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 données 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:
<source lang="php">
$form=new Form($db);
$form->select_date('','mykey',0,0,0,"myform");
</source>
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:
<source lang="php">
$mydate = dol_mktime(12, 0 , 0, $_POST['mykeymonth'], $_POST['mykeyday'], $_POST['mykeyyear']);
print strftime('%A %d %B %Y', $mydate);
</source>

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

=== Créer 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''']]).
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).
<source lang="php">
$this->config_page_url = array("monmodule_setupapage.php");
</source>

=== Tester 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.

== 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 apparaîtront 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:
<source lang="php">
// Main menu entries
$this->menu = array(); // List of menus to add
$r=0;

// Add here entries to declare new menus
// Example to declare the Top Menu entry:
$this->menu[$r]=array( 'fk_menu'=>0, // Put 0 if this is a top menu
'type'=>'top', // This is a Top menu entry
'titre'=>'MonModule top menu',
'mainmenu'=>'monmodule',
'leftmenu'=>'monmodule',
'url'=>'/monmodule/pagetop.php',
'langs'=>'mylangfile', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
'position'=>100,
'enabled'=>'1', // Define condition to show or hide menu entry. Use '$conf->monmodule->enabled' if entry must be visible if module is enabled.
'perms'=>'1', // Use 'perms'=>'$user->rights->monmodule->level1->level2' if you want your menu with a permission rules
'target'=>'',
'user'=>2); // 0=Menu for internal users, 1=external users, 2=both
$r++;

// Example to declare a Left Menu entry:
$this->menu[$r]=array( 'fk_menu'=>'fk_mainmenu=xxx', // Use 'fk_mainmenu=xxx' or 'fk_mainmenu=xxx,fk_leftmenu=yyy' where xxx is mainmenucode and yyy is a leftmenucode of parent menu
'type'=>'left', // This is a Left menu entry
'titre'=>'MonModule left menu 1',
'mainmenu'=>'xxx',
'leftmenu'=>'yyy',
'url'=>'/monmodule/pagelevel1.php',
'langs'=>'mylangfile', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
'position'=>100,
'enabled'=>'1', // Define condition to show or hide menu entry. Use '$conf->monmodule->enabled' if entry must be visible if module is enabled.
'perms'=>'1', // Use 'perms'=>'$user->rights->monmodule->level1->level2' if you want your menu with a permission rules
'target'=>'',
'user'=>2); // 0=Menu for internal users,1=external users, 2=both
$r++;
</source>

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 apparaître (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
<source lang="php">
$this->rights_class = 'monmodule'
</source>
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.

<source lang="php">
$this->rights[$r][0] = 10001;
$this->rights[$r][1] = 'Libelle par défaut de ma permission';
$this->rights[$r][3] = 1;
$this->rights[$r][4] = 'action';
$this->rights[$r][5] = 'sousaction';
$r++;
</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][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 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:

<source lang="php">
if ($user->rights->monmodule->action->sousaction) ...
</source>

== 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:''
<source lang="php">
$this->boxes[0]['file']='mabox0.php@monmodule'
$this->boxes[0]['note']='Ma box 0'
...
$this->boxes[n]['file']='maboxn.php@monmodule'
$this->boxes[n]['note']='Ma box n'
</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''')

=== 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 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.

== 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
<source lang="php">
$this->module_parts = array('css' => array('/monmodule/css/monmodule.css.php'));
</source>

=== 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 :
<source lang="php">
require('../main.inc.php');
$morejs=array("/monmodule/js/monmodule.js");
llxHeader('','Titre','','','','',$morejs,'',0,0);
</source>

== 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_Dolibarr_vers_exterieur|Interfaces de Dolibarr vers l'exterieur]]
et [[Interfaces_Exterieur_vers_Dolibarr|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]].

= [[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".

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 =
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).
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 +):
<source lang="bash">
perl makepack-dolibarrmodule.pl
</source>
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é.

* 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">
tar -xvf monmodule.zip
</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 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).

= [[File:Art.png]] Validation/activation du module externe sur Dolistore =

Voir [[Module_Dolistore_Validation_Regles|Règles de Validation]]

Développement module

2016-10-24T15:06:41Z

Induslab: /* Créer une page écran PHP brute */

[[Category:Noyau]]
{{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:
* 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 supprimer des onglets sur les pages de vues/édition des objets (facture, produit, commande, événement, ...)
* 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
etc...
Toutes ces opérations ne sont possibles qu'avec la version 3.2 ou plus de Dolibarr.

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.

= [[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/rdoursenaud/dolibarr-module-template GitHub Dolibarr Module Modèle]

= [[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.

== 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:
* 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)
Ensuite, modifier le contenu de ce fichier afin de remplacer:
* 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]].
* 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 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.

== 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.
{{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]

== 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 répertoire de votre module (par exemple '''htdocs/monmodule/sql''') afin d'y placer les scripts sql que vous allez créer.

Ensuite, vérifiez dans votre fichier descripteur de module, dans la fonction '''init''' que la ligne

<source lang="php">$this->_load_tables('/mymodule/sql/');</source>

n'est pas commentée.

''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/'''.
Exemple de contenu de fichier data.sql
<source lang="sql">
delete from llx_const where name='MONMODULE_IT_WORKS' and entity='__ENTITY__';
insert into llx_const (name, value, type, note, visible, entity) values ('MONMODULE_IT_WORKS','1','chaine','A constant for my module',1,'__ENTITY__');
</source>

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
<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.

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.

== Affichage des onglets (optionnel) ==

=== 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:
<source lang="php">
// Array to add new pages in new tabs or remove existing one
$this->tabs = array('objecttype:+tabname1:Title1:mylangfile@monmodule:$user->rights->monmodule->read:/monmodule/mapagetab1.php?id=__ID__' // To add a new tab identified by code tabname1
'objecttype:+tabname2:Title2:mylangfile@monmodule:$user->rights->monmodule->read:/monmodule/mapagetab2.php?id=__ID__', // To add a new tab identified by code tabname2
'objecttype:-tabname'); // To remove an existing tab identified by code tabname
</source>

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 ":"
* Partie 1: Le type d'élément (objecttype) dans lequel doit apparaître l'onglet qui est une valeur parmi celle-ci:
{{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 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 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 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
<source lang="php">require_once($url_fichier) ;</source>

Voici quelques examples de fichiers à inclure (DOL_DOCUMENT_ROOT correspond au dossier dolibarr/htdocs/) :
* Entité tiers (thirdparty) :
** DOL_DOCUMENT_ROOT/societe/class/societe.class.php
** DOL_DOCUMENT_ROOT/core/lib/company.lib.php
* Entité produit (product) :
** DOL_DOCUMENT_ROOT/product/class/product.class.php
** DOL_DOCUMENT_ROOT/core/lib/product.lib.php
* Entité facture (invoice) :
** 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'''

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 :''
<source lang="php">
$id=GETPOST('id','int');
$ref=GETPOST('ref','alpha');
$product = new Product($db) ;
$result = $product->fetch($id, $ref) ; //Tester $result pour vérifier que l'accès à la base s'est bien passée
</source>

'''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 :
<source lang="php">
$head // Tableau des onglets
$head[$h] // Élément décrivant un onglet. Il y aura autant de $h que d'onglets à afficher
$head[$h][0] // Url de la page affichée quand on clique sur l'onglet
$head[$h][1] // Titre de l’onglet
$head[$h][2] // Code de l'onglet, à utiliser pour choisir quel onglet sera 'actif' (voir paragraphe suivant)
</source>

''Exemple :''
<source lang="php">
$head = product_prepare_head($product, $user) ; //le paramètre $user n'est pas présent sur certaines fonctions
</source>

'''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().

<source lang="php">
dol_fiche_head($links, $active='0', $title='', $notab=0, $picto='')
//$links // Tableau des onglets, appelé $head plus haut.
//$active // Onglet actif (mettre le nom de l'onglet défini dans votre fichier de module, ou un nom contenu dans $head[$h][2]). Cet onglet sera mis en surbrillance
//$title // ?
//$notab // Mettre ce paramètre à 1 permet de ne pas afficher de zone bleue en dessous des onglets.
//$picto // Nom de l'image à utiliser au début de la barre des onglet. Les choix suivant sont possibles :
// product
// service
// company
</source>

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'':
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) ==
'''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 '''skeleton_page.php''' qui va servir de point de départ.
Modifier le fichier afin que le main.inc.php soit trouvés
<source lang="php">
$res=0;
if (! $res && file_exists("../main.inc.php")) $res=@include("../main.inc.php"); // to work if your module directory is into dolibarr root htdocs directory
if (! $res && file_exists("../../main.inc.php")) $res=@include("../../main.inc.php"); // to work if your module directory is into a subdir of root htdocs directory
if (! $res) die("Include of main fails");
</source>
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.

* 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 :''
<source lang="php">
dol_include_once('/monmodule/class/maclasse.class.php', 'MaClasse');
</source>

* L'appel des classes fournies en standard avec Dolibarr se fera par contre par le require_once directe avec la syntaxe suivante:
''Exemple :''
<source lang="php">
require_once DOL_DOCUMENT_ROOT.'/core/class/doli.class.php';
</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é).

=== 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 vôtres.
{{ToComplete}}

=== 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:

<source lang="php">
$db->begin(); // Debut transaction
$db->query("Ma requete insert, update ou delete");
$db->commit(); // Valide
ou $db->rollback() // Annule
</source>

Pour une lecture:

<source lang="php">
$resql=$db->query("Ma requete select");
if ($resql)
{
$num = $db->num_rows($resql);
$i = 0;
if ($num)
{
while ($i < $num)
{
$obj = $db->fetch_object($resql);
if ($obj)
{
// You can use here results
print $obj->field1;
print $obj->field2;
}
$i++;
}
}
}
</source>

=== 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 données 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:
<source lang="php">
$form=new Form($db);
$form->select_date('','mykey',0,0,0,"myform");
</source>
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:
<source lang="php">
$mydate = dol_mktime(12, 0 , 0, $_POST['mykeymonth'], $_POST['mykeyday'], $_POST['mykeyyear']);
print strftime('%A %d %B %Y', $mydate);
</source>

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

=== Créer 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''']]).
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).
<source lang="php">
$this->config_page_url = array("monmodule_setupapage.php");
</source>

=== Tester 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.

== 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 apparaîtront 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:
<source lang="php">
// Main menu entries
$this->menu = array(); // List of menus to add
$r=0;

// Add here entries to declare new menus
// Example to declare the Top Menu entry:
$this->menu[$r]=array( 'fk_menu'=>0, // Put 0 if this is a top menu
'type'=>'top', // This is a Top menu entry
'titre'=>'MonModule top menu',
'mainmenu'=>'monmodule',
'leftmenu'=>'monmodule',
'url'=>'/monmodule/pagetop.php',
'langs'=>'mylangfile', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
'position'=>100,
'enabled'=>'1', // Define condition to show or hide menu entry. Use '$conf->monmodule->enabled' if entry must be visible if module is enabled.
'perms'=>'1', // Use 'perms'=>'$user->rights->monmodule->level1->level2' if you want your menu with a permission rules
'target'=>'',
'user'=>2); // 0=Menu for internal users, 1=external users, 2=both
$r++;

// Example to declare a Left Menu entry:
$this->menu[$r]=array( 'fk_menu'=>'fk_mainmenu=xxx', // Use 'fk_mainmenu=xxx' or 'fk_mainmenu=xxx,fk_leftmenu=yyy' where xxx is mainmenucode and yyy is a leftmenucode of parent menu
'type'=>'left', // This is a Left menu entry
'titre'=>'MonModule left menu 1',
'mainmenu'=>'xxx',
'leftmenu'=>'yyy',
'url'=>'/monmodule/pagelevel1.php',
'langs'=>'mylangfile', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
'position'=>100,
'enabled'=>'1', // Define condition to show or hide menu entry. Use '$conf->monmodule->enabled' if entry must be visible if module is enabled.
'perms'=>'1', // Use 'perms'=>'$user->rights->monmodule->level1->level2' if you want your menu with a permission rules
'target'=>'',
'user'=>2); // 0=Menu for internal users,1=external users, 2=both
$r++;
</source>

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 apparaître (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
<source lang="php">
$this->rights_class = 'monmodule'
</source>
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.

<source lang="php">
$this->rights[$r][0] = 10001;
$this->rights[$r][1] = 'Libelle par défaut de ma permission';
$this->rights[$r][3] = 1;
$this->rights[$r][4] = 'action';
$this->rights[$r][5] = 'sousaction';
$r++;
</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][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 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:

<source lang="php">
if ($user->rights->monmodule->action->sousaction) ...
</source>

== 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:''
<source lang="php">
$this->boxes[0]['file']='mabox0.php@monmodule'
$this->boxes[0]['note']='Ma box 0'
...
$this->boxes[n]['file']='maboxn.php@monmodule'
$this->boxes[n]['note']='Ma box n'
</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''')

=== 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 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.

== 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
<source lang="php">
$this->module_parts = array('css' => array('/monmodule/css/monmodule.css.php'));
</source>

=== 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 :
<source lang="php">
require('../main.inc.php');
$morejs=array("/monmodule/js/monmodule.js");
llxHeader('','Titre','','','','',$morejs,'',0,0);
</source>

== 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_Dolibarr_vers_exterieur|Interfaces de Dolibarr vers l'exterieur]]
et [[Interfaces_Exterieur_vers_Dolibarr|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]].

= [[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".

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 =
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).
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 +):
<source lang="bash">
perl makepack-dolibarrmodule.pl
</source>
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é.

* 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">
tar -xvf monmodule.zip
</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 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).

= [[File:Art.png]] Validation/activation du module externe sur Dolistore =

Voir [[Module_Dolistore_Validation_Regles|Règles de Validation]]

List of modules id

2016-10-19T11:45:40Z

Induslab: /* ID 100000 - 499999 */

[[Category:Core]]
{{TemplateDocDevEn}}
{{TemplateDocDevEs}}
{{TemplateDocDevFr}}

{{Flag en}} This page list all reserved modules numbers / ID. If you build or want to build your own modules (like this [[:Category:Complementary_modules|complementary module]]), you should take an ID range here.

{{Flag fr}} Cette page recense tous les numéros / ID réservés de modules. Si vous avez réalisé ou voulez réaliser vos propres modules (comme les [[:Category:Modules complémentaires|modules complémentaires suivant]]), vous devriez prendre une plage d'ID ici.

{{Flag sp}} Esta página contiene un listado de todos los id reservados para los módulos. Si ha creado o quiere realizar sus propios módulos, (como estos [[:Category:Módulos_complementarios|módulos complementarios]]), deberá reservarse un rango de ID aquí.

= ID 0 - 99999 =
{{Flag en}} Reserved for Dolibarr's internal modules.

{{Flag fr}} Réservé aux modules internes de Dolibarr.

{{Flag sp}} Reservado a los módulos internos de Dolibarr.

= ID 100000 - 499999 =
{{Flag en}} Reserved area for editors in need for an ID range. You can edit this page to add your own range (limited to 1000 values per editor)

{{Flag fr}} Zone réservé aux éditeurs qui ont besoin d'une plage d'ID spécifiques. Vous pouvez modifier cette page pour réserver votre plage (limité à 1000 valeurs par éditeur)

{{Flag sp}} Área reservada para los partners que necesiten un rango de ID. Puede modificar esta página para reservar su rango (limitado a 1000 valores por editor)

* ID 100000 - 100999: OpenThink (http://www.openthink.be)
* ID 101000 - 101999: NLTechno (http://www.nltechno.com)
* ID 102000 - 102999: Tiaris (http://www.tiaris.fr)
* ID 103000 - 103999: Open-concept.pro (http://www.open-concept.pro)
* ID 104000 - 104999: ATM Consulting (http://www.atm-consulting.fr)
* ID 105000 - 105999: GPC.solutions
* ID 106000 - 106999: PHPASSO
* ID 107000 - 107999: TecLib (http://www.teclib.com) / Auguria (http://www.auguria.net)
* ID 108000 - 108999: ETHICWEB
* ID 109000 - 109999: Aplose (http://www.aplose.fr)
* ID 110000 - 110999: Aternatik
* ID 111000 - 111999: Asset IT (www.assetit.ch)
* ID 112000 - 112999: Aarboard AG (www.aarboard.ch)
* ID 113000 - 113999: Asilib - Alexandre Spangaro
* ID 114000 - 114999: Iceleaf OÜ
* ID 115000 - 115999: 2A2C Conseil - Cyril ZEKSER
* ID 116000 - 116999: Wolftec GmbH
* ID 117000 - 117999: Oscim (http://www.oscim.fr)
* ID 118000 - 118999: Oarces Web (dev.oarces.com)
* ID 119000 - 119999: Manuel Berrocal - Absolacom
* ID 120000 - 120999: Régis Houssin (http://www.inodbox.com)
* ID 121000 - 121999: Oscss - Shop
* ID 122000 - 122999: MrSof - la Nation du Web
* ID 123000 - 123999: Bruno Généré (webiseasy.org)
* ID 124000 - 124999: backbone internet service (www.backbone.co.at)
* ID 125000 - 125999: ProgSI (www.progsi.ma)
* ID 126000 - 126999: Catalanet
* ID 130000 - 130999: Technicks ICT (http://www.technicks.eu)
* ID 140000 - 140999: Altairis
* ID 150000 - 150999: Jeffinfo
* ID 160000 - 160999: Charles-François BENKE (http://www.patas-monkey.com)
* ID 162000 - 162999: Jacques Rébiscoul
* ID 190000 - 190999: Diciannove (http://19.coop)
* ID 199000 - 199999: RFMS
* ID 200000 - 200999: Noxiome
* ID 201000 - 201999: Sasa Ostrouska (saxa)
* ID 202000 - 202999: Z-Application
* ID 203000 - 203099: Elidee - elidee.com
* ID 203100 - 203999: Garcia MICHEL (soamichel.fr)
* ID 204000 - 204999: Ari Elbaz elarifr - accedinfo.com
* ID 205000 - 205999: Kreiz IT
* ID 206000 - 206999: GBINFO (www.gbinfo.fr)
* ID 300000 - 300999: AtooNet (http://www.atoo-net.com)
* ID 400000 - 400999: 2byte.es (http://www.2byte.es)
* ID 401000 - 401999: B&D Informática
* ID 402000 - 402999: Marcos García de La Fuente (marcosgdf)
* ID 403000 - 403999: Sergibyte (http://www.sergibyte.com)
* ID 404000 - 404999: Aikhan
* ID 405000 - 405999: AIME (http://www.aime.mx)
* ID 420000 - 420099: BBS Concept
* ID 420100 - 420199: LeMousticProduction (www.lemousticproduction.info) -< module DoliRH
* ID 420200 - 421199: VatCheck (www.abnc.be)
* ID 422200 - 422999: Artaban (http://artaban.fr)
* ID 423000 - 423050: cyberesprit
* ID 424000 - 424999: A3sys - Mon-Dolibarr (http://www.mon-dolibarr.fr)
* ID 425000 - 425999: Sébastien SERRE Thivinfo (www.thivinfo.com)
* ID 426000 - 426099: Arkesis-Solution
* ID 426100 - 426149: GetLandy (www.getlandy.com)
* ID 426150 - 426649: OOB Software
* ID 426650 - 426849: Soft-Task Serviços e Sistemas (www.soft-task.com.br)
* ID 426850 - 427000: Bruno Caldas (https://github.com/BCaldas)
* ID 427001 - 427999: Kevin GUERRIER (alias xcl.saian)
* ID 428000 - 428099: af83
* ID 429000 - 429999: induslab

= ID > 500000 =
{{Flag en}} If you don't already have reserved ids and need some, please don't use hazardous number and use a number higher than 500000, but it is better to ask a wiki account, and reserve your own range by editing the 100000 - 499999 range (1000 ids maximum per partner).

{{Flag fr}} Si vous n'avez pas de numéros réservés et en avez besoin, n'utilisez pas de chiffres au hasard et utilisez une valeur supérieure à 500000, toutefois, il est préférable d'obtenir un compte wiki, et réserver vous-même votre plage en ajoutant votre entrée dans la zone 100000 - 499999 (pas plus de 1000 numéros par partenaire).

{{Flag sp}} Si no dispone de número reservado y necesita, no use cifras redondeadas y usa un valor superior a 500000. Si tiene una cuenta wiki, puede reservarse usted mismo sus id añadiendo su entrada en la zona 100000 - 499999 (no más de 1000 id por partner).