Difference between revisions of "Module Dolistore Validation Rules"

From Dolibarr ERP CRM Wiki
Jump to navigation Jump to search
Line 6: Line 6:
  
 
=== Inclusion ===  
 
=== Inclusion ===  
* To include a core file, use include_once/require_once/include/require DOL_DOCUMENT_ROOT.'/pathtofile';
+
* To include a core file, use
* To include a file of module into a file of same module, use include_once/require_once/include/require './mymoduledir/...';
+
<source lang="php">
* To include a file of another external module into a module file, use dol_include_once('/otherextmoduledir/...');
+
include_once/require_once/include/require DOL_DOCUMENT_ROOT.'/pathtofile';
 +
</source>
 +
 
 +
* To include a file of module into a file of same module, use  
 +
<source lang="php">
 +
include_once/require_once/include/require './mymoduledir/...';
 +
</source>
 +
 
 +
* To include a file of another external module into a module file, use  
 +
<source lang="php">
 +
dol_include_once('/otherextmoduledir/...');
 +
</source>
  
 
=== Link ===  
 
=== Link ===  

Revision as of 14:56, 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 generated by HTML should be done by getNomUrl object class method or at least using dol_buildpath

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 dev branch on GitHub (add feature to standard class without risk of regression, html.form.class.php/function.lib.php,...)
  • If what you push is adding hooks or triggers, or optionnal parameter to existing functions.

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)