Développement module: Difference between revisions

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.

Les sous chapitres suivant dévrivent les actions à faire pour créer un module Dolibarr. Les premiers chapitre sont obligatoires quelquesoit la vocation du modules, les suivant dépendront de ce que doit faire le module.

'''Quand''': Obligatoire dès qu'une extension est développée, quelque soit sa vocation.

C'est la valeur de $this->special qui détermine dans quel onglet se trouve votre module.

Créer un répertoire 'monmodule' qui recevra les fichiers du module. Ce répertoire doit etre dans le répertoire '''htdocs''' et contiendra les sous-répertoires suivants (seul la premiere ligne est obligatoire):

* htdocs/custom/mymodule/themes/mytheme if module provide its own skin

'''Quand''': Si votre module a besoin de gérer des données qui lui sont propres

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

=== Ajouter ou supprimer des onglets sur les fiches objets ===

Pour plus de détail, se référer à la [http://www.dolibarr.fr/doxygen/ documentation Doxygen] ou directement au code de Dolibarr.

'''Quand''': Si l'objet de votre module est d'ajouter des fonctionnalités qui nécessitent de nouveaux écrans.

</source>

'''Quand''': Si votre module offre plusieurs options paramétrables.

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

'''Quand''': Si vous avez créé des pages PHP, il est nécessaire que ces écrans soient accessibles depuis le menu Dolibarr.

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

'''Quand''': Si vous voulez ajouter de nouvelles permissions.

</source>

'''Quand''': Si votre module amène avec lui une ou plusieurs Boxes.

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.

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

Choisir quelques champs et tenter une génération du fichier export.

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

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

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

</source>

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

et [[Interfaces_Exterieur_vers_Dolibarr|Interfaces exterieures vers Dolibarr]]

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

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