Module development: Difference between revisions

Jump to navigation Jump to search
no edit summary
No edit summary
Line 524: Line 524:
** If your module was build correctly, file will be validated later.
** If your module was build correctly, file will be validated later.
** If quality is enough and license permits it, code might be added inside main Dolibarr sources (except if you disagree for that).
** If quality is enough and license permits it, code might be added inside main Dolibarr sources (except if you disagree for that).
= [[File: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]
=== Inclusion ===
*To include a core file, use include_once/require_once/include/require DOL_DOCUMENT_ROOT.'/pathtofile';
*To include to a module file from a module file, use include_once/require_once/include/require './mymodulefile';
*To include to a module file from a core file (call by hook / trigger / speciales pages), use dol_include_once('/My_Module_directory/...');
=== Link ===
All link to generated by HTML should be done by getNomUrl object class method or at least using dol_buildpath
=== Custom directory ===
An external module can be use in htdocs/custom/mymodule as well as in htdocs/mymodule
   
=== Core file modifications ====
If core dolibarr files have to be modified for feature of your module :
*They were be accepted si 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,...)
*They were be accepted if adding hook/trigger is pushed to dolibarr dev branch on GitHub to be sure that on next dolibarr version your next module version will not have to change dolibarr core code 
In all cases:
* If and only if they are test with
    if (!empty($conf->mymodule->enabled))
Bureaucrats, emailconfirmed, Administrators
825

edits

Navigation menu