Difference between revisions of "Module Dolistore Validation Rules"

From Dolibarr ERP CRM Wiki
Jump to navigation Jump to search
Line 29: Line 29:
 
=== Core file modifications ===
 
=== Core file modifications ===
 
If dolibarr core files have to be modified, it will be accepted :
 
If dolibarr core files have to be modified, it will be accepted :
* If they are pushed to dolibarr dev branch on GitHub (add feature to standard class without risk of regression, html.form.class.php/function.lib.php,...)
+
* If they are pushed to dolibarr '''develop''' branch on GitHub
* If what you push is adding hooks or triggers, or optionnal parameter to existing functions.
+
* If what you push is adding hooks or triggers, or optionnal parameter to existing functions, it should be accepted with no condition. For other change, it may depends if change keeps old code compatible and is interesting for everybody.
  
 
=== Support ===
 
=== Support ===

Revision as of 15:03, 6 May 2015

Art.png Enabling/activation condition of external module on DoliStore

Here are the rules that will be apply by Dolibarr team on validation/activation of external module on [www.dolistore.com www.dolistore.com]

Structure

All module files have to be inside module directory, check this template GitHub Dolibarr Module Template

Inclusion

  • To include a core file, use
include_once/require_once/include/require DOL_DOCUMENT_ROOT.'/pathtofile';
  • To include a file of module into a file of same module, use
include_once/require_once/include/require './mymoduledir/...';
  • To include a file of another external module into a module file, use
dol_include_once('/otherextmoduledir/...');

Link

All link to a page of a standard dolibarr object (an invoice, an order, a bank account, ...) should be included into your module page using the getNomUrl method of the class of the object.

Custom directory management

An external module called mymodule can be installed into htdocs/custom/mymodule as well as in htdocs/mymodule. It must works in both cases

Core file modifications

If dolibarr core files have to be modified, it will be accepted :

  • If they are pushed to dolibarr develop branch on GitHub
  • If what you push is adding hooks or triggers, or optionnal parameter to existing functions, it should be accepted with no condition. For other change, it may depends if change keeps old code compatible and is interesting for everybody.

Support

If your module is not free you have to give a email adress for support (or a website that allow customers to contact you)

Product description is mandatory in English, French, Spanish (and support email as well)