Module development: Difference between revisions

Module development (view source)

Revision as of 20:26, 1 July 2009

163 bytes removed , 17 years ago

m

→‎Create your module descriptor

VisualWikitext

Eldy

Bureaucrats, Interface administrators, Administrators

31,003

edits

@@ Line 17: / Line 17: @@
 == Create your module descriptor ==
-{{ToTranslate}}
+The first step is to create a file descriptor for the module. To do this go into the directory dev/skeletons and copy the file modMyModule.class.php in the directory htdocs/includes/modules.
+Then change the contents of this file to replace:
-La première étape est donc de créer un fichier descripteur du module.
+    * all "modMyModule" with a value which corresponds to the vocation of your module. This value must always start with 'mod'.
-Pour cela, aller dans le répertoire '''dev/skeletons''' et recopier le fichier modMyModule.class.php dans le répertoire
+    * $this->numero = 10000 by a number of free module (Go to Home page -> System Information -> Dolibarr to know id the list of modules used).
-'''htdocs/includes/modules'''.
+    * $this->const_name = 'MAIN_MODULE_MYMODULE' by $this-> const_name = 'MAIN_MODULE_XXX' where XXX must match the value chosen to replace MyModule and put in capitalized.
-Ensuite, modifier le contenu de ce fichier afin de remplacer:
+    * $dir = DOL_DOCUMENT_ROOT.'/mysql/tables/mymodule/'; by $dir = DOL_DOCUMENT_ROOT.'/mysql/tables where xxxxxxxx is the name of your module (without spaces).
-* les ''modMyModule'' en une valeur qui corresponde a la vocation de votre module. Cette valeur doit toujours commencer par 'mod'.
+    * Modify any other variables defined in the constructor (see comment in the code skeleton for their meaning).
-* $this->numero = ''10000'' par un numero de module libre (Aller dans la page Accueil -> Infos système -> Dolibarr pour connaitre la liste des id module deja utilises).
-* $this->const_name = 'MAIN_MODULE_MYMODULE' par $this->const_name = 'MAIN_MODULE_XXX' où XXX doit correspondre à la valeur choisie pour remplacer MYMODULE et mis en majuscule.
-* $dir = DOL_DOCUMENT_ROOT.'/mysql/tables/mymodule/'; par $dir = DOL_DOCUMENT_ROOT.'/mysql/tables/xxxxxxxx/'; ou xxxxxxxx représente le nom de votre module (sans espaces).
-* Modifier éventuellement les autres variables définies dans le constructeurs (Voir le commentaire dans le code du squelette pour leur signification).
-Votre fichier descripteur de votre module est alors en place.
+Your file descriptor for your module is ready.
 == Tester votre descripteur ==