Dolibarr ERP CRM Wiki - User contributions [en]

FAQ Développeur

2010-02-10T16:51:08Z

Dmartin: /* Récupérer/mettre à jour la version CVS de développement */ Ajout lien vers configuration Eclipse pour CVS

[[Category:FAQ FR]]
{{TemplateDocDev}}

= Comment devenir développeur officiel =

Dans la galaxie du projet Dolibarr, il existe plusieurs intervenants de différents niveaux/grades.
Le nombre de développeurs et contributions est important, hors tout projet qui veut atteindre un certains niveau de qualité se doit d'avoir une gestion contrôlée et des modifications validées des évolutions, aussi bien au niveau des besoins fonctionnels que du code.
Pour cette raison, les accès en écriture sur les sources (serveur CVS) sont limités et régies par une organisation qui est décrite dans les lignes qui suivent.
Chaque développeur a un '''grade''' qui dépend de son ancienneté et de ces contributions passées. Le niveau d'habilitations d'une personne sur le projet augmente avec les étapes de promotion de grade.

Le cursus d'un développeur Dolibarr passe donc par ces étapes, que l'on classe par un titre familié aux adeptes de sciences fictions. Voici ces étapes.
Il est important de comprendre que cette organisation a pour seul but d'améliorer la qualité de Dolibarr et qu'il est nécessaire qu'elle soit rigoureusement respectée afin d'attendre ce but. Ne soyez donc pas offensé si, en tant que développeur, vous ne pouvez disposer d'un accès CVS en écriture avant un certain délai.

Les grades des contributeurs au projet Dolibarr sont les suivants:

== * Soldat ==

La première chose qu'une personne désireuse d'aider doit faire et d'abord se familiariser avec les règles et normes de développements.
En lisant toute la [[Documentation Développeur]], vous faites preuve de volonté suffisante pour devenir automatiquement '''Soldat''' (Votre grade est au niveau '''Soldat'''). Et tout lire, c'est pas le plus facile...

Ce grade s'obtient sans validation supérieure. C'est un grade de principe, de départ.

Compte tenu du grade, il n'est pas possible d'établir une liste de tous les acteurs du projet Dolibarr ayant ce grade (liste en perpétuelle évolution).

== * Chasseur ==

L'étape suivante consiste à soumettre des patch, en commençant par des simples, soit sur la Mailing List dev (voir [[FAQ_D%C3%A9veloppeur#Soumettre_un_patch.2C_am.C3.A9lioration_ou_participer_au_d.C3.A9veloppement|FAQ Développeur]] pour la procédure), soit sur le forum (Mailing List préférée).

Vous pouvez trouver de taches en attente de patch sur le gestionnaire de taches à faire:
http://savannah.nongnu.org/task/?group=dolibarr

Les taches sembles pour commencer sont les taches qui possède la propriété "Task opened to external developers" à "oui". Si la valeur est "non", oubliez la, cela signifie qu'elle sera traité par un développeur de grade Jedi.

A votre première soumission acceptée (incluse dans le CVS par un Amiral, Jedi ou Yoda), vous entrez alors automatiquement dans la famille des '''Chasseurs''' de l'alliance Dolibarr.

Le nombre de chasseurs n'est pas limité. Plus, il y en aura, plus on sera fort.
Les chasseurs représentent la force vive principale de l'alliance Dolibarr.

La liste des acteurs Dolibarr avec ce grade est disponible sur la page [[:Category:Chasseur]]

== * Z-6PO ==

Si vous parlez couramment une langue non ou mal traduite dans Dolibarr, un '''Jedi''' ou '''Yoda''' peut attribuer, à votre compte Savannah, les droits d'écriture directement dans les sources CVS du projet (Voir [[FAQ_D%C3%A9veloppeur#R.C3.A9cup.C3.A9rer.2Fmettre_.C3.A0_jour_la_version_CVS_de_d.C3.A9veloppement|Récupérer/mettre à jour la version CVS de développement]] pour savoir comment les utiliser). Ce droit ne doit toutefois être utiliser qu'à condition qu'il soit limité à des objectifs de traductions.
Ce grade peut donc s'obtenir assez vite.

La liste des acteurs Dolibarr avec ce grade est disponible sur la page [[:Category:Z-6PO]]

== * Amiral ==

Ce n'est qu'au bout d'un temps variable (qui peut être très long) au rang de Chasseur, et si de nombreux patch de qualité satisfaisante ont été envoyée, qu'un Yoda en place vous autorisera à réaliser des commits CVS pour un motif étendu de la traduction à tout correctif.
Vous êtes devenu un '''Amiral''' de l'alliance Dolibarr.

Ce titre ne se demande pas, il s'obtient par décision ou proposition d'un '''Jedi''' ou '''Yoda''' qui estime que vous avez soumis suffisamment de patch pour être un sérieux '''Amiral'''.
L'accès CVS d'un '''Amiral''' doit cependant n'être utilisé que pour commiter soit des traductions, soit des corrections de bugs déclarées sur Savannah ou le forum (que ces corrections soient personnelles ou issues d'un patch soumis par un '''Chasseur''').
Tout commit CVS doit ainsi obligatoirement inclure, dans la description (le champ log de commit), le numéro du bug Savannah corrigé OU le titre du message du forum signalant le problème. Seul les traductions échappent à cette contrainte (pas de restrictions pour les traductions). Le non respect de cette contrainte, peut provoquer une rétrogradation au rang de '''Chasseur'''.

Pour la soumission de nouvelles fonctionnalités, il faut donc obligatoirement continuer sur le principe de patchs envoyés sur la ML.

L'obtention du grade d'Amiral est toutefois rare car limité. La qualité de Dolibarr ne pouvant être atteinte que par un nombre d'Amiraux contrôlé, ce qui n'empêche pas d'avoir un nombre de
développeurs (Chasseurs) très important (grâce au système de patch).

La liste des acteurs Dolibarr avec ce grade est disponible sur la page [[:Category:Admiral]]

== * Jedi ==

C'est au bout d'un temps variable (surement le plus long de tous) au rang de contributeur Amiral, et si la qualité des patch qui ont été envoyée est satisfaisante, qu'un Yoda vous signalera que vous êtes autorisé à réaliser des commits sans restrictions de fonctionnalités, à condition d'avoir cependant l'aval de principe d'un Maitre Yoda à qui vous aurez expliquer la fonctionnalité.
Il peut toutefois y avoir une restriction temporaire définie par un Yoda pour raison de release proche.
Vous êtes alors devenu un '''Jedi'''.

Ce titre ne se demande pas, il s'obtient par proposition d'un autre Jedi ou d'un Yoda.

Ce privilège est toutefois exceptionnel. La qualité de Dolibarr ne pouvant être atteinte
que par un nombre de Jedi contrôlé, ce qui n'empêche pas d'avoir un nombre de
développeurs (Chasseurs) très important (grâce au système de patch).

La liste des acteurs Dolibarr avec ce grade est disponible sur la page [[:Category:Jedi]]

== * Yoda ==

Au nombre de 1 à 5, être un '''Yoda''', c'est assurer la gestion globale du développement du projet. Ce rang s'obtient successivement au départ d'un Yoda qui se retire, ou par décision des autres Yoda de se renforcer, par nomination directe ou vote organisé par le Yoda partant.

La liste des acteurs Dolibarr avec ce grade est disponible sur la page [[:Category:Yoda]]

== * Et Dark Vador ? ==

Il existe hélas. Il y aura toujours des parasites qui polluent le forum ou la mailing-list de messages ou critiques non constructives, qui ralentissent le développement de Dolibarr plutôt que d'offrir des critiques aidant à progresser. Certains sont très très fort en mauvaise foie ou mauvais ton. Ce sont eux que l'on appellent les Dark Vador.
Heureusement, statistiquement, on ne constate l'apparition et la mort que d'un à deux Dark Vador par an environ...

= L'équipe actuelle =
Voir la page [[projet Dolibarr]] pour connaitre la liste des personnes, participant au projet Dolibarr, à chaque grade actuellement.

= Démarrer le développement =
Consulter '''intégralement''' la [[Documentation Développeur]] pour assimiler toutes les règles et principes imposées aux développeurs.
Vous pouvez aussi consulter les FAQ suivantes.

= Récupérer/mettre à jour la version CVS de développement =

===Récupération de la dernière version des sources avec accès CVS anonyme===

Sans compte Savannah ou sans autorisation d'accès CVS en écriture, vous pouvez quand même utiliser un client CVS (comme [http://www.wincvs.org WinCVS] ou [http://www.tortoisecvs.org TortoiseCVS] sous Windows le client CVS d'Eclipse ou la commande en ligne CVS sous Linux) pour récupérer les sources du projet.

La commande permettant de récupérer l'intégralité des fichiers dans un répertoire courant est:
<source lang="bash">
CVSROOT=:pserver:anonymous@cvs.savannah.nongnu.org:/cvsroot/dolibarr
export CVSROOT
cvs -q checkout -r HEAD dolibarr
</source>
HEAD signifie qu'on veut la dernière version de la version en cours de développement.

===Récupération de la dernière version des sources avec accès CVS complet===

Une autre méthode pour récupérer la version CVS est d'utiliser les outils CVS. Vous avez besoin d'un compte Savannah offrant un accès CVS en écriture et un client CVS (commande CVS sous Linux, WinCVS ou TortoiseCVS par exemple sous Windows, ou le client dans Eclipse...).

La commande permettant de récupérer l'intégralité des fichiers dans un répertoire courant est:
<source lang="bash">
CVSROOT=:ext:yoursavannahlogin@cvs.savannah.nongnu.org:/cvsroot/dolibarr
export CVSROOT
cvs -q checkout -r HEAD dolibarr
</source>
HEAD signifie qu'on veut la dernière version de la version en cours de développement.

===Autres repository===

Le repository CVS pour les modules non officiels est disponible dans le module dolibarrmod
<source lang="bash">
CVSROOT=:ext:yoursavannahlogin@cvs.savannah.nongnu.org:/cvsroot/dolibarr
export CVSROOT
cvs -q checkout -r HEAD dolibarrmod
</source>

===Mettre à jour son repository CVS===

La commande permettant de mettre à jour localement une copie de travail CVS (repository), qui a déjà été rapatriée par un checkout CVS, est la suivante:

''Sous linux:''
<source lang="bash">
cvs -q update -P -d
</source>
''Sous Windows avec Tortoise cvs''
<source lang="bash">
"C:\Program Files\CVSNT\cvs.exe" -q update -P -d
</source>
Et pour remettre au propre votre copie locale en annulant vos modifications locales sur les fichiers, ajouter l'option -C, soit:

''Sous linux:''
<source lang="bash">
cvs -q update -P -C -d
</source>
''Sous Windows avec Tortoise cvs''
<source lang="bash">
"C:\Program Files\CVSNT\cvs.exe" -q update -P -C -d
</source>

Si besoin, modifiez les droits de propriétaire des dossiers, pour que le serveur y ait accès.

===Récupération d'une autre branche par CVS===

Si vous désirez une version particulière (avec ces patchs), il vous faut suivre la même procédure que ci-dessus mais en remplaçant HEAD par le nom de la branche.
Par exemple DOLIBARR_2_2_BRANCH pour la branche 2.2 ou DOLIBARR_2_4_BRANCH pour la branche 2.4.

===Récupération de la dernière version des sources par téléchargement===

Cette méthode permet de récupérer le snapshot journalier de la version CVS de la branche de développement principale (appelée HEAD) sans utiliser de logiciel client CVS. L'opération consiste à télécharger la dernière version des fichiers de Dolibarr regroupés toutes les nuits dans un zip.
Pour cela, aller sur la page avec la [http://www.dolibarr.org/downloads/cat_view/64-development-version version CVS du jour].

Les nouveaux fichiers doivent écraser les anciens.
L'inconvénient de cette méthode et qu'il vous faut à chaque fois tout retélécharger pour bénéficier des mises à jours.

===Mise à jour de la base===

Si vous venez de faire un update, la prochaine étape consiste à migrer la base pour la mettre en phase avec les nouvelles sources. Pour cela, il suffit d'appeler la page
http://maracinedolibarr/install/
et choisir l'option "Mise à jour".

Cette procédure de migration/mise à jour est conçue pour fonctionner quel que soit l'état de départ et peut être repassée plusieurs fois sans risque.

===Utiliser Eclipse pour récupérer la version CVS===
Procédure détaillée ici :
[[Outils de développement#Configurer Eclipse pour récupérer la version CVS]]

= Comment créer un nouveau theme =
Voir pour cela la page [[Themes]]

= Comment développer mon propre système de menu =
Voir pour cela la page [[Système_de_menus]]

= Comment développer mon propre module =
Voir pour cela la page [[Developpement_module]]

= Comment ajouter ou compléter une traduction =
Voir pour cela la page [[Documentation_traducteur]]

= Changer mon système de numérotation des factures en cours de route =
Si le nouveau système de numérotation n'entre pas en conflit avec l'ancien, il suffit d'aller dans le menu Configuration - Modules - Configuration factures et prendre un nouveau modèle dans la liste.
Si le nouveau système rentre en conflit, il est nécessaire de renuméroter vos références existantes. Cela peut-être fait avec une requête SQL.
Par exemple, pour passer de Jupiter (FYYYYMM99) à Terre (FAYYMM-999), vous pouvez exécuter la requête suivante:
<source lang="sql">
update llx_facture set facnumber=concat('FA',substr(facnumber,4,4),'-',substr(facnumber,8))
where facnumber like 'F%' and facnumber not like 'FA%';
</source>

Par exemple, pour passer d'un modele FAYYMM999 à Terre (FAYYMM-999), vous pouvez exécuter la requête suivante:
<source lang="sql">
update llx_facture set facnumber=concat('FA',substr(facnumber,3,4),'-',substr(CONCAT('0000',substr(facnumber,7)),-4))
where facnumber like 'FA%' and facnumber not like '%-%';
</source>

= Soumettre un patch, amélioration ou participer au développement =
Si vous cherchez comment commencer ou aider les développements Dolibarr, lisez le chapitre [[FAQ_Développeur#Comment devenir développeur officiel]]. Si votre patch est déjà prêt et voulez le diffuser, ce chapitre est pour vous.

* '''Avec accès CVS en écriture '''
A ce jour, les accès en écriture au CVS sont restreints (le nombre de commit étant déjà suffisamment dynamique). Si vous bénéficiez à l'heure actuelle d'un accès CVS en écriture, utilisez-le et à condition que ce qui est commité corresponde bien à votre grade de développeur Dolibarr (Voir [[FAQ_D%C3%A9veloppeur#Comment_devenir_d.C3.A9veloppeur_officiel|FAQ Développeur - Devenir développeur officiel]] pour les différents grades).
Si, vous n'avez pas accès au CVS (vous êtes donc au grade de membre ou chasseur de l'alliance Dolibarr), il est nécessaire de suivre la procédure qui suit...

* '''Sans accès CVS en écriture'''
Sans accès CVS en écriture (sans compte développeur savannah), il est nécessaire de fournir par mail, votre fichier patch.

''Sous tout OS:''

Voici la ''méthode Pro'' selon laquelle travailler pour pouvoir générer un tel fichier patch:

- Avoir un répertoire qui contient la version de Dolibarr de référence (résultat de la mise à jour CVS ou bien tout simplement l'arborescence résultant de la décompression d'un snapshot tgz de Dolibarr). On appellera ce répertoire '''ancien_rep'''. Vous pouvez récupérer le snapshot de la version de dev en cours sur le [http://www.dolibarr.org/downloads/ site officiel de Dolibarr - espace téléchargement - version développement].

- Avoir un autre répertoire qui contient l'arborescence de Dolibarr mais dans laquelle vous faites ou avez fait vos modifications. On appellera ce répertoire '''nouveau_rep'''.

Pour générer le fichier patch, il suffit alors de lancer la commande '''diff''' (en standard sous Linux, fourni dans [http://www.cygwin.org/cygwin cygwin] sous Windows) de la manière suivante:
<source lang="bash">
diff -Naur --exclude=CVS --exclude="*.patch" --exclude=".#*" --exclude="*~" --exclude="*.rej"
--exclude="*.orig" --exclude="*.bak" --exclude=conf.php --exclude=documents
ancien_rep nouveau_rep > mypatch.patch
</source>
Un script ksh réalisant cette commande est disponible dans le répertoire '''build/patch'''.
Envoyer votre patch sur la ML à l'adresse '''dolibarr-dev@nongnu.org'''.
L'intégration de votre patch n'est toutefois pas garantie, pas plus que le délai, mais si le patch est réalisé en suivant rigoureusement cette procédure, il a de forte chance d'être au moins testé (dans le cas contraire les chances sont proches de 0).

''Sous Windows:''

Si vous êtes sous Windows, une ''méthode moins Pro'' mais qui donne le même résultat est la suivante. Installer l'excellent outil open source de comparaison Winmerge qui sait fabriquer des patchs au format ''diff -Naur''. Pour cela, comparer avec Winmerge le fichier référence et le fichier modifié et choisir dans le menu ''"Tools - Generate patch"'' (''Générer des retouches'' en version française). Saisir un nom de fichier comme ''"resultat.patch"'', cocher la case ''"Append"'' et choisir l'option ''"Format Unified"'' (''Style : unifié'' en version française). Cliquer sur ''"Ok"''.
Éventuellement recommencer pour chaque fichier modifié.
Au final, on obtient un beau fichier ''resultat.patch'' qui contient toutes les modifications au bon format.

Au lieu de rechercher manuellement vos fichiers, si vous avez installé conjointement ''TortoiseCVS'' et ''Winmerge'', vous pouvez vous contenter de votre version modifiée sur votre ordinateur, et de la version CVS en ligne. Sous l'explorateur Windows, faites un clic droit sur le fichier qui doit être patché, et choisissez "CVS comparer" (pas WinMerge qui se trouve quelques lignes plus bas). Tortoise va lui-même lancer WinMerge. Puis reprenez la procédure décrite ci-dessus.

* '''Tester/Appliquer un patch'''
Pour appliquer un ficiher patch sur une version non modifié afin d'intégrer les modifications décrites dans le fichier patch, vous pouvez utiliser l'utilitaire '''patch'''.
Imaginons que vous avez un répertoire des sources d'une version non modifiée de Dolibarr sur un serveur. Pour appliquer le patch, placer dans le répertoire racine de Dolibarr et lancez la commande:
<source lang="bash">
patch -u -p0 -d . < monfichier.patch
</source>
<nowiki>Pour information: -p0 permet d'utiliser le chemin entier tel que mentionné dans le fichier de patch pour retrouver les fichiers à modifier dans votre arborescence source (-pn en retire les n premiers niveau de l'arborescence)
-d permet de préciser le chemin relatif vers le dossier à patcher.
< permet de donner le chemin vers le fichier source à utiliser (le patch doit etre au format unifié)
-u permet de préciser que le patch est en mode unifié</nowiki>

= Comment packager/livrer un module =
Voir la page [[Développement_module#Cr.C3.A9er_un_package_pour_livrer_et_installer_votre_module|Developpement module - Créer un package pour livrer et installer votre module]]

= Comment être informé de ce qui se passe sur Dolibarr ? =
Voir la page [[FAQ Comment être informé de l'actualité de Dolibarr ?]]

Outils de développement

2010-02-10T16:43:00Z

Dmartin: /* Eclipse et plugins */ Ajout procédure de configuration d'Eclipse pour CVS

{{TemplateDocDev}}

Tout environnement de développement peut être utilisé.
Toutefois voici une liste d'outils fortement recommandés pour leur complétude, leur qualité et la productivité du développement qu'ils apportent. Ils sont utilisés par la plupart des développeurs principaux de Dolibarr. Notons que toutes ces solutions sont gratuites et OpenSource.

= Pour tout développeur =

Voici le socle de travail recommandé, toutefois tout outil respectant les standards Web, PHP, Mysql peuvent faire l'affaire.

== Un serveur AMP ==

* Apache, Mysql et PHP

Sur Linux: Ces 3 produits sont disponibles dans toutes distributions.

Sur Windows: Installez [http://www.wampserver.com/ WampServer 2] (base Mysql, Apache et PHP tout clé en main). Ce serveur WAMP offre le trio MySql+Apache+PHP, avec possibilité de basculer de version pour n'importe lequel de ces composants d'un simple clic).

== Firefox et plugins ==
* Firefox 3.0 avec les plugins:
** HTML Validator,
** Firebug + Firecookie,
** Phplangeditor et les Dictionnaires des langues si vous compter traduire
** Cert Viewer Plus si vous comptez faire des tests en HTTPS,
** FoxyProxy si vous voulez basculer rapidement votre navigateur vers des utilitaires Proxy (WebScarab)...
** User agent switcher pour simuler des accès depuis un smartphone
A télécharger depuis le site http://www.firefox.com

== SquirrelSQL ==
* SquirrelSQL pour l'administration de base
A télécharger depuis le site http://squirrel-sql.sf.net

== Eclipse et plugins ==
=== Installation d'Eclipse ===
Je recommande la version 3.4 d'Eclipse disponible sur le site
http://www.acceleo.org/pages/download-acceleo-2-6-0/en qui embarque la plupart des plugins intéressant.
Une fois lancé, vous pouvez aller dans le centre de mise a jour, Help -> Software updates pour mettre à jour Eclipse avec la version 3.4.2 M20090211-1700.

Sinon toute version disponible sur le site [http://www.eclipse.org Eclipse].

=== Installation du plugin Eclipse pour PHP: PDT. ===
Si vous avez installé la version Eclipse ci-dessus, il suffit d'utiliser la procédure Find And Install et ajouter l'URL de mise à jour: http://download.eclipse.org/tools/pdt/updates/

Installer la version 1.0.5 de PDT. La version 0.2.0 est buggué avec Eclipse 3.4.x.

=== Configurer Eclipse pour récupérer la version CVS ===

Une fois qu'Eclipse est installé, vous pouvez vous connecter au repository CVS pour y récupérer la dernière version de développement.

* Créer un nouveau projet : File >> New >> Projects puis sélectionner "Project from CVS" et "Next"
* Sélectionner "Create a new repository location" puis "Next"
* Remplir la fenêtre suivante comme ceci :
** Host : cvs.savannah.nongnu.org
** Repository path : /cvsroot/dolibarr
** User : anonymous
** Password : (laisser vide)
** Connection type : pserver
** Use default port
* Ensuite remplir le champ Use specified module name : dolibarr
* Choisir ensuite le nom que le projet aura sur votre machine :
** Cocher Check out as a projet in the workspace
** Project Name : dolibarr
** Cocher Checkout subfolders
* Ensuite, laisser le chemin par défaut du workspace et "Next"
* Enfin, sélectionner la branche à charger
** HEAD est la version de développement
** Les version 2.6, 2.6, etc., se trouvent dans Branches
* Cliquer sur "Finish"

Les fichiers devraient être téléchargés sur votre disque dur.

Pour ensuite mettre à jour la version de votre machine, il faut passer en perspective "Team Synchronizing" pour utiliser la fonction "Synchronize CVS", ce qui aura pour effet de télécharger les dernières versions sur votre disque dur. Seuls les fichiers qui ont été modifiés sont téléchargés.

= Optionnel =

== Si vous gérez d'autres projets sous SVN ==
* Installation du plugin SVN pour Eclipse: SubClipse.
Pour cela, utiliser la procédure Find And Install et ajouter l'URL de mise à jour:
http://subclipse.tigris.org/install.html
ou bien
* Installation du plugin SVN pour Eclipse: Subversive
http://community.polarion.com/projects/subversive/download/eclipse/2.0/ganymede-site/ - [required] Subversive SVN Connectors
http://community.polarion.com/projects/subversive/download/integrations/ganymede-site/ - [optional] Subversive Integrations

== Si vous désirez faire des scripts en Perl ==
* Installation du plugin Eclipse pour Perl: EPIC
Pour cela, utiliser la procédure Find And Install et ajouter l'URL de mise à jour: http://e-p-i-c.sourceforge.net/updates

== Si vous désirez développer des modules avec le générateur UML2Dolibarr ==

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]].
Pour l'utiliser, vous devez installer les composants suivants (si vous avez installé la version d'Eclipse recommandé plus haut, tout ceci est déjà fait):

* Installation de TopCased 1.4 ou +: http://www.topcased.org

* Installation d'acceleo 2.2.1 ou +
Pour cela, utiliser la procédure '''Find And Install''' et ajouter l'URL de mise à jour:
http://www.acceleo.org/update/

* Installation d'UML2Dolibarr
Pour cela, récupérer les projets par la commande:
<pre>
svn checkout svn://svn.forge.objectweb.org/svnroot/acceleo/trunk/modules/community/uml21/dolibarr/trunk/
</pre>
et les importer dans Eclipse.

== Si vous êtes sous Windows ==

* Notepad++ (pour ceux qui ne supportent pas java ou utilisent un vieux coucou trop faible pour Eclipse).

* WinMerge (pour la comparaison de fichiers ou répertoires)

* CygWin (pour la commande patch et la commande en ligne cvs si vous préferez les lignes de commandes)

== Si vous désirez faire du debuggage et tunning avec XDebug ==

* Installer xdebug
Sous Ubuntu: Installer le package php-xdebug

Sous Wampserver/Windows, téléchargé le fichier php_debug_xxx.dll sur http://www.xdebug.org et le placer dans le répertoire ext de php de WampServer.

* Modifier le fichier php.ini (ou xdebug.ini) pour ajouter les paramètres:

[xdebug]
xdebug.remote_enable=on
xdebug.remote_handle=dbgp
xdebug.remote_host=localhost
xdebug.remote_port=9000
xdebug.profiler_enable=1
xdebug.show_local_vars=off
xdebug.profiler_output_dir=c:/temp
xdebug.profiler_append=0

* Ensuite pour analyser les fichiers de profiling générés par XDebug, vous pouvez installer KCacheGrind (Linux) ou WinCacheGrind (Windows).

= Configuration =
Si vous êtes un développeur officiel avec accès CVS en écriture, ajouter dans la configuration CVS de votre Eclipse, une entrée CVS.

* ''':ext:yourlogin@cvs.savannah.nongnu.org:/cvsroot/dolibarr''' pour la version principale de Dolibarr
* ''':ext:yourlogin@cvs.savannah.nongnu.org:/cvsroot/dolibarrmod''' pour les modules externes

Sinon il vous faut récupérer les sources depuis le tarball disponible sur le site web Dolibarr ( http://www.dolibarr.fr ) dans l'espace téléchargement

Développement module

2010-02-05T10:26:47Z

Dmartin: /* Générer la classe PHP d'accès */

[[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 des exports prédéfinis pour la fonction export
* Ajouter de nouvelles boites pour la home page
* Définir de nouvelles permissions
* Déclencher du code automatiquement sur une action Dolibarr particulière
etc...
Toutes ces opérations ne sont possibles qu'avec la version 2.4 ou plus de Dolibarr.

Les chapitres suivant 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]] Créer un descripteur de Module (obligatoire) =
'''Quand''': Obligatoire dès qu'une extension est développée, quelque soit sa vocation.

== Créer votre descripteur ==

La première étape est donc de créer un fichier descripteur du module.
Pour cela, aller dans le répertoire '''dev/skeletons''' et recopier le fichier modMyModule.class.php dans le répertoire
'''htdocs/includes/modules'''.
Ensuite, modifier le contenu de ce fichier afin de remplacer:
* les ''modMyModule'' en une valeur qui corresponde a la vocation de votre module. Cette valeur doit toujours commencer par 'mod'.
* $this->numero = ''10000'' par un numero de module libre (Aller dans la page '''Accueil -> Infos système -> Dolibarr -> Modules''' pour connaitre la liste des id module deja utilises).
* Modifier éventuellement les autres variables définies dans le constructeurs (Voir le commentaire dans le code du squelette pour leur signification).

* Créer le répertoire /htdocs/monmodule/

Votre fichier descripteur de votre module est alors en place.

== Tester votre descripteur ==

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

= [[File:Art.png]] Créer vos tables SQL et la classe PHP des accesseurs (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 a lui, qui n'existent pas en base dans la version standard de Dolibarr, il est nécessaire de définir des tables SQL pour stocker ces données.

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

''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 '''includes/mysql/tables''' pour exemple).
* Pour ce qui est des ordres de gestion des données, ils doivent tous 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='MYMODULE_IT_WORKS' and entity='__ENTITY__';
insert into llx_const (name, value, type, note, visible, entity) values ('MYMODULE_IT_WORKS','1','chaine','A constant vor 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 d'accès ==

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.

= [[File:Art.png]] Affichage des onglets (optionnel) =

== Ajouter vos onglets sur les fiches entités ==
'''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
$this->tabs = array('product:ComposedProducts:@composition:/composition/show_composition.php?id=__ID__');
// where entity can be
// 'thirdparty' to add a tab in third party view
// 'intervention' to add a tab in intervention view
// 'supplier_order' to add a tab in supplier order view
// 'supplier_invoice' to add a tab in supplier invoice view
// 'invoice' to add a tab in customer invoice view
// 'order' to add a tab in customer order view
// 'product' to add a tab in product view
// 'propal' to add a tab in propal view
// 'member' to add a tab in foundation member view
// 'contract' to add a tab in contract view
</source>

Le tableau doit contenir une liste de chaine, chaque chaine représentant un nouvel onglet.
Le format de la chaine étant composée de 4 parties séparées par ":"
* Partie 1: Le code entité dans lequel doit apparaitre l'onglet qui est une valeur parmi celle-ci:
** 'thirdparty'
** 'intervention'
** 'supplier_order'
** 'supplier_invoice'
** 'invoice'
** 'order'
** 'product'
** 'propal'
** 'member'
** 'contract'
* Partie 2: Le titre de l'onglet. Cela peut être un libellé en dur ou mieux un code traduction présent dans un fichier lang.
* Partie 3: Le nom du fichier .lang qui contient la correspondance entre le code traduction et le libellé à afficher.
* Partie 4: L'url de la page à afficher quand on clique sur l'onglet. La chaine __ID__ sera remplacée automatiquement par l'Id de l'entité concernée.

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

== Ajouter les onglets d'une fiche entité sur ses propres pages ==
'''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 la liste de ces fichiers (DOL_DOCUMENT_ROOT correspond au dossier dolibarr/htdocs/) :
* Entité tiers (thirdparty) :
** DOL_DOCUMENT_ROOT/societe.class.php
** DOL_DOCUMENT_ROOT/lib/company.lib.php
* Entité produit (product) :
** DOL_DOCUMENT_ROOT/product.class.php
** DOL_DOCUMENT_ROOT/lib/product.lib.php
* Entité facture (invoice) :
** DOL_DOCUMENT_ROOT/facture.class.php
** DOL_DOCUMENT_ROOT/lib/invoice.lib.php

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

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érer depuis l'url (ex : /mononglet.php?id=1).

''Exemple :''
<source lang="php">
$id=$_GET["id"];
$product = new Product($db) ;
$result = $product->fetch($id) ; //Tester $result pour vérifier que l'accès à la base s'est bien passé
</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.

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

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

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

Y recopier le fichier '''skeletons_page.php''' qui va servir de point de départ à votre page ainsi que le fichier '''pre.inc.php'''.
Modifier le fichier '''pre.inc.php''' afin que le chemin relatif du
<source lang="php">
include("../../main.inc.php)";
</source>
soit correct, en fonction de la profondeur de répertoire dans laquelle se trouve le fichier '''pre.inc.php''' (Enlever ou supprimer des "../").
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ée.
* $langs L'objet qui contient la langue de l'utilisateur.

Saisissez ensuite votre code pour afficher la page.

== Créer une page écran PHP par template Smarty ==
=== Compléter votre descripteur de module ===
Dans votre descripteur de module, compléter la déclaration du tableau this->const afin d'ajouter la constante MAIN_MODULE_monmodule_NEEDSMARTY.
<source lang="php">
$this->const=array(1=>array('MAIN_MODULE_MONMODULE_NEEDSMARTY','chaine',1,'Need smarty',0));
</source>

Ceci aura pour effet, lors de l'initialisation de l'objet $conf, de remplir le tableau $conf->need_smarty des modules qui ont besoin de smarty et si au moins un module est requis, le code dans main.inc.php chargera systématiquement les librairies de Smarty.

=== Réaliser vos pages templates ===
Construisez vos pages templates (fichiers '''mespages.tpl''') dans le répertoire '''htdocs/monmodule/templates'''.

=== Réaliser vos pages PHP ===
Réaliser vos pages écrans PHP Dolibarr en suivant le modèle décrit dans cette documentation.
La différence est qu'à la fin, pour afficher la présentation HTML, il vous faut ajouter la séquence suivante:
<source lang="php">
$smarty->template_dir = DOL_DOCUMENT_ROOT.'/monmodule/templates/';
$mc->assign_smarty_values($smarty,$_GET["action"]);
$smarty->display($template);
</source>
L'objet $smarty n'a pas â etre iniitlaisé, il est normalement déjà défini (sur la base de Smarty intégré dans Dolibarr), si votre descripteur de module a bien déclaré avoir besoin de smarty et que le module a bien était activé après cela.

== 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 donnees de tableau.
* class="'''flat'''" sur tous les champs de saisie (''input, select, textarea''...).
* class="'''button'''" sur les objets de type ''input type="submit"''.

== Utiliser le sélecteur de date de Dolibarr ==

Si vous le désirez, vous pouvez profiter du sélecteur de date dans des écrans Dolibarr. Pour cela, utilisez la ligne suivante:
<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>

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

== Creer votre page d'édition de configuration ==
Si votre module offre plusieurs options paramétrables, il est nécessaire de créer une page PHP pour éditer les options (qui sont stockées dans la [[Table llx_const|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 ==
Aller sur la page '''Configuration->module''', vous devez voir apparaitre un icone qui permet d'accéder à la page de configuratione tvous devez etre capable de modifier ces options et les voir conservé en base.

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

== Définissez vos entrées menus ==
Pour cela, il vous faut définir dans le fichier descripteur de module, le tableau this->menu qui déclare les menus.
Ce tableau contient toutes les entrées qui apparaitront dans les menus une fois le module activé.
Le fichier de descripteur de module exemple '''modMyModule.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'=>'MyModule top menu',
'mainmenu'=>'mymodule',
'leftmenu'=>'1', // Use 1 if you also want to add left menu entries using this descriptor. Use 0 if left menu entries are defined in a file pre.inc.php (old school).
'url'=>'/mymodule/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->mymodule->enabled' if entry must be visible if module is enabled.
'perms'=>'1', // Use 'perms'=>'$user->rights->mymodule->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'=>'r=0', // Use r=value where r is index key used for the parent menu entry (higher parent must be a top menu entry)
'type'=>'left', // This is a Left menu entry
'titre'=>'MyModule left menu 1',
'mainmenu'=>'mymodule',
'url'=>'/mymodule/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->mymodule->enabled' if entry must be visible if module is enabled.
'perms'=>'1', // Use 'perms'=>'$user->rights->mymodule->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 le permission un peu plus loin pour savoir comment ajouter des permissions.

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

= [[File:Art.png]] 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ée 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 chaine action et sousaction sans espaces. Vous pourrez alors tester dans le code PHP si un utilisateurs a bien les droits par la séquence suivante:

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

= [[File:Art.png]] Définir vos propres box (optionnel) =
'''Quand''': Si votre module amène avec lui une ou plusieurs Boxes.

== Définissez vos box ==
Pour cela, modifier les tableaux $this->boxes du fichier descripteur de module.
Il suffit d'ajouter une ligne par fichier box qui se trouve dans le répertoire '''htdocs/includes/boxes'''

''Exemple:''
<source lang="php">
this->boxes[0][1]='mabox0.php'
this->boxes[1][1]='mabox1.php'
this->boxes[2][1]='mabox2.php'
...
this->boxes[n][1]='maboxn.php'
</source>

Ensuite creer les fichiers mabox0.php, mabox1.php... en prenant exemple sur des box existantes (dans le répertoire htdocs/include/boxes

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

Aller dans le menu '''Accueil - Configuration - Boite'''.

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

= [[File:Art.png]] 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.

= [[File:Art.png]] 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''' 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''.php.css'''. 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->style_sheet'''.
La valeur à renseigner ici doit être le chemin relatif de l'URL de votre fichier css.
Par exemple '/monmodule/monfichier.css'.

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

= [[File:Art.png]] 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 fichiers javascript '''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 déclarer votre fichier javascript dans le descripteur de module.

Cette fonctionnalité n'est pas encore possible.

= [[File:Art.png]] 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'action s 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]]

= [[File:Art.png]] Créer un package pour livrer et installer votre module =

* 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 CVS 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.tgz''' 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.tgz
</source>

* Si vous désirez que votre module profite à tous, vous pouvez le soumettre (le fichier tgz) sur le site web de Dolibarr dans la section téléchargements: http://www.dolibarr.org -> downloads -> contrib -> submit a file (vous devez avoir créer un compte auparavant et être loggué pour que le lien apparaisse).
** 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]] Quelques règles de codage =
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".

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

Développement module

2010-02-04T09:48:31Z

Dmartin: /* Ajouter les onglets d'une fiche entité sur ses propres pages */

[[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 des exports prédéfinis pour la fonction export
* Ajouter de nouvelles boites pour la home page
* Définir de nouvelles permissions
* Déclencher du code automatiquement sur une action Dolibarr particulière
etc...
Toutes ces opérations ne sont possibles qu'avec la version 2.4 ou plus de Dolibarr.

Les chapitres suivant 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]] Créer un descripteur de Module (obligatoire) =
'''Quand''': Obligatoire dès qu'une extension est développée, quelque soit sa vocation.

== Créer votre descripteur ==

La première étape est donc de créer un fichier descripteur du module.
Pour cela, aller dans le répertoire '''dev/skeletons''' et recopier le fichier modMyModule.class.php dans le répertoire
'''htdocs/includes/modules'''.
Ensuite, modifier le contenu de ce fichier afin de remplacer:
* les ''modMyModule'' en une valeur qui corresponde a la vocation de votre module. Cette valeur doit toujours commencer par 'mod'.
* $this->numero = ''10000'' par un numero de module libre (Aller dans la page '''Accueil -> Infos système -> Dolibarr -> Modules''' pour connaitre la liste des id module deja utilises).
* Modifier éventuellement les autres variables définies dans le constructeurs (Voir le commentaire dans le code du squelette pour leur signification).

* Créer le répertoire /htdocs/monmodule/

Votre fichier descripteur de votre module est alors en place.

== Tester votre descripteur ==

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

= [[File:Art.png]] Créer vos tables SQL et la classe PHP des accesseurs (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 a lui, qui n'existent pas en base dans la version standard de Dolibarr, il est nécessaire de définir des tables SQL pour stocker ces données.

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

''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 '''includes/mysql/tables''' pour exemple).
* Pour ce qui est des ordres de gestion des données, ils doivent tous 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='MYMODULE_IT_WORKS' and entity='__ENTITY__';
insert into llx_const (name, value, type, note, visible, entity) values ('MYMODULE_IT_WORKS','1','chaine','A constant vor 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 d'accès ==

Une fois votre ou vos tables créées en base, aller dans le répertoire '''dev/skeletons''' 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.

= [[File:Art.png]] Affichage des onglets (optionnel) =

== Ajouter vos onglets sur les fiches entités ==
'''Quand''' : Pour ajouter un onglet sur 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
$this->tabs = array('product:ComposedProducts:@composition:/composition/show_composition.php?id=__ID__');
// where entity can be
// 'thirdparty' to add a tab in third party view
// 'intervention' to add a tab in intervention view
// 'supplier_order' to add a tab in supplier order view
// 'supplier_invoice' to add a tab in supplier invoice view
// 'invoice' to add a tab in customer invoice view
// 'order' to add a tab in customer order view
// 'product' to add a tab in product view
// 'propal' to add a tab in propal view
// 'member' to add a tab in fundation member view
// 'contract' to add a tab in contract view
</source>

Le tableau doit contenir une liste de chaine, chaque chaine représentant un nouvel onglet.
Le format de la chaine étant composée de 4 parties séparées par ":"
* Partie 1: Le code entité dans lequel doit apparaitre l'onglet qui est une valeur parmi celle-ci:
** 'thirdparty'
** 'intervention'
** 'supplier_order'
** 'supplier_invoice'
** 'invoice'
** 'order'
** 'product'
** 'propal'
** 'member'
** 'contract'
* Partie 2: Le titre de l'onglet. Cela peut être un libellé en dur ou mieux un code traduction présent dans un fichier lang.
* Partie 3: Le nom du fichier .lang qui contient la correspondance entre le code traduction et le libellé à afficher.
* Partie 4: L'url de la page à afficher quand on clique sur l'onglet. La chaine __ID__ sera remplacée automatiquement par l'Id de l'entité concernée.

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

== Ajouter les onglets d'une fiche entité sur ses propres pages ==
'''Quand''' : Pour afficher les mêmes onglets qu'une fiche entité (produit, tiers, etc.) sur vos IHM.

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 la liste de ces fichiers (DOL_DOCUMENT_ROOT correspond au dossier dolibarr/htdocs/) :
* Entité tiers (thirdparty) :
** DOL_DOCUMENT_ROOT/societe.class.php
** DOL_DOCUMENT_ROOT/lib/company.lib.php
* Entité produit (product) :
** DOL_DOCUMENT_ROOT/product.class.php
** DOL_DOCUMENT_ROOT/lib/product.lib.php
* Entité facture (invoice) :
** ''À compléter''

'''2. Créer un objet correspondant à l'entité voulue'''

Créer un 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($id) de la classe correspondante, en passant en paramètre l'identifiant de l'objet à récupérer.

Il faudrait donc avoir passé cet identifiant dans l'url (ex : view.php?id=1).

''Exemple :''
<source lang="php">
$product = new Product($db) ;
$result = $product->fetch($id) ; //Tester $result pour vérifier que l'accès à la base s'est bien passé
</source>

'''3. Préparer la liste des onglets correspondants à l'entité choisie'''

Utiliser la fonction XX_prepare_head($obj), ou XX 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'''

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.

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

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

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

Y recopier le fichier '''skeletons_page.php''' qui va servir de point de départ à votre page ainsi que le fichier '''pre.inc.php'''.
Modifier le fichier '''pre.inc.php''' afin que le chemin relatif du
<source lang="php">
include("../../main.inc.php)";
</source>
soit correct, en fonction de la profondeur de répertoire dans laquelle se trouve le fichier '''pre.inc.php''' (Enlever ou supprimer des "../").
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ée.
* $langs L'objet qui contient la langue de l'utilisateur.

Saisissez ensuite votre code pour afficher la page.

== Créer une page écran PHP par template Smarty ==
=== Compléter votre descripteur de module ===
Dans votre descripteur de module, compléter la déclaration du tableau this->const afin d'ajouter la constante MAIN_MODULE_monmodule_NEEDSMARTY.
<source lang="php">
$this->const=array(1=>array('MAIN_MODULE_MONMODULE_NEEDSMARTY','chaine',1,'Need smarty',0));
</source>

Ceci aura pour effet, lors de l'initialisation de l'objet $conf, de remplir le tableau $conf->need_smarty des modules qui ont besoin de smarty et si au moins un module est requis, le code dans main.inc.php chargera systématiquement les librairies de Smarty.

=== Arborescence et fonctionnement ===
A compléter...

=== Réaliser vos pages templates ===
A compléter...

== 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 donnees de tableau.
* class="'''flat'''" sur tous les champs de saisie (''input, select, textarea''...).
* class="'''button'''" sur les objets de type ''input type="submit"''.

== Utiliser le sélecteur de date de Dolibarr ==

Si vous le désirez, vous pouvez profiter du sélecteur de date dans des écrans Dolibarr. Pour cela, utilisez la ligne suivante:
<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>

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

== Creer votre page d'édition de configuration ==
Si votre module offre plusieurs options paramétrables, il est nécessaire de créer une page PHP pour éditer les options (qui sont stockées dans la [[Table llx_const|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 ==
Aller sur la page '''Configuration->module''', vous devez voir apparaitre un icone qui permet d'accéder à la page de configuratione tvous devez etre capable de modifier ces options et les voir conservé en base.

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

== Définissez vos entrées menus ==
Pour cela, il vous faut définir dans le fichier descripteur de module, le tableau this->menu qui déclare les menus.
Ce tableau contient toutes les entrées qui apparaitront dans les menus une fois le module activé.
Le fichier de descripteur de module exemple '''modMyModule.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'=>'MyModule top menu',
'mainmenu'=>'mymodule',
'leftmenu'=>'1', // Use 1 if you also want to add left menu entries using this descriptor. Use 0 if left menu entries are defined in a file pre.inc.php (old school).
'url'=>'/mymodule/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->mymodule->enabled' if entry must be visible if module is enabled.
'perms'=>'1', // Use 'perms'=>'$user->rights->mymodule->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'=>'r=0', // Use r=value where r is index key used for the parent menu entry (higher parent must be a top menu entry)
'type'=>'left', // This is a Left menu entry
'titre'=>'MyModule left menu 1',
'mainmenu'=>'mymodule',
'url'=>'/mymodule/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->mymodule->enabled' if entry must be visible if module is enabled.
'perms'=>'1', // Use 'perms'=>'$user->rights->mymodule->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 le permission un peu plus loin pour savoir comment ajouter des permissions.

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

= [[File:Art.png]] 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ée 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 chaine action et sousaction sans espaces. Vous pourrez alors tester dans le code PHP si un utilisateurs a bien les droits par la séquence suivante:

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

= [[File:Art.png]] Définir vos propres box (optionnel) =
'''Quand''': Si votre module amène avec lui une ou plusieurs Boxes.

== Définissez vos box ==
Pour cela, modifier les tableaux $this->boxes du fichier descripteur de module.
Il suffit d'ajouter une ligne par fichier box qui se trouve dans le répertoire '''htdocs/includes/boxes'''

''Exemple:''
<source lang="php">
this->boxes[0][1]='mabox0.php'
this->boxes[1][1]='mabox1.php'
this->boxes[2][1]='mabox2.php'
...
this->boxes[n][1]='maboxn.php'
</source>

Ensuite creer les fichiers mabox0.php, mabox1.php... en prenant exemple sur des box existantes (dans le répertoire htdocs/include/boxes

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

Aller dans le menu '''Accueil - Configuration - Boite'''.

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

= [[File:Art.png]] 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.

= [[File:Art.png]] 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''' 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''.php.css'''. 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->style_sheet'''.
La valeur à renseigner ici doit être le chemin relatif de l'URL de votre fichier css.
Par exemple '/monmodule/monfichier.css'.

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

= [[File:Art.png]] 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 fichiers javascript '''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 déclarer votre fichier javascript dans le descripteur de module.

Cette fonctionnalité n'est pas encore possible.

= [[File:Art.png]] 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'action s 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]]

= [[File:Art.png]] Créer un package pour livrer et installer votre module =

* 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 CVS 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.tgz''' 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.tgz
</source>

* Si vous désirez que votre module profite à tous, vous pouvez le soumettre (le fichier tgz) sur le site web de Dolibarr dans la section téléchargements: http://www.dolibarr.org -> downloads -> contrib -> submit a file (vous devez avoir créer un compte auparavant et être loggué pour que le lien apparaisse).
** 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]] Quelques règles de codage =
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".

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

Développement module

2010-02-03T21:42:39Z

Dmartin: /* File:Art.png Ajouter vos onglets sur les fiches entités (optionnel) */ Ajout d'une section pour l'affichage des onglets existant sur de nouvelles pages

[[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 des exports prédéfinis pour la fonction export
* Ajouter de nouvelles boites pour la home page
* Définir de nouvelles permissions
* Déclencher du code automatiquement sur une action Dolibarr particulière
etc...
Toutes ces opérations ne sont possibles qu'avec la version 2.4 ou plus de Dolibarr.

Les chapitres suivant 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]] Créer un descripteur de Module (obligatoire) =
'''Quand''': Obligatoire dès qu'une extension est développée, quelque soit sa vocation.

== Créer votre descripteur ==

La première étape est donc de créer un fichier descripteur du module.
Pour cela, aller dans le répertoire '''dev/skeletons''' et recopier le fichier modMyModule.class.php dans le répertoire
'''htdocs/includes/modules'''.
Ensuite, modifier le contenu de ce fichier afin de remplacer:
* les ''modMyModule'' en une valeur qui corresponde a la vocation de votre module. Cette valeur doit toujours commencer par 'mod'.
* $this->numero = ''10000'' par un numero de module libre (Aller dans la page '''Accueil -> Infos système -> Dolibarr -> Modules''' pour connaitre la liste des id module deja utilises).
* Modifier éventuellement les autres variables définies dans le constructeurs (Voir le commentaire dans le code du squelette pour leur signification).

* Créer le répertoire /htdocs/monmodule/

Votre fichier descripteur de votre module est alors en place.

== Tester votre descripteur ==

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

= [[File:Art.png]] Créer vos tables SQL et la classe PHP des accesseurs (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 a lui, qui n'existent pas en base dans la version standard de Dolibarr, il est nécessaire de définir des tables SQL pour stocker ces données.

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

''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 '''includes/mysql/tables''' pour exemple).
* Pour ce qui est des ordres de gestion des données, ils doivent tous 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='MYMODULE_IT_WORKS' and entity='__ENTITY__';
insert into llx_const (name, value, type, note, visible, entity) values ('MYMODULE_IT_WORKS','1','chaine','A constant vor 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 d'accès ==

Une fois votre ou vos tables créées en base, aller dans le répertoire '''dev/skeletons''' 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.

= [[File:Art.png]] Affichage des onglets (optionnel) =

== Ajouter vos onglets sur les fiches entités ==
'''Quand''' : Pour ajouter un onglet sur 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
$this->tabs = array('product:ComposedProducts:@composition:/composition/show_composition.php?id=__ID__');
// where entity can be
// 'thirdparty' to add a tab in third party view
// 'intervention' to add a tab in intervention view
// 'supplier_order' to add a tab in supplier order view
// 'supplier_invoice' to add a tab in supplier invoice view
// 'invoice' to add a tab in customer invoice view
// 'order' to add a tab in customer order view
// 'product' to add a tab in product view
// 'propal' to add a tab in propal view
// 'member' to add a tab in fundation member view
// 'contract' to add a tab in contract view
</source>

Le tableau doit contenir une liste de chaine, chaque chaine représentant un nouvel onglet.
Le format de la chaine étant composée de 4 parties séparées par ":"
* Partie 1: Le code entité dans lequel doit apparaitre l'onglet qui est une valeur parmi celle-ci:
** 'thirdparty'
** 'intervention'
** 'supplier_order'
** 'supplier_invoice'
** 'invoice'
** 'order'
** 'product'
** 'propal'
** 'member'
** 'contract'
* Partie 2: Le titre de l'onglet. Cela peut être un libellé en dur ou mieux un code traduction présent dans un fichier lang.
* Partie 3: Le nom du fichier .lang qui contient la correspondance entre le code traduction et le libellé à afficher.
* Partie 4: L'url de la page à afficher quand on clique sur l'onglet. La chaine __ID__ sera remplacée automatiquement par l'Id de l'entité concernée.

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

== Ajouter les onglets d'une fiche entité sur ses propres pages ==
'''Quand''' : Pour afficher les mêmes onglets qu'une fiche entité (produit, tiers, etc.) sur vos IHM.

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 la liste de ces fichiers (DOL_DOCUMENT_ROOT correspond au dossier dolibarr/htdocs/) :
* Entité tiers (thirdparty) :
** DOL_DOCUMENT_ROOT/societe.class.php
** DOL_DOCUMENT_ROOT/lib/company.lib.php
* Entité produit (product) :
** DOL_DOCUMENT_ROOT/product.class.php
** DOL_DOCUMENT_ROOT/lib/product.lib.php
* Entité facture (invoice) :
** ''À compléter''

'''2. Créer un objet correspondant à l'entité voulue'''

Créer un 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($id) de la classe correspondante, en passant en paramètre l'identifiant de l'objet à récupérer.

Il faudrait donc avoir passé cet identifiant dans l'url (ex : view.php?id=1).

''Exemple :''
<source lang="php">
$product = new Product($db) ;
$result = $product->fetch($id) ; //Tester $result pour vérifier que l'accès à la base s'est bien passé
</source>

'''3. Préparer la liste des onglets correspondants à l'entité choisie'''

Utiliser la fonction XX_prepare_head($obj), ou XX 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'''

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.

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

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

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

Y recopier le fichier '''skeletons_page.php''' qui va servir de point de départ à votre page ainsi que le fichier '''pre.inc.php'''.
Modifier le fichier '''pre.inc.php''' afin que le chemin relatif du
<source lang="php">
include("../../main.inc.php)";
</source>
soit correct, en fonction de la profondeur de répertoire dans laquelle se trouve le fichier '''pre.inc.php''' (Enlever ou supprimer des "../").
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ée.
* $langs L'objet qui contient la langue de l'utilisateur.

Saisissez ensuite votre code pour afficher la page.

== Créer une page écran PHP par template Smarty ==
=== Compléter votre descripteur de module ===
Dans votre descripteur de module, compléter la déclaration du tableau this->const afin d'ajouter la constante MAIN_MODULE_monmodule_NEEDSMARTY.
<source lang="php">
$this->const=array(1=>array('MAIN_MODULE_MONMODULE_NEEDSMARTY','chaine',1,'Need smarty',0));
</source>

Ceci aura pour effet, lors de l'initialisation de l'objet $conf, de remplir le tableau $conf->need_smarty des modules qui ont besoin de smarty et si au moins un module est requis, le code dans main.inc.php chargera systématiquement les librairies de Smarty.

=== Arborescence et fonctionnement ===
A compléter...

=== Réaliser vos pages templates ===
A compléter...

== 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 donnees de tableau.
* class="'''flat'''" sur tous les champs de saisie (''input, select, textarea''...).
* class="'''button'''" sur les objets de type ''input type="submit"''.

== Utiliser le sélecteur de date de Dolibarr ==

Si vous le désirez, vous pouvez profiter du sélecteur de date dans des écrans Dolibarr. Pour cela, utilisez la ligne suivante:
<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>

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

== Creer votre page d'édition de configuration ==
Si votre module offre plusieurs options paramétrables, il est nécessaire de créer une page PHP pour éditer les options (qui sont stockées dans la [[Table llx_const|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 ==
Aller sur la page '''Configuration->module''', vous devez voir apparaitre un icone qui permet d'accéder à la page de configuratione tvous devez etre capable de modifier ces options et les voir conservé en base.

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

== Définissez vos entrées menus ==
Pour cela, il vous faut définir dans le fichier descripteur de module, le tableau this->menu qui déclare les menus.
Ce tableau contient toutes les entrées qui apparaitront dans les menus une fois le module activé.
Le fichier de descripteur de module exemple '''modMyModule.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'=>'MyModule top menu',
'mainmenu'=>'mymodule',
'leftmenu'=>'1', // Use 1 if you also want to add left menu entries using this descriptor. Use 0 if left menu entries are defined in a file pre.inc.php (old school).
'url'=>'/mymodule/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->mymodule->enabled' if entry must be visible if module is enabled.
'perms'=>'1', // Use 'perms'=>'$user->rights->mymodule->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'=>'r=0', // Use r=value where r is index key used for the parent menu entry (higher parent must be a top menu entry)
'type'=>'left', // This is a Left menu entry
'titre'=>'MyModule left menu 1',
'mainmenu'=>'mymodule',
'url'=>'/mymodule/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->mymodule->enabled' if entry must be visible if module is enabled.
'perms'=>'1', // Use 'perms'=>'$user->rights->mymodule->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 le permission un peu plus loin pour savoir comment ajouter des permissions.

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

= [[File:Art.png]] 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ée 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 chaine action et sousaction sans espaces. Vous pourrez alors tester dans le code PHP si un utilisateurs a bien les droits par la séquence suivante:

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

= [[File:Art.png]] Définir vos propres box (optionnel) =
'''Quand''': Si votre module amène avec lui une ou plusieurs Boxes.

== Définissez vos box ==
Pour cela, modifier les tableaux $this->boxes du fichier descripteur de module.
Il suffit d'ajouter une ligne par fichier box qui se trouve dans le répertoire '''htdocs/includes/boxes'''

''Exemple:''
<source lang="php">
this->boxes[0][1]='mabox0.php'
this->boxes[1][1]='mabox1.php'
this->boxes[2][1]='mabox2.php'
...
this->boxes[n][1]='maboxn.php'
</source>

Ensuite creer les fichiers mabox0.php, mabox1.php... en prenant exemple sur des box existantes (dans le répertoire htdocs/include/boxes

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

Aller dans le menu '''Accueil - Configuration - Boite'''.

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

= [[File:Art.png]] 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.

= [[File:Art.png]] 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''' 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''.php.css'''. 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->style_sheet'''.
La valeur à renseigner ici doit être le chemin relatif de l'URL de votre fichier css.
Par exemple '/monmodule/monfichier.css'.

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

= [[File:Art.png]] 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 fichiers javascript '''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 déclarer votre fichier javascript dans le descripteur de module.

Cette fonctionnalité n'est pas encore possible.

= [[File:Art.png]] 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'action s 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]]

= [[File:Art.png]] Créer un package pour livrer et installer votre module =

* 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 CVS 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.tgz''' 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.tgz
</source>

* Si vous désirez que votre module profite à tous, vous pouvez le soumettre (le fichier tgz) sur le site web de Dolibarr dans la section téléchargements: http://www.dolibarr.org -> downloads -> contrib -> submit a file (vous devez avoir créer un compte auparavant et être loggué pour que le lien apparaisse).
** 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]] Quelques règles de codage =
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".

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

Documentation Développeur

2010-01-29T10:44:01Z

Dmartin: /* Développer un nouveau module/extension pour les IHM (nouveaux écrans) */

= Informations générales =
Ce chapitre regroupe des informations générales qu'il est nécessaire de lire avant de commencer toute action de développement sur Dolibarr.
# [[Projet Dolibarr|Organisation du projet]]
# [[Outils et principe|A savoir avant de commencer à developper]]
# [[Outils de développement|Environnement et Outils de développement]]
# [[Librairies externes et dépendances]]
# [[Langages et normes|Langage et normes de développement]]
# [[FAQ_D%C3%A9veloppeur#R.C3.A9cup.C3.A9rer.2Fmettre_.C3.A0_jour_la_version_CVS_d.C3.A9veloppeur|Récupérer une version depuis le CVS]]

= La configuration technique de Dolibarr =
La configuration technique de Dolibarr (mode authentification à l'application, identifiant de la base de données et location de l'espace de stockage des fichiers) est définie dans le seul fichier de configuration conf/conf.php.
Voir [[Fichier de configuration]] pour plus d'informations.

= La Base de données =
# [[Charte de nommage]]
# [[Liste des tables]]

= Liste des modules existant =
La documentation technique, spécifique à un module fonctionnel standard de Dolibarr, est définie sur la page de documentation développeur de chaque module. Choisissez la page qui vous concerne pour y accéder:

* La liste des modules standards est définie sur la page [[:Category:Liste des Modules|Liste des Modules]]
* La liste des modules complémentaires est définie sur la page [[:Category:Modules_complémentaires|Modules complémentaires]]

= Développer un nouveau module/extension pour les [http://fr.wikipedia.org/wiki/Interface_homme-machine IHM] (nouveaux écrans) =
Cette section décrit comment développer un nouveau module sur l'interface utilisateur de Dolibarr (IHM).
Un module pour l'IHM contient aussi bien des écrans que des données propres, voir une feuille de style.
Le développement de script ne rentre pas dans ce périmètre et est décrit au chapitre suivant.
Le développement de modules de numérotations, de documents, de thèmes ou de triggers est décrit dans des chapitres suivants également.

Pour développer votre propre module d'extension des IHM, aller sur le didacticiel: [[Développement module]]

= Développer un script ligne de commande ou batch =
Cette section décrit la procédure pour développer son propre script batch afin de réaliser des traitements dans Dolibarr (lecture, écriture, etc...).
La réalisation de modification sur l'interface utilisateur (IHM) ne rentre pas dans ce périmètre. Voir le chapitre précédent pour cela.

Pour développer un script quel qu'il soit, comme un script de traitement cron ou encore un script d'import de données issues d'un autre système, se référer à la page: [[Développement de scripts]]

= Le Système de paramétrage =
Il existe 2 niveaux de paramétrage dans Dolibarr.
* Le global est stocké dans la [[Table llx_const]].
* Le paramétrage propre à un utilisateur est stocké dans la [[Table llx_user_param]]

Voir la page [[Constantes]]

= Le Système de menus =
Voir la page [[Système de menus]]

= Le Système des thèmes =
Voir la page [[Themes]]

= Le Système des boites =
Voir la page [[Système des boites]]

= Le Système d'authentification =
Voir la page [[Authentification]]

= Le Système des permissions =
Voir la page [[Permissions]]

= Le Système de traduction =
Voir la page [[Système de traduction]]

= La Gestion d'erreur =

Voir la page [[Gestion d'erreur]]

= Les modules de numérotation =
Pour chaque entité créée dans l'application, Dolibarr attribue une référence. Afin de pouvoir adapter cette référence à toute utilisation, Dolibarr utilise des modules pour définir la règle de génération de cette référence. Des modules sont fournis en standard donc certains sont génériques et permettent de définir le masque de numérotation (nombre sur x caractère, avec ou sans prefix, incluant la date ou pas, etc), ce qui permet de répondre à la plupart des besoins. Toutefois, il existe toujours des cas où le module fourni en standard ne répond pas au besoin. Dans ce cas il est nécessaire de développer son propre module de numérotation.
Plus d'information sur la page [[Créer un module de numérotation]]

= Les modèles et la génération de documents =
Plus de documentation au sujet de la génération de documents depuis des modèles est disponible sur la page [[Creer un modele de document]]

= Le stockage des fichiers/documents =
Voir la page [[Document générés]]

= Les exports/imports de masse =
# [[Imports de masse]]
# [[Exports|Exports de masse]]

= Interfaces et liens avec d'autres applications =
# [[Interfaces Dolibarr vers exterieur]] (Triggers Dolibarr)
# [[Interfaces Exterieur vers Dolibarr]]
# [[Services Web]]

= FAQ =
Toutes FAQ sont disponibles via la page d'index [[:Category:FAQ FR|FAQ FR]]

Module Produits

2010-01-14T15:10:44Z

Dmartin: /* Configuration */

[[Category:Produit]]
{{TemplateDocUtil}}
{{TemplateModFR}}
{{BasculeDevUser|
nom=Produits|
num=50|
devdoc=[[Module Produits (développeur)]]|
userdoc=Cette page|}}

= Introduction =
Ce module permet de gérer un catalogue de produits. Voir aussi le [[Module Services]] pour gérer un catalogue de services.

= Installation =
{{NoInstallModuleFr}}

= Configuration =
{{ActivationModuleFr}}

'''Remarque :''' Une barre de recherche des produits peut être utilisée à la place de la liste déroulante (pratique si grand nombre de produits).

Il faut pour cela activer, dans le module produits, l'option "Utiliser une barre de recherche ..." et laisser AJAX/Javascript activé dans les paramètres d'interface utilisateur.

= Définition =
== Produits ==
Un produit Dolibarr est un bien à gérer, soit parce qu'il caractérise un objet proposé à des clients, soit parce qu'il caractérise un objet obtenus auprès de fournisseurs.
Il s'agit de biens matériels, contrairement aux [[Services]].

Un produit répond, en résumé, aux règles suivantes:
* Un produit peut se stocker dans un entrepôt (seuls les produits d'ailleurs apparaissent dans le module [[Module_Stock|Stock]]. Les services n'y apparaissent pas).
* Un produit peut se livrer (seuls les produits d'ailleurs apparaissent dans le module [[Module Expédition|Expedition]]. Les services n'y apparaissent pas. Ces derniers sont réalisés ou non, mais pas livrés).
* Un produit est en général un bien matériel. Sa valeur souvent se déprécie avec le temps (Un produit d'occasion vaut moins que le même produit neuf).

== Produits associés ==
Des produits associés sont des [[Produits|produits]] attachés à un produit père.

Un produit associé répond aux règles suivantes:
* Lors de l'ajout d'un produit dans un document (propale, facture, commande), seule la ligne du produit père est affichées.
* Le stock d'un sous-produit est incrémenté/décrémenté quand le produit est décrémenté.

= Cycle de vie / Règles de gestion =
{{ToComplete}}

= Exemples de cas d'utilisation =
{{ToComplete}}
{{ExamplesCaseFr
|nom=UCMP01:
|situation=
|actions=
}} 

Module Produits

2010-01-14T15:09:59Z

Dmartin: /* Configuration */

[[Category:Produit]]
{{TemplateDocUtil}}
{{TemplateModFR}}
{{BasculeDevUser|
nom=Produits|
num=50|
devdoc=[[Module Produits (développeur)]]|
userdoc=Cette page|}}

= Introduction =
Ce module permet de gérer un catalogue de produits. Voir aussi le [[Module Services]] pour gérer un catalogue de services.

= Installation =
{{NoInstallModuleFr}}

= Configuration =
{{ActivationModuleFr}}

'''Remarque :''' Une barre de recherche des produits peut être utilisée à la place de la liste déroulante (pratique si grand nombre de produits).
Il faut pour cela activer, dans le module produits, l'option "Utiliser une barre de recherche ..." et laisser AJAX/Javascript activé dans les paramètres d'interface utilisateur.

= Définition =
== Produits ==
Un produit Dolibarr est un bien à gérer, soit parce qu'il caractérise un objet proposé à des clients, soit parce qu'il caractérise un objet obtenus auprès de fournisseurs.
Il s'agit de biens matériels, contrairement aux [[Services]].

Un produit répond, en résumé, aux règles suivantes:
* Un produit peut se stocker dans un entrepôt (seuls les produits d'ailleurs apparaissent dans le module [[Module_Stock|Stock]]. Les services n'y apparaissent pas).
* Un produit peut se livrer (seuls les produits d'ailleurs apparaissent dans le module [[Module Expédition|Expedition]]. Les services n'y apparaissent pas. Ces derniers sont réalisés ou non, mais pas livrés).
* Un produit est en général un bien matériel. Sa valeur souvent se déprécie avec le temps (Un produit d'occasion vaut moins que le même produit neuf).

== Produits associés ==
Des produits associés sont des [[Produits|produits]] attachés à un produit père.

Un produit associé répond aux règles suivantes:
* Lors de l'ajout d'un produit dans un document (propale, facture, commande), seule la ligne du produit père est affichées.
* Le stock d'un sous-produit est incrémenté/décrémenté quand le produit est décrémenté.

= Cycle de vie / Règles de gestion =
{{ToComplete}}

= Exemples de cas d'utilisation =
{{ToComplete}}
{{ExamplesCaseFr
|nom=UCMP01:
|situation=
|actions=
}} 

Module Syslog (développeur)

2010-01-14T10:37:20Z

Dmartin: /* Remarque */

[[Category:Syslog]]
[[Category:Liste des Modules]]
{{TemplateDocDev}}
{{TemplateModFR}}
{{BasculeDevUser|
nom=Syslog|
num=42|
devdoc=Cette page|
userdoc=Aucune}}

= Fonction du module =

Ce module permet d'activer la fonction de logging (journalisation) dans Dolibarr.

= Détails du module =

Le logging permet d'enregistrer des messages de log :

* Dans un fichier
** Le fichier par défaut sera '''DOL_DATA_ROOT/dolibarr.log''' (par exemple '''www.monsite.fr/dolibarr/documents/dolibarr.log''').
** Il est possible de changer le fichier d'enregistrement dans la page de configuration du module.
* Dans les logs PHP (avec la fonction syslog())

= Fonction PHP =

== Définition ==

Pour utiliser le logging dans du code PHP, il faut utiliser la fonction suivante :

<source lang="php">
dol_syslog($message, $level = LOG_INFO)
</source>

''Cette fonction est définie à la ligne 22 du fichier dolibarr/htdocs/lib/functions.lib.php''

== Paramètres ==

* '''$message''' : chaîne à enregistrer dans le fichier de log
* '''$level''' : constante permettant d'indiquer le niveau du message. Elle peut prendre les valeurs suivantes:
** Sur serveur Windows : LOG_ERR=4, LOG_WARNING=5, LOG_NOTICE=LOG_INFO=LOG_DEBUG=6
** Sur serveur Unix : LOG_ERR=3, LOG_WARNING=4, LOG_INFO=6, LOG_DEBUG=7
** Il est ensuite possible de configurer le niveau d'enregistrement des logs dans la page de configuration du module.

= Remarques =

''"Les fonctions syslog sont bugguées sous Windows et genèrent des fautes de protection mémoire.''

''Pour resoudre, utiliser le loggage fichier, au lieu du loggage syslog (configuration du module). Si SYSLOG_FILE_NO_ERROR défini, on ne gère pas erreur écriture log."''

Source: documentation Doxygen

= Voir aussi =

Documentation Doxygen : [http://www.dolibarr.fr/doxygen/d9/d69/functions_8lib_8php.html#a9862cc723ca3a2d05ef5723946cc9250]

{{ToComplete}}

Module Syslog (développeur)

2010-01-14T10:36:02Z

Dmartin: /* Fonction du module */

[[Category:Syslog]]
[[Category:Liste des Modules]]
{{TemplateDocDev}}
{{TemplateModFR}}
{{BasculeDevUser|
nom=Syslog|
num=42|
devdoc=Cette page|
userdoc=Aucune}}

= Fonction du module =

Ce module permet d'activer la fonction de logging (journalisation) dans Dolibarr.

= Détails du module =

Le logging permet d'enregistrer des messages de log :

* Dans un fichier
** Le fichier par défaut sera '''DOL_DATA_ROOT/dolibarr.log''' (par exemple '''www.monsite.fr/dolibarr/documents/dolibarr.log''').
** Il est possible de changer le fichier d'enregistrement dans la page de configuration du module.
* Dans les logs PHP (avec la fonction syslog())

= Fonction PHP =

== Définition ==

Pour utiliser le logging dans du code PHP, il faut utiliser la fonction suivante :

<source lang="php">
dol_syslog($message, $level = LOG_INFO)
</source>

''Cette fonction est définie à la ligne 22 du fichier dolibarr/htdocs/lib/functions.lib.php''

== Paramètres ==

* '''$message''' : chaîne à enregistrer dans le fichier de log
* '''$level''' : constante permettant d'indiquer le niveau du message. Elle peut prendre les valeurs suivantes:
** Sur serveur Windows : LOG_ERR=4, LOG_WARNING=5, LOG_NOTICE=LOG_INFO=LOG_DEBUG=6
** Sur serveur Unix : LOG_ERR=3, LOG_WARNING=4, LOG_INFO=6, LOG_DEBUG=7
** Il est ensuite possible de configurer le niveau d'enregistrement des logs dans la page de configuration du module.

= Remarque =

''"Les fonctions syslog sont bugguées sous Windows et genèrent des fautes de protection mémoire.

Pour resoudre, utiliser le loggage fichier, au lieu du loggage syslog (configuration du module). Si SYSLOG_FILE_NO_ERROR défini, on ne gère pas erreur écriture log."''

= Voir aussi =

Documentation Doxygen : [http://www.dolibarr.fr/doxygen/d9/d69/functions_8lib_8php.html#a9862cc723ca3a2d05ef5723946cc9250]

{{ToComplete}}