Développement module: Difference between revisions

Jump to navigation Jump to search
Line 46: Line 46:
== Arborescence d'un nouveau module ==
== Arborescence d'un nouveau 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):
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):
 
{{TemplateModuleTree}}
* htdocs/includes/modules/ contains module descriptor file modMyModule.class.php
* htdocs/mymodule/admin/ contains pages to setup module
* htdocs/mymodule/class/ contains PHP class files provided by module
* htdocs/mymodule/css contains CSS files provided by module
* htdocs/mymodule/img contains images files provided by module
* htdocs/mymodule/includes/triggers contains triggers provided by module
* htdocs/mymodule/langs/en_US contains language files for module internationalisation
* htdocs/mymodule/lib contains libraries provided and used by module
* htdocs/mymodule/sql contains SQL file provided by module to add new tables or indexes
* htdocs/mymodule/themes/mytheme if module provide its own skin
 
 
Note: Depuis la 3.1 il est possible de définir dans htdocs/conf/conf.php les variables $dolibarr_main_url_root_alt et $dolibarr_main_document_root_alt qui seront accessible partout dans le code via DOL_DOCUMENT_ROOT_ALT et DOL_MAIN_URL_ROOT_ALT
 
Cela permet d'avoir son module et tout les fichier associés comme suit,
si par exemple
$dolibarr_main_url_root_alt='http://(domainName)/dolibarr/htdocs/custom';
$dolibarr_main_document_root_alt='(chemin absolue c:/... ou /var/www/...)/dolibarr/htdocs/custom';
 
* htdocs/custom/includes/modules/ contains module descriptor file modMyModule.class.php
* htdocs/custom/mymodule/admin/ contains pages to setup module
* htdocs/custom/mymodule/class/ contains PHP class files provided by module
* htdocs/custom/mymodule/css contains CSS files provided by module
* htdocs/custom/mymodule/img contains images files provided by module
* htdocs/custom/mymodule/includes/triggers contains triggers provided by module
* htdocs/custom/mymodule/langs/en_US contains language files for module internationalisation
* htdocs/custom/mymodule/lib contains libraries provided and used by module
* htdocs/custom/mymodule/sql contains SQL file provided by module to add new tables or indexes
* htdocs/custom/mymodule/themes/mytheme if module provide its own skin


== Créer vos tables SQL et les classes PHP DAO (optionnel) ==
== Créer vos tables SQL et les classes PHP DAO (optionnel) ==

Navigation menu