Difference between revisions of "Modules - Règles de packaging et validation DoliStore"

From Dolibarr ERP CRM Wiki
Jump to navigation Jump to search
Line 1: Line 1:
= [[File:Art.png]] Validation/activation du module externe sur Dolistore =
+
= [[File:Art.png]] Validation/activation d'un module externe sur Dolistore =
  
Voici les régles qui prévale a la validation d'un module soumis a validation sur http://www.dolistore.com.
+
Voici les règles qui prévalent lors de la soumission à validation d'un module sur http://www.dolistore.com.
Ces règles s'appliquent à des soumissions de modules pour Dolibarr. Les fichiers mis à disposition sur dolistre d'autre nature (documentation, outils externes autres) ne sont pas concernés.
+
Ces règles s'appliquent à des soumissions de modules pour Dolibarr. Les fichiers d'autre nature (documentation, outils externes, autres) mis à disposition sur dolistore  ne sont pas concernés.
  
 
=== Structure ===
 
=== Structure ===
Tout les fichiers du module doivent être dans le répertoire du module, voir le modèle [https://github.com/rdoursenaud/dolibarr-module-template GitHub Dolibarr Module Modèle]
+
Tous les fichiers du module doivent être dans le répertoire du module, voir le modèle [https://github.com/rdoursenaud/dolibarr-module-template GitHub Dolibarr Module Modèle]
  
 
=== Inclusion ===  
 
=== Inclusion ===  
* Toutes les inclusions de fichier coeur doivent être réalisé par include_once/require_once/include/require DOL_DOCUMENT_ROOT.'/pathtocorefile';
+
* Toutes les inclusions de fichier coeur doivent être réalisées par include_once/require_once/include/require DOL_DOCUMENT_ROOT.'/pathtocorefile';
 
* Toutes les inclusions de fichiers spécifiques au module par les pages du modules doivent être faites avec include_once/require_once/include/require './monmoduledir/...';
 
* Toutes les inclusions de fichiers spécifiques au module par les pages du modules doivent être faites avec include_once/require_once/include/require './monmoduledir/...';
* Toutes les inclusions de fichiers spécifiques à un autre module externe doit être fait par dol_include_once('/extmoduledir/...');
+
* Toutes les inclusions de fichiers spécifiques à un autre module externe doivent être faites par dol_include_once('/extmoduledir/...');
  
 
=== Lien ===  
 
=== Lien ===  
Tous les liens générées pour le HTML vers les pages spécifique (href, src,...) du module devrait utiliser getNomURL de la class d'un object ou à minima utiliser dol_buildpath
+
Tous les liens générés pour le HTML vers les pages spécifiques (href, src,...) du module devraient utiliser getNomURL de la classe d'un object ou à minima utiliser dol_buildpath
  
=== Réperoire Custom ===  
+
=== Répertoire Custom ===  
 
Un module externe de dolibarr doit pouvoir se mettre dans un répertoire htdocs/custom, tout comme dans htdocs/, et il doit fonctionner dans les deux cas.
 
Un module externe de dolibarr doit pouvoir se mettre dans un répertoire htdocs/custom, tout comme dans htdocs/, et il doit fonctionner dans les deux cas.
 
      
 
      

Revision as of 11:16, 18 January 2014

Art.png Validation/activation d'un module externe sur Dolistore

Voici les règles qui prévalent lors de la soumission à validation d'un module sur http://www.dolistore.com. Ces règles s'appliquent à des soumissions de modules pour Dolibarr. Les fichiers d'autre nature (documentation, outils externes, autres) mis à disposition sur dolistore ne sont pas concernés.

Structure

Tous les fichiers du module doivent être dans le répertoire du module, voir le modèle GitHub Dolibarr Module Modèle

Inclusion

  • Toutes les inclusions de fichier coeur doivent être réalisées par include_once/require_once/include/require DOL_DOCUMENT_ROOT.'/pathtocorefile';
  • Toutes les inclusions de fichiers spécifiques au module par les pages du modules doivent être faites avec include_once/require_once/include/require './monmoduledir/...';
  • Toutes les inclusions de fichiers spécifiques à un autre module externe doivent être faites par dol_include_once('/extmoduledir/...');

Lien

Tous les liens générés pour le HTML vers les pages spécifiques (href, src,...) du module devraient utiliser getNomURL de la classe d'un object ou à minima utiliser dol_buildpath

Répertoire Custom

Un module externe de dolibarr doit pouvoir se mettre dans un répertoire htdocs/custom, tout comme dans htdocs/, et il doit fonctionner dans les deux cas.

Modifications de fichier core Dolibarr

Si des modifications de fichiers coeur de Dolibarr nécessaire au module sont soumises, elles seront acceptées :

  • Si elles sont poussées dans la branche dev du GitHub de Dolibarr (cas d'enrichissement de fonctionnalité Dolibarr, html.form.class.php, function.lib.php)
  • Si il s'agit d'ajout de hook, trigger ou fonction, ou ajout de paramètres optionnels à des fonctions existantes.