Dolibarr ERP CRM Wiki - User contributions [en]

Module development

2025-04-18T17:48:39Z

TanguyP: Improve troubleshooting for SQL scripts (based on my personal experience)

[[fr:Développement_module]]
[[es:Desarrollo_de_un_módulo]]
[[de:Modul_Entwicklung]]
[[zh:模块开发]]
[[ja:モジュール_開発]]


[[Category:Core]]
{{TemplateDocDevEn}}

To create a new module/addon for Dolibarr, there are several steps. This tutorial will describe each of them to let you build a module that extends Dolibarr features, such as:

*Add new tables in database.
*Add your own menu entries.
*Add new screens to edit new tables.
*Add or remove tabs on object view (invoice, product, order, event, ...).
*Add predefined exports for the internal export tool.
*Add new information widget in the home page.
*Add new substitutions variables.
*Define new permissions.
*Execute code automatically triggered by a particular Dolibarr action.
*Insert your code inside Dolibarr hooks positions.
*Add your numbering rule to generate the reference of objects
*Add a new document template.
*Add a new skin.

etc...

The following chapters explain how to do all of this manually in an easy way.

=Module creation with the module builder=
From Dolibarr v. 12.0 it is possible to create the main pages of your module with the Module Builder. To activate it:

Go into the list of modules and enable the "Module Builder" module:
[[File:Module Builder.png|alt=Module Builder|thumb|none]]

Then click on the "bug" image in the top right of screen.[[File:Module Builder icon.png|alt=Module Builder icon|left|thumb]]
<br />
=Template of an External Module=
A good model to start development of external module can be found here : [https://github.com/Dolibarr/dolibarr/tree/develop/htdocs/modulebuilder/template GitHub Dolibarr Module Template]

=Create your module=
==Create a Module descriptor for your Module (required)==
'''When it is required''': Required as soon as an addon is developed, whatever its goal is (only adding a skin does not require a module descriptor file).

'''Since Dolibarr 9.0, you should use the ModuleBuilder module provided as a standard module to generate the module descriptor'''

===Create your module descriptor===
The first step is to create a file descriptor for the module.

*Create directory '''/htdocs/custom/''mymodule''/core/modules''' (for an external module) or '''/htdocs/''mymodule''/core/modules''' if you plan to have this module an official core module of Dolibarr. Then copy the file <code>modMyModule.class.php</code> from the directory '''htdocs/modulebuilder/template''' into this directory. Change the name of the file <code>modMyModule.class.php</code> to the name corresponding to the purpose of your module. Name of the file must start with <code>mod</code> and end with <code>.class.php</code> (for example if you want to give the name 'NewName' to this file, then the name should be <code>modNewName.class.php</code>).

Then, modify the contents of this file as follows:

*Replace all occurrences of "modMyModule" with a value which corresponds to the purpose of your module. This value must always start with 'mod' and contain only alpha characters (again, if the name given to the file was 'NewName', then replace all "modMyModule" with "modNewName").
*Change the number in: $this->numero = 100000 by a number that designates your module id. To avoid conflicts with other modules, you can consult the page that lists already reserved id numbers: [[List of modules id|List of module IDs]].
*Modify any other variables defined in the constructor (see comment in the code skeleton for their meaning).

Your file descriptor for your module is ready. See the next step to activate it.

===Test your descriptor===

Launch Dolibarr and go to page '''Setup->module'''?
If you set the property version in the module description you should see a new line with your new module and the possibility to activate it or not. If you set the property version to "develop" or "experiental", to see your module, you must first go into '''Setup-Others''' and set MAIN_FEATURES_LEVEL to 1 to see "experimental" modules or 2 to see "development" modules.

==Tree of path for new module files (required)==
This is how your files must be organized when building a new module (the zip file must also match this rule).
Note: Only the second line is mandatory.

{{TemplateModuleTreeSimple}}

==Create your SQL tables and the PHP DAO class (optional)==
'''When''': If your module needs to manage data of its own

===Create your .sql file===
If your module is designed to manage data of its own, which are not available in the standard version of Dolibarr, it is necessary to define SQL tables to store the data.

Scripts for creating tables and loading data by your own module are saved into a subdirectory sql ('''"mymodule/sql"''') of your module. (With ModuleBuilder, the directory and all sql files will be created automatically when you will create a new Object from tab Object).

Then check into your descriptor file, into function '''init''' that the line

<syntaxhighlight lang="PHP">$this->_load_tables('/mymodule/sql/');</syntaxhighlight>

is not commented.

''Rules to follow:''

*Add the files about creating tables commands on the principle of an '''llx_mytable.sql''' file per table, with an optional '''llx_mytable.key.sql''' file (see existing files in '''install/mysql/tables''' for examples).
*The recommended type and name for SQL fields are defined into page [[Language_and_development_rules#Table_and_fields_structures]].
*To manage data, you must create a file called '''data.sql''' inside directory '''/mymodule/sql/''' that contains SQL command to add/edit/delete data.
*Don't use the double quote for strings (eg 'chaine' not "chaine") because the double quote have a specific meaning in PostGreSQL

Example of content of a file data.sql
<syntaxhighlight lang="sql">
delete from llx_const where name='MYMODULE_IT_WORKS' and entity='__ENTITY__';
insert into llx_const (name, value, type, note, visible, entity) values ('MYMODULE_IT_WORKS','1','chaine','A constant vor my module',1,'__ENTITY__');
</syntaxhighlight>

Files must be operational for the database mysql. Note: The files of other databases are not maintained. They will be read and converted on the fly by the driver of the other database.

===Test your .sql files===

Once the files ready, you can return to the page to enable Dolibarr modules and disable the module, drop those tables in the database (if they already exist) and reactivate the module. The tables should be recreated by the activation of the module. If this is not the case, check the Dolibarr logs, or as a first step try running your scripts manually on your database (because SQL errors from your scripts may not show up in the Dolibarr logs).

===Generate the PHP DAO class===
The DAO PHP files should have been generated by ModuleBuilder after creating an object.

You can however create them manually by copying existing object however using ModuleBuilder is highly recommended. You should find examples into '''htdocs/modulebuilder/templates/class/myobject.class.php'''

In this class, there are already operational CRUD (Create/Read/Update/Delete) methods to perform an insert, a fetch (select), an update, a delete of a table row. Edit the file to use the correct module name, tables and place this file in the class subdirectory of the module. The Module Builder allows you to do this with just a few mouse clicks.

==The tab management (optional)==

===Add or remove your own tabs on object sheets===
'''When''': To add a tab on an object (invoices, orders, proposals, member ...)

To do this go into the file descriptor of module previously created and edit the $this->tabs array:

<syntaxhighlight lang="PHP">
// Array to add new pages in new tabs or remove existing one
$this->tabs = array('objecttype:+tabname1:Title1:mylangfile@mymodule:$user->rights->mymodule->read:/mymodule/mypagetab1.php?id=__ID__' // To add a new tab identified by code tabname1
'objecttype:+tabname2:Title2:mylangfile@mymodule:$user->rights->mymodule->read:/mymodule/mypagetab2.php?id=__ID__', // To add a new tab identified by code tabname2
'objecttype:-tabname'); // To remove an existing tab identified by code tabname
</syntaxhighlight>

The table should contain a list of strings, each string representing a new tab.
The format of the string consisting of 5 parts separated by ":"

*Part 1: The element type (object type) where the tab should appear is a value from the following:
{{TemplateModuleTabs}}

*Part 2: A code to identify tab to add (start with +tabname1) or to remove (start with -tabname1)
*Part 3: The title of the tab(Title1). This can be a hardcoded read or better a code translation in module lang file .
*Part 4: The name of the file "*.lang" (mylangfile@mymodule) which contains correspondence between the code translation and language to display. If this name is followed with @mymodule, Dolibarr will search translation file "*.lang" within the module in htdocs/custom/mymodule/langs/code_CODE/mylangfile.lang, otherwise Dolibarr will look for file in htdocs/langs/code_CODE/mylangfile.lang
*Part 5: A condition to test if tab must be visible($user->rights->mymodule->read) '''or''' put 1 to be always visible.
*Part 6: The URL of the page to display when you click on the tab (/mymodule/mypagetab1.php). The __ID__ string will be replaced automatically by the Id of the element concerned.

To feed the contents of the tab with data from the database, see the next chapter.

In order to get the names 'tabname' of existing tabs, you have to check the names used in the function 'product_prepare_head' of the file 'core/lib/module.lib.php' corresponding to section '$head[$h][2]'.

===Show tabs navigation into your own pages===
'''When''': To show all standard tabs of an object (product, tiers, etc.) on your page.

You must follow these steps :

'''1. Include files you need into your file'''

For each object type, there are two files to include with line
<syntaxhighlight lang="PHP">require_once($url_fichier) ;</syntaxhighlight>

This is example of files to include (DOL_DOCUMENT_ROOT is often dolibarr/htdocs/) :

*Object thirdparty (thirdparty) :
**DOL_DOCUMENT_ROOT/societe/class/societe.class.php
**DOL_DOCUMENT_ROOT/core/lib/company.lib.php
*Object product (product) :
**DOL_DOCUMENT_ROOT/product/class/product.class.php
**DOL_DOCUMENT_ROOT/core/lib/product.lib.php
*Object invoice (invoice) :
**DOL_DOCUMENT_ROOT/compta/facture/class/facture.class.php
**DOL_DOCUMENT_ROOT/core/lib/invoice.lib.php

...

'''2. Create and load the object to show into your tab'''

Create an instance of an object of the correct class and load object from the database by using the fetch method of an object in providing to this method the id you get from URL (ie : /mytab.php?id=1).

''Example :''
<syntaxhighlight lang="PHP">
$id=GETPOST('id','int');
$ref=GETPOST('ref','alpha');
$product = new Product($db) ;
$result = $product->fetch($id,$ref) ; // Test $result to check the database read is ok
</syntaxhighlight>

'''3. Get a list of all tabs to show for your object type'''

Use function XXX_prepare_head($obj), where XXX is name of object. This will return an array with all definition of tab entries to show. The parameter to put into this method is the instance of an object you want tabs.

The resulting array has the following structure
<syntaxhighlight lang="PHP">
$head // Array of tabs
$head[$h] // Element to describe one tab.
$head[$h][0] // Url of page to show when you click on tab
$head[$h][1] // Title of tab
$head[$h][2] // Code name to identify the tab
</syntaxhighlight>

''Example :''
<syntaxhighlight lang="PHP">
$head = product_prepare_head($product, $user) ; // parameter $user is present for some function anly
</syntaxhighlight>

'''4. show tabs on your page'''

Use the <code>dol_fiche_head()</code> function to show all tabs defined in the <code>$head</code> array returned by <code>XX_prepare_head()</code>.

<syntaxhighlight lang="PHP">
dol_fiche_head($links, $active='0', $title='', $notab=0, $picto='')
//$links // Tableau des onglets, appelé $head plus haut.
//$active // Onglet actif (mettre le nom de l'onglet défini dans votre fichier de module, ou un nom contenu dans $head[$h][2]). Cet onglet sera mis en surbrillance
//$title // Title to show (shown into a special tab that you can't click)
//$notab
//$picto // Name of image to show into title. Possible values are:
// product
// service
// company
</syntaxhighlight>

This function will show required tabs and open an html element ''< div class="" >'' that correspond to the area under the tabs. To close area of a tab, just use ''< /div >'' into your PHP page.

==Create or modify PHP screens (optional)==
'''When''': If the purpose of your module is to add features that require new or modified screens.

===Create a new PHP screen===
You must then create your PHP pages that will show/edit data from tables using the skeleton templates provided as an example in the directory '''modulebuilder/myobject_page.php''' (For the development of a script from the command line, see [[Script development]]).

To create a new user screen, create a subdirectory of '''htdocs''' (if not already done) for your module (in '''htdocs/mymodule''' for example) to store the pages you will create.

Copy, into that directory, the file '''myobject_page.php''' that will serve as a starting point for your page file.
Edit the file to have a correct relative path to the main.inc.php file.
<syntaxhighlight lang="PHP">
// Load Dolibarr environment
$res=0;
// Try main.inc.php into web root known defined into CONTEXT_DOCUMENT_ROOT (not always defined)
if (! $res && ! empty($_SERVER["CONTEXT_DOCUMENT_ROOT"])) $res=@include($_SERVER["CONTEXT_DOCUMENT_ROOT"]."/main.inc.php");
// Try main.inc.php into web root detected using web root calculated from SCRIPT_FILENAME
$tmp=empty($_SERVER['SCRIPT_FILENAME'])?'':$_SERVER['SCRIPT_FILENAME'];$tmp2=realpath(__FILE__); $i=strlen($tmp)-1; $j=strlen($tmp2)-1;
while($i > 0 && $j > 0 && isset($tmp[$i]) && isset($tmp2[$j]) && $tmp[$i]==$tmp2[$j]) { $i--; $j--; }
if (! $res && $i > 0 && file_exists(substr($tmp, 0, ($i+1))."/main.inc.php")) $res=@include(substr($tmp, 0, ($i+1))."/main.inc.php");
if (! $res && $i > 0 && file_exists(dirname(substr($tmp, 0, ($i+1)))."/main.inc.php")) $res=@include(dirname(substr($tmp, 0, ($i+1)))."/main.inc.php");
// Try main.inc.php using relative path
if (! $res && file_exists("../main.inc.php")) $res=@include("../main.inc.php");
if (! $res && file_exists("../../main.inc.php")) $res=@include("../../main.inc.php");
if (! $res && file_exists("../../../main.inc.php")) $res=@include("../../../main.inc.php");
if (! $res) die("Include of main fails");
</syntaxhighlight>
As you can see, there are several tries to load the main.inc.php (or master.inc.php). The goal is to succeed in the most cases as possible. The minimum is 2 lines: one to try to load the master/main.inc.php into the dolibarr root directory and another one to try to load the file to support the case when the module is deployed into the "custom" directory. But you can have more to deal more situation. The provided example should be able to load the file main/master.inc.php in nearly all situation/setups.

Note that you may add more "../" depending on the depth of the file relative to your module directory tree.

It's in the main.inc.php file that is loaded technical environment variables and permissions. The following variables are objects positioned in this file:

*$user Object that contains the characteristics of the user + his permissions.
*$conf Object that contains Dolibarr configuration.
*$db Object that contains an opened connection handler to the database.
*$langs Object that contains the user's language.

Then enter your code to display the page.

*To include a class or library dedicated to the module is done using a Dolibarr function (and not using directly include_once):

''Example :''
<syntaxhighlight lang="PHP">
dol_include_once('/mymodule/class/myclass.class.php', 'MyClass');
</syntaxhighlight>

*To include classes provided with Dolibarr, use the following syntax:

''Example :''
<syntaxhighlight lang="PHP">
require_once DOL_DOCUMENT_ROOT.'/core/class/doli.class.php';
</syntaxhighlight>

===Add some fields into existing forms===
You may want to provide a module that adds more fields into forms (input and view) of some elements.

A heavy solution (but not so bad) may be to replace all pages used to create element (this means disabling the "New element" menu entry and adding yours, and disabling the tab that shows the element to replace with a tab that is your own full page (copied/pasted from original) to do same than original page but modified to add your fields and stored added data into your own table). Go to menu [[#Define your entries in the menu (optional)]] and [[#The tab management (optional)]] if this solution suits you (this solution is more powerful since you can change everything you want into the page).

We will describe here another solution, that works only to "add fields" at end of existing fields, using the element "category" as an example but you can convert this tutorial for invoice, proposal ...

*First thing is to add a table, owned by your module, to store the value of new fields. This table will only have one column called <code>rowid</code> (will contain the same value as the <code>rowid</code> column in the element table) + one column for each new field you want to add. Then, create a class with CRUD (Create/Read/Update/Delete) methods for this new table. For those two tasks, go back to the previous chapter [[#Create your SQL tables and the PHP DAO class (optional)]].
*Next step is to add a hook into your module to add the new fields into the form. See chapter [[Hooks_system#Implement_the_Hook]] for generic documentation to use hooks.

If you follow this tutorial, to be able to add fields into category forms, you must do:
{{ToComplete}}

===Add/replace part of fields supported by hooks===
See chapter [[Hooks_system#Implement_the_Hook]] to know how to use Dolibarr existing hooks to add/replace code at Dolibarr hooks place.

===Database access===
If you need to edit some data in the database inside your own table, use the PHP class generated before.

If you to make access to tables with no dedicated PHP class available, this is always possible (for example if you want to get a list of records with a particular join or filter). In this case, this is a code samples to follow:

To make an insert, update or delete:

<syntaxhighlight lang="PHP">
$db->begin(); // Start transaction
$db->query("My SQL request insert, update or delete");
$db->commit(); // Validate transaction
or $db->rollback() // Cancel transaction
</syntaxhighlight>

To read:

<syntaxhighlight lang="PHP">
$resql=$db->query("My select request");
if ($resql)
{
$num = $db->num_rows($resql);
$i = 0;
if ($num)
{
while ($i < $num)
{
$obj = $db->fetch_object($resql);
if ($obj)
{
// You can use here results
print $obj->field1;
print $obj->field2;
}
$i++;
}
}
}
</syntaxhighlight>

===Define style of your pages===
To have the look of your own pages to match the Dolibarr theme, it is necessary to use the Dolibarr CSS styles.

You can use for example:

*class="'''liste_titre'''" on tags ''tr'' and ''td'' for the head row of a table.
*class="'''pair'''" or class="'''impair'''" on tags ''tr'' and ''td'' of other rows of a table.
*class="'''flat'''" on all input fields (''input, select, textarea''...).
*class="'''button'''" on HTML fields with type ''input type="submit"''.

===Use the Dolibarr date picker===
If you want to use the Dolibarr date selector (with its calendar popup) into your pages, use the following line:
<syntaxhighlight lang="PHP">
$form=new Form($db);
$form->select_date('','mykey',0,0,0,"myform");
</syntaxhighlight>
The string mykey will identify the date selector in the form. You must use different values if you use several date selectors in same page.
The string myform is the name of the FORM in which the selector is included (value found in the form name="myform" in HTML page).
This means a date selector must be included necessarily into an html FORM.

To get value after the POST of your form, the command is:
<syntaxhighlight lang="PHP">
$mydate = dol_mktime(12, 0 , 0, $GETPOST('mykeymonth', 'int'), GETPOST('mykeyday', 'int'), GETPOST('mykeyyear', 'int'));
print strftime('%A %d %B %Y', $mydate);
</syntaxhighlight>

===Overwrite template file (tpl)===
If you want to overwrite tpl file on your module, you need to declare it on the module_parts :
<syntaxhighlight lang="PHP">
'tpl' => 1,
</syntaxhighlight>
Then you can put any tpl file on '''mymodule/core/tpl'''
as soon as the module is activate, the tpl will be overwrited

==Add your own setup page (optional)==
'''When''': If your module needs parameters, which are to be provided by the user, for proper setting up of the module.

===Create your page to edit parameters===
If your module needs several parameters to be setup, you must create a page to edit options (these options will be saved in the [[Table llx_const|table '''llx_const''']]).
Create a page named '''mymodule_setuppage.php''' that shows a form for possible options to update them into the above-mentioned table.
It is necessary to take an example from a page of the directory '''/admin''' that will show you the way to read/save your parameters.
Put this PHP page into the directory '''/admin''' of your module (e.g. mymodule/admin/mymodule_setuppage.php).

===Modify the descriptor file of your module===
Then, within the descriptor file of your module, modify the variable '''config_page_url''' to set the name of this PHP page.
If the page is in the directory '''admin/''', then the path is not required, e.g. like this:
<syntaxhighlight lang="PHP">
$this->config_page_url = array("mymodule_setuppage.php");
</syntaxhighlight>
If the page is in the directory '''mymodule/admin/''', then like this:
<syntaxhighlight lang="PHP">
$this->config_page_url = array("mymodule_setuppage.php@mymodule");
</syntaxhighlight>

===Test your page===
Go into page '''Home->Setup->Modules''', you should see a picture at the end of the line of your module to reach your setup page. Click on it, you should be able to view/edit parameters from your page.

==Define your entries in the menu (optional)==
'''When''': If you have created PHP pages, it is necessary that those pages can be reached from menu entries in Dolibarr menu.

===Define your menu entries===
For this, you must define into the module descriptor, the array this->menu that declares all menus added by your module.
This array contains entries that will appear once your module is activated.
The example module descriptor file '''modMyModule.class.php''' contains an example to declare a top menu and also its left menu entries.

This is the example of code to declare your own menu entries in a module descriptor file:
<syntaxhighlight lang="PHP">
// Main menu entries
$this->menu = array(); // List of menus to add
$r=0;

// Add here entries to declare new menus
// Example to declare the Top Menu entry:
$this->menu[$r]=array( 'fk_menu'=>0, // Put 0 if this is a top menu
'type'=>'top', // This is a Top menu entry
'titre'=>'MyModule top menu',
'mainmenu'=>'mymodule',
'leftmenu'=>'mymodule',
'url'=>'/mymodule/pagetop.php',
'langs'=>'mylangfile', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
'position'=>100,
'enabled'=>'1', // Define condition to show or hide menu entry. Use '$conf->mymodule->enabled' if entry must be visible if module is enabled.
'perms'=>'1', // Use 'perms'=>'$user->rights->mymodule->level1->level2' if you want your menu with a permission rules
'target'=>'',
'user'=>2); // 0=Menu for internal users, 1=external users, 2=both
$r++;

// Example to declare a Left Menu entry:
$this->menu[$r]=array( 'fk_menu'=>'fk_mainmenu=xxx', // Use 'fk_mainmenu=xxx' or 'fk_mainmenu=xxx,fk_leftmenu=yyy' where xxx is mainmenucode and yyy is a leftmenucode of parent menu
'type'=>'left', // This is a Left menu entry
'titre'=>'MyModule left menu 1',
'mainmenu'=>'xxx',
'leftmenu'=>'yyy',
'url'=>'/mymodule/pagelevel1.php',
'langs'=>'mylangfile', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
'position'=>100,
'enabled'=>'1', // Define condition to show or hide menu entry. Use '$conf->mymodule->enabled' if entry must be visible if module is enabled.
'perms'=>'1', // Use 'perms'=>'$user->rights->mymodule->level1->level2' if you want your menu with a permission rules
'target'=>'',
'user'=>2); // 0=Menu for internal users,1=external users, 2=both
$r++;
</syntaxhighlight>

To show the menu or not depending on a permission, modify property '''perms''' in the array. See chapter on permissions later to see how to add permissions.

===Test your menu entries===
Disable and re-enable your module under the Dolibarr module setup page, menus entries must appear (if property 'enabled' is declaration array is ok).

==Add your own permissions (optional)==
'''When''': If you want to add new permissions.

The way to define permissions that will manage your module is done inside the module descriptor created previously.
Modify line
<syntaxhighlight lang="PHP">
$this->rights_class = 'mymodule'
</syntaxhighlight>
with correct value for mymodule.

Then you must fill the array $this->rights with as many entries than different permissions you need to manage.

<syntaxhighlight lang="PHP">
$this->rights[$r][0] = 10001;
$this->rights[$r][1] = 'Label by default of permission';
$this->rights[$r][2] = 'r';
$this->rights[$r][3] = 1;
$this->rights[$r][4] = 'action';
$this->rights[$r][5] = 'subaction';
$r++;
</syntaxhighlight>

Into $this->rights[$r][0], put a permission id not already used (See into menu '''System info''' on a working installation of Dolibarr to know list of id already used by standard modules.
Into $this->rights[$r][1], put a label by default for permission (This label will be used if no translation can be found into the file '''admin.lang''' Translation key should be "Permission10001=My permission Label").
Into $this->rights[$r][2], types of the permission. There are three type of permission, 'r' for read, list or expert permission, 'w' for write or update permission and 'd' for delete permission.
Into $this->rights[$r][3], put 1 if this permission must be granted automatically by default to any newly created user.
Into $this->rights[$r][4] and $this->rights[$r][5], put an action and subaction string without spaces. You will be able to test if a user has the permission in your PHP source code with the sequence:

<syntaxhighlight lang="PHP">
if ($user->rights->mymodule->action->subaction) ...
</syntaxhighlight>

==Define your own box (optional)==
'''When''': If your module needs to provide one or several new boxes to show on home page.

===Define your box===
For this, modify the array $this->boxes into the module descriptor file.
All you have to do is to add 2 lines for each box file you will create into directory '''htdocs/mymodule/core/boxes'''

''Example:''
<syntaxhighlight lang="PHP">
$this->boxes[0]['file']='mybox0.php@mymodule'
$this->boxes[0]['note']='My box 0'
...
$this->boxes[n]['file']='myboxn.php@mymodule'
$this->boxes[n]['note']='My box n'
</syntaxhighlight>

Then create files '''htdocs/mymodule/core/boxes/mybox0.php''', '''htdocs/mymodule/core/boxes/mybox1.php'''... by copying an example from an existing box file (found into directory '''htdocs/core/boxes''').

===Test if your box is detected by Dolibarr===
Disable and enabled module.

Go into menu '''Home - Setup - Boxes'''.

Your boxes must appear in the list of boxes you can activate. Activate the box and go on the home page to see if the box is showing correctly.

==Define your own export (optional)==
'''When''': If your module provides new predefined database export profiles (for its own tables or for already existing tables of another module).

===Define export===
For this uncomment and modify arrays $this->export_xxx in your module descriptor file.

===Test your export===
Go into menu Tools -> Export. Your export will appear in the list of available predefined exports (if your module is enabled).
Choose it, you must see a list of all possible fields defined in the export arrays.
Choose on field and try to build an export file. If ok, try again with all fields.

==Define your CSS styles (optional)==
'''When''': If in your PHP pages, you use class styles that are not defined inside Dolibarr themes CSS (not recommended).

===Create and declare your style sheet===
Create a style sheet CSS named '''mymodule.css''' or '''mymodule.css.php''' and put it into directory '''htdocs/mymodule'''. You can have several CSS files per module.
Remember it's better to use existing styles already available by default into Dolibarr (The CSS file used by Dolibarr is file '''themes/mytheme/''themename''.css.php'''. Create your own CSS files only if you need absolutely to add not already existing styles.

Once your style sheets are ready, declare them into your module descriptor file by modifying the property '''$this->modules_parts'''.
Value to put here must be an array of relative URLs of your CSS files.
For example
<syntaxhighlight lang="PHP">
$this->module_parts = array('css' => array('/mymodule/css/mymodule.css.php','/mymodule/css/myother.css'));
</syntaxhighlight>

===Test your style sheet===
Disable and enable your module.

Go on the home page (index.php). Show the HTML source of the page.

In the HTML header, you should see a line that declares your style sheet.

==Add your JavaScript functions (optional)==
'''When''': If in your PHP pages, you use javascript functions not available in Dolibarr (in file lib_head.js)

If you need to use your own JavaScript functions inside your PHP pages, it is necessary to define your functions in your JavaScript file '''htdocs/mymodule/js/mymodule.js''', included in the HTML <code><head/></code> section.
Dolibarr is responsible for building that HTML section. In order to ask it to include your JavaScript file, you just need to provide it to the llxHeader() function called by your page.

Example for page /htdocs/mymodule/mypage.php :
<syntaxhighlight lang="PHP">
$morejs=array("/mymodule/js/mymodule.js");
llxHeader('','Titre','','','','',$morejs,'',0,0);
</syntaxhighlight>

==Run your own code on any Dolibarr event (optional)==
'''When''': If you want to execute your own code once a common Dolibarr event has occurred (example: I want to update a table in my module when an invoice is created into Dolibarr), you must create a '''trigger'''.

See also [[Interfaces_Dolibarr_toward_foreign_systems]]
and [[Interfaces_from_foreign_systems_toward_Dolibarr]]

==Insert your code inside Dolibarr hooks positions (optional)==
'''When''': When you want to add code or replace Dolibarr code into another situation than a business event (See the previous chapter for adding code during a business event).

See page [[Hooks_system]].

==Add your own numbering rules==
'''When''': When you need a new rule for generated ref of elements that are not covered by existing rules.

See page [[Create numbering module]].

==Add your document template (optional)==
'''When''': When you want to personalize your own generated PDF or ODT documents.

Note: To add this feature, you don't need to create a module descriptor.

Documentation to add your own template is available on page [[Create_a_PDF_document_template]] or [[Create_an_ODT_document_template]].

==Add your skin (optional)==
'''When''': When you want to personalized your colors/fonts/images.

Note: To add this feature, you don't need to create a module descriptor.

To add your own skin, read page [[Skins]].

=Some coding rules and predefined functions=
The coding rules to be followed are defined in the [[Developer documentation]], under section "General Information - Language and standards development".

A lot of predefined features for developers are also available and described into page [[Developer documentation]] under section "Technical components of Dolibarr".

=Create a package to distribute and install your module=
This process must be used to generate a package to submit it on the http://www.dolistore.com marketplace.
But you can use it to have a package easy to distribute on your own network.

*Go into the directory '''/build''' and copy the file '''makepack-dolibarrmodules.conf''' into '''makepack-mymodule.conf'''. Warning, this directory may not be provided in some packages of stable versions. If so, it can be retrieved from the snapshot available for download on the Dolibarr website in area "Development version" (taken in this case the whole build directory which is autonomous and independent directory).

Edit this file to add a list of file names for all new files you created for your module (module descriptor, new sql tables files, php page, images, etc...)

*Run the script via Perl (need the Perl version 5.0 or later):

<syntaxhighlight lang="bash">
perl makepack-dolibarrmodule.pl
</syntaxhighlight>
The script asks you the name of your module, its major and minor version. A file '''mymodule.zip ''' will then be manufactured containing your module ready to be deployed.

*The person who receives your module must then place the file in the root directory of a Dolibarr installation and perform the command:

<syntaxhighlight lang="bash">
tar -xvf mymodule.zip
</syntaxhighlight>

*If you want your module to be public, you can submit it (the zip file) on the Dolibarr marketplace website: {{LinkToPluginDownload}} (you must first create an account and be logged in to use the "Submit a module/product" link).
**If your module was built correctly, the file will be validated later.
**If quality is sufficient and license permits it, the code might be added inside main Dolibarr sources (except if you disagree for that).

=Enabling/activation condition of external module on DoliStore=

See [[Module_Dolistore_Validation_Rules|Validation Rules]]
[[Category:Development]]

Module development

2025-04-17T18:20:27Z

TanguyP: Improve wording; Fix links

[[fr:Développement_module]]
[[es:Desarrollo_de_un_módulo]]
[[de:Modul_Entwicklung]]
[[zh:模块开发]]
[[ja:モジュール_開発]]


[[Category:Core]]
{{TemplateDocDevEn}}

To create a new module/addon for Dolibarr, there are several steps. This tutorial will describe each of them to let you build a module that extends Dolibarr features, such as:

*Add new tables in database.
*Add your own menu entries.
*Add new screens to edit new tables.
*Add or remove tabs on object view (invoice, product, order, event, ...).
*Add predefined exports for the internal export tool.
*Add new information widget in the home page.
*Add new substitutions variables.
*Define new permissions.
*Execute code automatically triggered by a particular Dolibarr action.
*Insert your code inside Dolibarr hooks positions.
*Add your numbering rule to generate the reference of objects
*Add a new document template.
*Add a new skin.

etc...

The following chapters explain how to do all of this manually in an easy way.

=Module creation with the module builder=
From Dolibarr v. 12.0 it is possible to create the main pages of your module with the Module Builder. To activate it:

Go into the list of modules and enable the "Module Builder" module:
[[File:Module Builder.png|alt=Module Builder|thumb|none]]

Then click on the "bug" image in the top right of screen.[[File:Module Builder icon.png|alt=Module Builder icon|left|thumb]]
<br />
=Template of an External Module=
A good model to start development of external module can be found here : [https://github.com/Dolibarr/dolibarr/tree/develop/htdocs/modulebuilder/template GitHub Dolibarr Module Template]

=Create your module=
==Create a Module descriptor for your Module (required)==
'''When it is required''': Required as soon as an addon is developed, whatever its goal is (only adding a skin does not require a module descriptor file).

'''Since Dolibarr 9.0, you should use the ModuleBuilder module provided as a standard module to generate the module descriptor'''

===Create your module descriptor===
The first step is to create a file descriptor for the module.

*Create directory '''/htdocs/custom/''mymodule''/core/modules''' (for an external module) or '''/htdocs/''mymodule''/core/modules''' if you plan to have this module an official core module of Dolibarr. Then copy the file <code>modMyModule.class.php</code> from the directory '''htdocs/modulebuilder/template''' into this directory. Change the name of the file <code>modMyModule.class.php</code> to the name corresponding to the purpose of your module. Name of the file must start with <code>mod</code> and end with <code>.class.php</code> (for example if you want to give the name 'NewName' to this file, then the name should be <code>modNewName.class.php</code>).

Then, modify the contents of this file as follows:

*Replace all occurrences of "modMyModule" with a value which corresponds to the purpose of your module. This value must always start with 'mod' and contain only alpha characters (again, if the name given to the file was 'NewName', then replace all "modMyModule" with "modNewName").
*Change the number in: $this->numero = 100000 by a number that designates your module id. To avoid conflicts with other modules, you can consult the page that lists already reserved id numbers: [[List of modules id|List of module IDs]].
*Modify any other variables defined in the constructor (see comment in the code skeleton for their meaning).

Your file descriptor for your module is ready. See the next step to activate it.

===Test your descriptor===

Launch Dolibarr and go to page '''Setup->module'''?
If you set the property version in the module description you should see a new line with your new module and the possibility to activate it or not. If you set the property version to "develop" or "experiental", to see your module, you must first go into '''Setup-Others''' and set MAIN_FEATURES_LEVEL to 1 to see "experimental" modules or 2 to see "development" modules.

==Tree of path for new module files (required)==
This is how your files must be organized when building a new module (the zip file must also match this rule).
Note: Only the second line is mandatory.

{{TemplateModuleTreeSimple}}

==Create your SQL tables and the PHP DAO class (optional)==
'''When''': If your module needs to manage data of its own

===Create your .sql file===
If your module is designed to manage data of its own, which are not available in the standard version of Dolibarr, it is necessary to define SQL tables to store the data.

Scripts for creating tables and loading data by your own module are saved into a subdirectory sql ('''"mymodule/sql"''') of your module. (With ModuleBuilder, the directory and all sql files will be created automatically when you will create a new Object from tab Object).

Then check into your descriptor file, into function '''init''' that the line

<syntaxhighlight lang="PHP">$this->_load_tables('/mymodule/sql/');</syntaxhighlight>

is not commented.

''Rules to follow:''

*Add the files about creating tables commands on the principle of an '''llx_mytable.sql''' file per table, with an optional '''llx_mytable.key.sql''' file (see existing files in '''install/mysql/tables''' for examples).
*The recommended type and name for SQL fields are defined into page [[Language_and_development_rules#Table_and_fields_structures]].
*To manage data, you must create a file called '''data.sql''' inside directory '''/mymodule/sql/''' that contains SQL command to add/edit/delete data.
*Don't use the double quote for strings (eg 'chaine' not "chaine") because the double quote have a specific meaning in PostGreSQL

Example of content of a file data.sql
<syntaxhighlight lang="sql">
delete from llx_const where name='MYMODULE_IT_WORKS' and entity='__ENTITY__';
insert into llx_const (name, value, type, note, visible, entity) values ('MYMODULE_IT_WORKS','1','chaine','A constant vor my module',1,'__ENTITY__');
</syntaxhighlight>

Files must be operational for the database mysql. Note: The files of other databases are not maintained. They will be read and converted on the fly by the driver of the other database.

===Test your .sql files===

Once the files ready, you can return to the page to enable Dolibarr modules and disable the module, drop those tables in the database (if they already exist) and reactivate the module. The tables should be recreated by the activation of the module. If this is not the case, check your scripts by passing them by hand, or check the Dolibarr logs.

===Generate the PHP DAO class===
The DAO PHP files should have been generated by ModuleBuilder after creating an object.

You can however create them manually by copying existing object however using ModuleBuilder is highly recommended. You should find examples into '''htdocs/modulebuilder/templates/class/myobject.class.php'''

In this class, there are already operational CRUD (Create/Read/Update/Delete) methods to perform an insert, a fetch (select), an update, a delete of a table row. Edit the file to use the correct module name, tables and place this file in the class subdirectory of the module. The Module Builder allows you to do this with just a few mouse clicks.

==The tab management (optional)==

===Add or remove your own tabs on object sheets===
'''When''': To add a tab on an object (invoices, orders, proposals, member ...)

To do this go into the file descriptor of module previously created and edit the $this->tabs array:

<syntaxhighlight lang="PHP">
// Array to add new pages in new tabs or remove existing one
$this->tabs = array('objecttype:+tabname1:Title1:mylangfile@mymodule:$user->rights->mymodule->read:/mymodule/mypagetab1.php?id=__ID__' // To add a new tab identified by code tabname1
'objecttype:+tabname2:Title2:mylangfile@mymodule:$user->rights->mymodule->read:/mymodule/mypagetab2.php?id=__ID__', // To add a new tab identified by code tabname2
'objecttype:-tabname'); // To remove an existing tab identified by code tabname
</syntaxhighlight>

The table should contain a list of strings, each string representing a new tab.
The format of the string consisting of 5 parts separated by ":"

*Part 1: The element type (object type) where the tab should appear is a value from the following:
{{TemplateModuleTabs}}

*Part 2: A code to identify tab to add (start with +tabname1) or to remove (start with -tabname1)
*Part 3: The title of the tab(Title1). This can be a hardcoded read or better a code translation in module lang file .
*Part 4: The name of the file "*.lang" (mylangfile@mymodule) which contains correspondence between the code translation and language to display. If this name is followed with @mymodule, Dolibarr will search translation file "*.lang" within the module in htdocs/custom/mymodule/langs/code_CODE/mylangfile.lang, otherwise Dolibarr will look for file in htdocs/langs/code_CODE/mylangfile.lang
*Part 5: A condition to test if tab must be visible($user->rights->mymodule->read) '''or''' put 1 to be always visible.
*Part 6: The URL of the page to display when you click on the tab (/mymodule/mypagetab1.php). The __ID__ string will be replaced automatically by the Id of the element concerned.

To feed the contents of the tab with data from the database, see the next chapter.

In order to get the names 'tabname' of existing tabs, you have to check the names used in the function 'product_prepare_head' of the file 'core/lib/module.lib.php' corresponding to section '$head[$h][2]'.

===Show tabs navigation into your own pages===
'''When''': To show all standard tabs of an object (product, tiers, etc.) on your page.

You must follow these steps :

'''1. Include files you need into your file'''

For each object type, there are two files to include with line
<syntaxhighlight lang="PHP">require_once($url_fichier) ;</syntaxhighlight>

This is example of files to include (DOL_DOCUMENT_ROOT is often dolibarr/htdocs/) :

*Object thirdparty (thirdparty) :
**DOL_DOCUMENT_ROOT/societe/class/societe.class.php
**DOL_DOCUMENT_ROOT/core/lib/company.lib.php
*Object product (product) :
**DOL_DOCUMENT_ROOT/product/class/product.class.php
**DOL_DOCUMENT_ROOT/core/lib/product.lib.php
*Object invoice (invoice) :
**DOL_DOCUMENT_ROOT/compta/facture/class/facture.class.php
**DOL_DOCUMENT_ROOT/core/lib/invoice.lib.php

...

'''2. Create and load the object to show into your tab'''

Create an instance of an object of the correct class and load object from the database by using the fetch method of an object in providing to this method the id you get from URL (ie : /mytab.php?id=1).

''Example :''
<syntaxhighlight lang="PHP">
$id=GETPOST('id','int');
$ref=GETPOST('ref','alpha');
$product = new Product($db) ;
$result = $product->fetch($id,$ref) ; // Test $result to check the database read is ok
</syntaxhighlight>

'''3. Get a list of all tabs to show for your object type'''

Use function XXX_prepare_head($obj), where XXX is name of object. This will return an array with all definition of tab entries to show. The parameter to put into this method is the instance of an object you want tabs.

The resulting array has the following structure
<syntaxhighlight lang="PHP">
$head // Array of tabs
$head[$h] // Element to describe one tab.
$head[$h][0] // Url of page to show when you click on tab
$head[$h][1] // Title of tab
$head[$h][2] // Code name to identify the tab
</syntaxhighlight>

''Example :''
<syntaxhighlight lang="PHP">
$head = product_prepare_head($product, $user) ; // parameter $user is present for some function anly
</syntaxhighlight>

'''4. show tabs on your page'''

Use the <code>dol_fiche_head()</code> function to show all tabs defined in the <code>$head</code> array returned by <code>XX_prepare_head()</code>.

<syntaxhighlight lang="PHP">
dol_fiche_head($links, $active='0', $title='', $notab=0, $picto='')
//$links // Tableau des onglets, appelé $head plus haut.
//$active // Onglet actif (mettre le nom de l'onglet défini dans votre fichier de module, ou un nom contenu dans $head[$h][2]). Cet onglet sera mis en surbrillance
//$title // Title to show (shown into a special tab that you can't click)
//$notab
//$picto // Name of image to show into title. Possible values are:
// product
// service
// company
</syntaxhighlight>

This function will show required tabs and open an html element ''< div class="" >'' that correspond to the area under the tabs. To close area of a tab, just use ''< /div >'' into your PHP page.

==Create or modify PHP screens (optional)==
'''When''': If the purpose of your module is to add features that require new or modified screens.

===Create a new PHP screen===
You must then create your PHP pages that will show/edit data from tables using the skeleton templates provided as an example in the directory '''modulebuilder/myobject_page.php''' (For the development of a script from the command line, see [[Script development]]).

To create a new user screen, create a subdirectory of '''htdocs''' (if not already done) for your module (in '''htdocs/mymodule''' for example) to store the pages you will create.

Copy, into that directory, the file '''myobject_page.php''' that will serve as a starting point for your page file.
Edit the file to have a correct relative path to the main.inc.php file.
<syntaxhighlight lang="PHP">
// Load Dolibarr environment
$res=0;
// Try main.inc.php into web root known defined into CONTEXT_DOCUMENT_ROOT (not always defined)
if (! $res && ! empty($_SERVER["CONTEXT_DOCUMENT_ROOT"])) $res=@include($_SERVER["CONTEXT_DOCUMENT_ROOT"]."/main.inc.php");
// Try main.inc.php into web root detected using web root calculated from SCRIPT_FILENAME
$tmp=empty($_SERVER['SCRIPT_FILENAME'])?'':$_SERVER['SCRIPT_FILENAME'];$tmp2=realpath(__FILE__); $i=strlen($tmp)-1; $j=strlen($tmp2)-1;
while($i > 0 && $j > 0 && isset($tmp[$i]) && isset($tmp2[$j]) && $tmp[$i]==$tmp2[$j]) { $i--; $j--; }
if (! $res && $i > 0 && file_exists(substr($tmp, 0, ($i+1))."/main.inc.php")) $res=@include(substr($tmp, 0, ($i+1))."/main.inc.php");
if (! $res && $i > 0 && file_exists(dirname(substr($tmp, 0, ($i+1)))."/main.inc.php")) $res=@include(dirname(substr($tmp, 0, ($i+1)))."/main.inc.php");
// Try main.inc.php using relative path
if (! $res && file_exists("../main.inc.php")) $res=@include("../main.inc.php");
if (! $res && file_exists("../../main.inc.php")) $res=@include("../../main.inc.php");
if (! $res && file_exists("../../../main.inc.php")) $res=@include("../../../main.inc.php");
if (! $res) die("Include of main fails");
</syntaxhighlight>
As you can see, there are several tries to load the main.inc.php (or master.inc.php). The goal is to succeed in the most cases as possible. The minimum is 2 lines: one to try to load the master/main.inc.php into the dolibarr root directory and another one to try to load the file to support the case when the module is deployed into the "custom" directory. But you can have more to deal more situation. The provided example should be able to load the file main/master.inc.php in nearly all situation/setups.

Note that you may add more "../" depending on the depth of the file relative to your module directory tree.

It's in the main.inc.php file that is loaded technical environment variables and permissions. The following variables are objects positioned in this file:

*$user Object that contains the characteristics of the user + his permissions.
*$conf Object that contains Dolibarr configuration.
*$db Object that contains an opened connection handler to the database.
*$langs Object that contains the user's language.

Then enter your code to display the page.

*To include a class or library dedicated to the module is done using a Dolibarr function (and not using directly include_once):

''Example :''
<syntaxhighlight lang="PHP">
dol_include_once('/mymodule/class/myclass.class.php', 'MyClass');
</syntaxhighlight>

*To include classes provided with Dolibarr, use the following syntax:

''Example :''
<syntaxhighlight lang="PHP">
require_once DOL_DOCUMENT_ROOT.'/core/class/doli.class.php';
</syntaxhighlight>

===Add some fields into existing forms===
You may want to provide a module that adds more fields into forms (input and view) of some elements.

A heavy solution (but not so bad) may be to replace all pages used to create element (this means disabling the "New element" menu entry and adding yours, and disabling the tab that shows the element to replace with a tab that is your own full page (copied/pasted from original) to do same than original page but modified to add your fields and stored added data into your own table). Go to menu [[#Define your entries in the menu (optional)]] and [[#The tab management (optional)]] if this solution suits you (this solution is more powerful since you can change everything you want into the page).

We will describe here another solution, that works only to "add fields" at end of existing fields, using the element "category" as an example but you can convert this tutorial for invoice, proposal ...

*First thing is to add a table, owned by your module, to store the value of new fields. This table will only have one column called <code>rowid</code> (will contain the same value as the <code>rowid</code> column in the element table) + one column for each new field you want to add. Then, create a class with CRUD (Create/Read/Update/Delete) methods for this new table. For those two tasks, go back to the previous chapter [[#Create your SQL tables and the PHP DAO class (optional)]].
*Next step is to add a hook into your module to add the new fields into the form. See chapter [[Hooks_system#Implement_the_Hook]] for generic documentation to use hooks.

If you follow this tutorial, to be able to add fields into category forms, you must do:
{{ToComplete}}

===Add/replace part of fields supported by hooks===
See chapter [[Hooks_system#Implement_the_Hook]] to know how to use Dolibarr existing hooks to add/replace code at Dolibarr hooks place.

===Database access===
If you need to edit some data in the database inside your own table, use the PHP class generated before.

If you to make access to tables with no dedicated PHP class available, this is always possible (for example if you want to get a list of records with a particular join or filter). In this case, this is a code samples to follow:

To make an insert, update or delete:

<syntaxhighlight lang="PHP">
$db->begin(); // Start transaction
$db->query("My SQL request insert, update or delete");
$db->commit(); // Validate transaction
or $db->rollback() // Cancel transaction
</syntaxhighlight>

To read:

<syntaxhighlight lang="PHP">
$resql=$db->query("My select request");
if ($resql)
{
$num = $db->num_rows($resql);
$i = 0;
if ($num)
{
while ($i < $num)
{
$obj = $db->fetch_object($resql);
if ($obj)
{
// You can use here results
print $obj->field1;
print $obj->field2;
}
$i++;
}
}
}
</syntaxhighlight>

===Define style of your pages===
To have the look of your own pages to match the Dolibarr theme, it is necessary to use the Dolibarr CSS styles.

You can use for example:

*class="'''liste_titre'''" on tags ''tr'' and ''td'' for the head row of a table.
*class="'''pair'''" or class="'''impair'''" on tags ''tr'' and ''td'' of other rows of a table.
*class="'''flat'''" on all input fields (''input, select, textarea''...).
*class="'''button'''" on HTML fields with type ''input type="submit"''.

===Use the Dolibarr date picker===
If you want to use the Dolibarr date selector (with its calendar popup) into your pages, use the following line:
<syntaxhighlight lang="PHP">
$form=new Form($db);
$form->select_date('','mykey',0,0,0,"myform");
</syntaxhighlight>
The string mykey will identify the date selector in the form. You must use different values if you use several date selectors in same page.
The string myform is the name of the FORM in which the selector is included (value found in the form name="myform" in HTML page).
This means a date selector must be included necessarily into an html FORM.

To get value after the POST of your form, the command is:
<syntaxhighlight lang="PHP">
$mydate = dol_mktime(12, 0 , 0, $GETPOST('mykeymonth', 'int'), GETPOST('mykeyday', 'int'), GETPOST('mykeyyear', 'int'));
print strftime('%A %d %B %Y', $mydate);
</syntaxhighlight>

===Overwrite template file (tpl)===
If you want to overwrite tpl file on your module, you need to declare it on the module_parts :
<syntaxhighlight lang="PHP">
'tpl' => 1,
</syntaxhighlight>
Then you can put any tpl file on '''mymodule/core/tpl'''
as soon as the module is activate, the tpl will be overwrited

==Add your own setup page (optional)==
'''When''': If your module needs parameters, which are to be provided by the user, for proper setting up of the module.

===Create your page to edit parameters===
If your module needs several parameters to be setup, you must create a page to edit options (these options will be saved in the [[Table llx_const|table '''llx_const''']]).
Create a page named '''mymodule_setuppage.php''' that shows a form for possible options to update them into the above-mentioned table.
It is necessary to take an example from a page of the directory '''/admin''' that will show you the way to read/save your parameters.
Put this PHP page into the directory '''/admin''' of your module (e.g. mymodule/admin/mymodule_setuppage.php).

===Modify the descriptor file of your module===
Then, within the descriptor file of your module, modify the variable '''config_page_url''' to set the name of this PHP page.
If the page is in the directory '''admin/''', then the path is not required, e.g. like this:
<syntaxhighlight lang="PHP">
$this->config_page_url = array("mymodule_setuppage.php");
</syntaxhighlight>
If the page is in the directory '''mymodule/admin/''', then like this:
<syntaxhighlight lang="PHP">
$this->config_page_url = array("mymodule_setuppage.php@mymodule");
</syntaxhighlight>

===Test your page===
Go into page '''Home->Setup->Modules''', you should see a picture at the end of the line of your module to reach your setup page. Click on it, you should be able to view/edit parameters from your page.

==Define your entries in the menu (optional)==
'''When''': If you have created PHP pages, it is necessary that those pages can be reached from menu entries in Dolibarr menu.

===Define your menu entries===
For this, you must define into the module descriptor, the array this->menu that declares all menus added by your module.
This array contains entries that will appear once your module is activated.
The example module descriptor file '''modMyModule.class.php''' contains an example to declare a top menu and also its left menu entries.

This is the example of code to declare your own menu entries in a module descriptor file:
<syntaxhighlight lang="PHP">
// Main menu entries
$this->menu = array(); // List of menus to add
$r=0;

// Add here entries to declare new menus
// Example to declare the Top Menu entry:
$this->menu[$r]=array( 'fk_menu'=>0, // Put 0 if this is a top menu
'type'=>'top', // This is a Top menu entry
'titre'=>'MyModule top menu',
'mainmenu'=>'mymodule',
'leftmenu'=>'mymodule',
'url'=>'/mymodule/pagetop.php',
'langs'=>'mylangfile', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
'position'=>100,
'enabled'=>'1', // Define condition to show or hide menu entry. Use '$conf->mymodule->enabled' if entry must be visible if module is enabled.
'perms'=>'1', // Use 'perms'=>'$user->rights->mymodule->level1->level2' if you want your menu with a permission rules
'target'=>'',
'user'=>2); // 0=Menu for internal users, 1=external users, 2=both
$r++;

// Example to declare a Left Menu entry:
$this->menu[$r]=array( 'fk_menu'=>'fk_mainmenu=xxx', // Use 'fk_mainmenu=xxx' or 'fk_mainmenu=xxx,fk_leftmenu=yyy' where xxx is mainmenucode and yyy is a leftmenucode of parent menu
'type'=>'left', // This is a Left menu entry
'titre'=>'MyModule left menu 1',
'mainmenu'=>'xxx',
'leftmenu'=>'yyy',
'url'=>'/mymodule/pagelevel1.php',
'langs'=>'mylangfile', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
'position'=>100,
'enabled'=>'1', // Define condition to show or hide menu entry. Use '$conf->mymodule->enabled' if entry must be visible if module is enabled.
'perms'=>'1', // Use 'perms'=>'$user->rights->mymodule->level1->level2' if you want your menu with a permission rules
'target'=>'',
'user'=>2); // 0=Menu for internal users,1=external users, 2=both
$r++;
</syntaxhighlight>

To show the menu or not depending on a permission, modify property '''perms''' in the array. See chapter on permissions later to see how to add permissions.

===Test your menu entries===
Disable and re-enable your module under the Dolibarr module setup page, menus entries must appear (if property 'enabled' is declaration array is ok).

==Add your own permissions (optional)==
'''When''': If you want to add new permissions.

The way to define permissions that will manage your module is done inside the module descriptor created previously.
Modify line
<syntaxhighlight lang="PHP">
$this->rights_class = 'mymodule'
</syntaxhighlight>
with correct value for mymodule.

Then you must fill the array $this->rights with as many entries than different permissions you need to manage.

<syntaxhighlight lang="PHP">
$this->rights[$r][0] = 10001;
$this->rights[$r][1] = 'Label by default of permission';
$this->rights[$r][2] = 'r';
$this->rights[$r][3] = 1;
$this->rights[$r][4] = 'action';
$this->rights[$r][5] = 'subaction';
$r++;
</syntaxhighlight>

Into $this->rights[$r][0], put a permission id not already used (See into menu '''System info''' on a working installation of Dolibarr to know list of id already used by standard modules.
Into $this->rights[$r][1], put a label by default for permission (This label will be used if no translation can be found into the file '''admin.lang''' Translation key should be "Permission10001=My permission Label").
Into $this->rights[$r][2], types of the permission. There are three type of permission, 'r' for read, list or expert permission, 'w' for write or update permission and 'd' for delete permission.
Into $this->rights[$r][3], put 1 if this permission must be granted automatically by default to any newly created user.
Into $this->rights[$r][4] and $this->rights[$r][5], put an action and subaction string without spaces. You will be able to test if a user has the permission in your PHP source code with the sequence:

<syntaxhighlight lang="PHP">
if ($user->rights->mymodule->action->subaction) ...
</syntaxhighlight>

==Define your own box (optional)==
'''When''': If your module needs to provide one or several new boxes to show on home page.

===Define your box===
For this, modify the array $this->boxes into the module descriptor file.
All you have to do is to add 2 lines for each box file you will create into directory '''htdocs/mymodule/core/boxes'''

''Example:''
<syntaxhighlight lang="PHP">
$this->boxes[0]['file']='mybox0.php@mymodule'
$this->boxes[0]['note']='My box 0'
...
$this->boxes[n]['file']='myboxn.php@mymodule'
$this->boxes[n]['note']='My box n'
</syntaxhighlight>

Then create files '''htdocs/mymodule/core/boxes/mybox0.php''', '''htdocs/mymodule/core/boxes/mybox1.php'''... by copying an example from an existing box file (found into directory '''htdocs/core/boxes''').

===Test if your box is detected by Dolibarr===
Disable and enabled module.

Go into menu '''Home - Setup - Boxes'''.

Your boxes must appear in the list of boxes you can activate. Activate the box and go on the home page to see if the box is showing correctly.

==Define your own export (optional)==
'''When''': If your module provides new predefined database export profiles (for its own tables or for already existing tables of another module).

===Define export===
For this uncomment and modify arrays $this->export_xxx in your module descriptor file.

===Test your export===
Go into menu Tools -> Export. Your export will appear in the list of available predefined exports (if your module is enabled).
Choose it, you must see a list of all possible fields defined in the export arrays.
Choose on field and try to build an export file. If ok, try again with all fields.

==Define your CSS styles (optional)==
'''When''': If in your PHP pages, you use class styles that are not defined inside Dolibarr themes CSS (not recommended).

===Create and declare your style sheet===
Create a style sheet CSS named '''mymodule.css''' or '''mymodule.css.php''' and put it into directory '''htdocs/mymodule'''. You can have several CSS files per module.
Remember it's better to use existing styles already available by default into Dolibarr (The CSS file used by Dolibarr is file '''themes/mytheme/''themename''.css.php'''. Create your own CSS files only if you need absolutely to add not already existing styles.

Once your style sheets are ready, declare them into your module descriptor file by modifying the property '''$this->modules_parts'''.
Value to put here must be an array of relative URLs of your CSS files.
For example
<syntaxhighlight lang="PHP">
$this->module_parts = array('css' => array('/mymodule/css/mymodule.css.php','/mymodule/css/myother.css'));
</syntaxhighlight>

===Test your style sheet===
Disable and enable your module.

Go on the home page (index.php). Show the HTML source of the page.

In the HTML header, you should see a line that declares your style sheet.

==Add your JavaScript functions (optional)==
'''When''': If in your PHP pages, you use javascript functions not available in Dolibarr (in file lib_head.js)

If you need to use your own JavaScript functions inside your PHP pages, it is necessary to define your functions in your JavaScript file '''htdocs/mymodule/js/mymodule.js''', included in the HTML <code><head/></code> section.
Dolibarr is responsible for building that HTML section. In order to ask it to include your JavaScript file, you just need to provide it to the llxHeader() function called by your page.

Example for page /htdocs/mymodule/mypage.php :
<syntaxhighlight lang="PHP">
$morejs=array("/mymodule/js/mymodule.js");
llxHeader('','Titre','','','','',$morejs,'',0,0);
</syntaxhighlight>

==Run your own code on any Dolibarr event (optional)==
'''When''': If you want to execute your own code once a common Dolibarr event has occurred (example: I want to update a table in my module when an invoice is created into Dolibarr), you must create a '''trigger'''.

See also [[Interfaces_Dolibarr_toward_foreign_systems]]
and [[Interfaces_from_foreign_systems_toward_Dolibarr]]

==Insert your code inside Dolibarr hooks positions (optional)==
'''When''': When you want to add code or replace Dolibarr code into another situation than a business event (See the previous chapter for adding code during a business event).

See page [[Hooks_system]].

==Add your own numbering rules==
'''When''': When you need a new rule for generated ref of elements that are not covered by existing rules.

See page [[Create numbering module]].

==Add your document template (optional)==
'''When''': When you want to personalize your own generated PDF or ODT documents.

Note: To add this feature, you don't need to create a module descriptor.

Documentation to add your own template is available on page [[Create_a_PDF_document_template]] or [[Create_an_ODT_document_template]].

==Add your skin (optional)==
'''When''': When you want to personalized your colors/fonts/images.

Note: To add this feature, you don't need to create a module descriptor.

To add your own skin, read page [[Skins]].

=Some coding rules and predefined functions=
The coding rules to be followed are defined in the [[Developer documentation]], under section "General Information - Language and standards development".

A lot of predefined features for developers are also available and described into page [[Developer documentation]] under section "Technical components of Dolibarr".

=Create a package to distribute and install your module=
This process must be used to generate a package to submit it on the http://www.dolistore.com marketplace.
But you can use it to have a package easy to distribute on your own network.

*Go into the directory '''/build''' and copy the file '''makepack-dolibarrmodules.conf''' into '''makepack-mymodule.conf'''. Warning, this directory may not be provided in some packages of stable versions. If so, it can be retrieved from the snapshot available for download on the Dolibarr website in area "Development version" (taken in this case the whole build directory which is autonomous and independent directory).

Edit this file to add a list of file names for all new files you created for your module (module descriptor, new sql tables files, php page, images, etc...)

*Run the script via Perl (need the Perl version 5.0 or later):

<syntaxhighlight lang="bash">
perl makepack-dolibarrmodule.pl
</syntaxhighlight>
The script asks you the name of your module, its major and minor version. A file '''mymodule.zip ''' will then be manufactured containing your module ready to be deployed.

*The person who receives your module must then place the file in the root directory of a Dolibarr installation and perform the command:

<syntaxhighlight lang="bash">
tar -xvf mymodule.zip
</syntaxhighlight>

*If you want your module to be public, you can submit it (the zip file) on the Dolibarr marketplace website: {{LinkToPluginDownload}} (you must first create an account and be logged in to use the "Submit a module/product" link).
**If your module was built correctly, the file will be validated later.
**If quality is sufficient and license permits it, the code might be added inside main Dolibarr sources (except if you disagree for that).

=Enabling/activation condition of external module on DoliStore=

See [[Module_Dolistore_Validation_Rules|Validation Rules]]
[[Category:Development]]

Module development

2025-04-16T19:33:42Z

TanguyP: Fix some language mistakes, improve some style

[[fr:Développement_module]]
[[es:Desarrollo_de_un_módulo]]
[[de:Modul_Entwicklung]]
[[zh:模块开发]]
[[ja:モジュール_開発]]


[[Category:Core]]
{{TemplateDocDevEn}}

To create a new module/addon for Dolibarr, there are several steps. This tutorial will describe each of them to let you build a module that extends Dolibarr features, such as:

*Add new tables in database.
*Add your own menu entries.
*Add new screens to edit new tables.
*Add or remove tabs on object view (invoice, product, order, event, ...).
*Add predefined exports for the internal export tool.
*Add new information widget in the home page.
*Add new substitutions variables.
*Define new permissions.
*Execute code automatically triggered by a particular Dolibarr action.
*Insert your code inside Dolibarr hooks positions.
*Add your numbering rule to generate the reference of objects
*Add a new document template.
*Add a new skin.

etc...

The following chapters explain how to do all of this manually in an easy way.

=Module creation with the module builder=
From Dolibarr v. 12.0 it is possible to create the main pages of your module with the Module Builder. To activate it:

Go into the list of modules and enable the "Module Builder" module:
[[File:Module Builder.png|alt=Module Builder|thumb|none]]

Then click on the "bug" image in the top right of screen.[[File:Module Builder icon.png|alt=Module Builder icon|left|thumb]]
<br />
=Template of an External Module=
A good model to start development of external module can be found here : [https://github.com/Dolibarr/dolibarr/tree/develop/htdocs/modulebuilder/template GitHub Dolibarr Module Template]

=Create your module=
==Create a Module descriptor for your Module (required)==
'''When it is required''': Required as soon as an addon is developed, whatever its goal is (only adding a skin does not require a module descriptor file).

'''Since Dolibarr 9.0, you should use the ModuleBuilder module provided as a standard module to generate the module descriptor'''

===Create your module descriptor===
The first step is to create a file descriptor for the module.

*Create directory '''/htdocs/custom/''mymodule''/core/modules''' (for an external module) or '''/htdocs/''mymodule''/core/modules''' if you plan to have this module an official core module of Dolibarr. Then copy the file <code>modMyModule.class.php</code> from the directory '''htdocs/modulebuilder/template''' into this directory. Change the name of the file <code>modMyModule.class.php</code> to the name corresponding to the purpose of your module. Name of the file must start with <code>mod</code> and end with <code>.class.php</code> (for example if you want to give the name 'NewName' to this file, then the name should be <code>modNewName.class.php</code>).

Then, modify the contents of this file as follows:

*Replace all occurrences of "modMyModule" with a value which corresponds to the purpose of your module. This value must always start with 'mod' and contain only alpha characters (again, if the name given to the file was 'NewName', then replace all "modMyModule" with "modNewName").
*Change the number in: $this->numero = 100000 by a number that designates your module id. To avoid conflicts with other modules, you can consult the page that lists already reserved id numbers: [[List of modules id|List of modules id]].
*Modify any other variables defined in the constructor (see comment in the code skeleton for their meaning).

Your file descriptor for your module is ready. See the next step to activate it.

===Test your descriptor===

Launch Dolibarr and go to page '''Setup->module'''?
If you set the property version in the module description you should see a new line with your new module and the possibility to activate it or not. If you set the property version to "develop" or "experiental", to see your module, you must first go into '''Setup-Others''' and set MAIN_FEATURES_LEVEL to 1 to see "experimental" modules or 2 to see "development" modules.

==Tree of path for new module files (required)==
This is how your files must be organized when building a new module (the zip file must also match this rule).
Note: Only the second line is mandatory.

{{TemplateModuleTreeSimple}}

==Create your SQL tables and the PHP DAO class (optional)==
'''When''': If your module needs to manage data of its own

===Create your .sql file===
If your module is designed to manage data of its own, which are not available in the standard version of Dolibarr, it is necessary to define SQL tables to store the data.

Scripts for creating tables and loading data by your own module are saved into a subdirectory sql ('''"mymodule/sql"''') of your module. (With ModuleBuilder, the directory and all sql files will be created automatically when you will create a new Object from tab Object).

Then check into your descriptor file, into function '''init''' that the line

<syntaxhighlight lang="PHP">$this->_load_tables('/mymodule/sql/');</syntaxhighlight>

is not commented.

''Rules to follow:''

*Add the files about creating tables commands on the principle of an '''llx_mytable.sql''' file per table, with an optional '''llx_mytable.key.sql''' file (see existing files in '''install/mysql/tables''' for examples).
*The recommended type and name for SQL fields are defined into page [[Language_and_development_rules#Table_and_fields_structures]].
*To manage data, you must create a file called '''data.sql''' inside directory '''/mymodule/sql/''' that contains SQL command to add/edit/delete data.
*Don't use the double quote for strings (eg 'chaine' not "chaine") because the double quote have a specific meaning in PostGreSQL

Example of content of a file data.sql
<syntaxhighlight lang="sql">
delete from llx_const where name='MYMODULE_IT_WORKS' and entity='__ENTITY__';
insert into llx_const (name, value, type, note, visible, entity) values ('MYMODULE_IT_WORKS','1','chaine','A constant vor my module',1,'__ENTITY__');
</syntaxhighlight>

Files must be operational for the database mysql. Note: The files of other databases are not maintained. They will be read and converted on the fly by the driver of the other database.

===Test your .sql files===

Once the files ready, you can return to the page to enable Dolibarr modules and disable the module, drop those tables in the database (if they already exist) and reactivate the module. The tables should be recreated by the activation of the module. If this is not the case, check your scripts by passing them by hand, or check the Dolibarr logs.

===Generate the PHP DAO class===
The DAO PHP files should have been generated by ModuleBuilder after creating an object.

You can however create them manually by copying existing object however using ModuleBuilder is highly recommended. You should find examples into '''htdocs/modulebuilder/templates/class/myobject.class.php'''

In this class, there are already operational CRUD (Create/Read/Update/Delete) methods to perform an insert, a fetch (select), an update, a delete of a table row. Edit the file to use the correct module name, tables and place this file in the class subdirectory of the module. The Module Builder allows you to do this with just a few mouse clicks.

==The tab management (optional)==

===Add or remove your own tabs on object sheets===
'''When''': To add a tab on an object (invoices, orders, proposals, member ...)

To do this go into the file descriptor of module previously created and edit the $this->tabs array:

<syntaxhighlight lang="PHP">
// Array to add new pages in new tabs or remove existing one
$this->tabs = array('objecttype:+tabname1:Title1:mylangfile@mymodule:$user->rights->mymodule->read:/mymodule/mypagetab1.php?id=__ID__' // To add a new tab identified by code tabname1
'objecttype:+tabname2:Title2:mylangfile@mymodule:$user->rights->mymodule->read:/mymodule/mypagetab2.php?id=__ID__', // To add a new tab identified by code tabname2
'objecttype:-tabname'); // To remove an existing tab identified by code tabname
</syntaxhighlight>

The table should contain a list of strings, each string representing a new tab.
The format of the string consisting of 5 parts separated by ":"

*Part 1: The element type (object type) where the tab should appear is a value from the following:
{{TemplateModuleTabs}}

*Part 2: A code to identify tab to add (start with +tabname1) or to remove (start with -tabname1)
*Part 3: The title of the tab(Title1). This can be a hardcoded read or better a code translation in module lang file .
*Part 4: The name of the file "*.lang" (mylangfile@mymodule) which contains correspondence between the code translation and language to display. If this name is followed with @mymodule, Dolibarr will search translation file "*.lang" within the module in htdocs/custom/mymodule/langs/code_CODE/mylangfile.lang, otherwise Dolibarr will look for file in htdocs/langs/code_CODE/mylangfile.lang
*Part 5: A condition to test if tab must be visible($user->rights->mymodule->read) '''or''' put 1 to be always visible.
*Part 6: The URL of the page to display when you click on the tab (/mymodule/mypagetab1.php). The __ID__ string will be replaced automatically by the Id of the element concerned.

To feed the contents of the tab with data from the database, see the next chapter.

In order to get the names 'tabname' of existing tabs, you have to check the names used in the function 'product_prepare_head' of the file 'core/lib/module.lib.php' corresponding to section '$head[$h][2]'.

===Show tabs navigation into your own pages===
'''When''': To show all standard tabs of an object (product, tiers, etc.) on your page.

You must follow these steps :

'''1. Include files you need into your file'''

For each object type, there are two files to include with line
<syntaxhighlight lang="PHP">require_once($url_fichier) ;</syntaxhighlight>

This is example of files to include (DOL_DOCUMENT_ROOT is often dolibarr/htdocs/) :

*Object thirdparty (thirdparty) :
**DOL_DOCUMENT_ROOT/societe/class/societe.class.php
**DOL_DOCUMENT_ROOT/core/lib/company.lib.php
*Object product (product) :
**DOL_DOCUMENT_ROOT/product/class/product.class.php
**DOL_DOCUMENT_ROOT/core/lib/product.lib.php
*Object invoice (invoice) :
**DOL_DOCUMENT_ROOT/compta/facture/class/facture.class.php
**DOL_DOCUMENT_ROOT/core/lib/invoice.lib.php

...

'''2. Create and load the object to show into your tab'''

Create an instance of an object of the correct class and load object from the database by using the fetch method of an object in providing to this method the id you get from URL (ie : /mytab.php?id=1).

''Example :''
<syntaxhighlight lang="PHP">
$id=GETPOST('id','int');
$ref=GETPOST('ref','alpha');
$product = new Product($db) ;
$result = $product->fetch($id,$ref) ; // Test $result to check the database read is ok
</syntaxhighlight>

'''3. Get a list of all tabs to show for your object type'''

Use function XXX_prepare_head($obj), where XXX is name of object. This will return an array with all definition of tab entries to show. The parameter to put into this method is the instance of an object you want tabs.

The resulting array has the following structure
<syntaxhighlight lang="PHP">
$head // Array of tabs
$head[$h] // Element to describe one tab.
$head[$h][0] // Url of page to show when you click on tab
$head[$h][1] // Title of tab
$head[$h][2] // Code name to identify the tab
</syntaxhighlight>

''Example :''
<syntaxhighlight lang="PHP">
$head = product_prepare_head($product, $user) ; // parameter $user is present for some function anly
</syntaxhighlight>

'''4. show tabs into your page'''

Use function dol_fiche_head() to show all tabs defined into array $head returned by XX_prepare_head().

<syntaxhighlight lang="PHP">
dol_fiche_head($links, $active='0', $title='', $notab=0, $picto='')
//$links // Tableau des onglets, appelé $head plus haut.
//$active // Onglet actif (mettre le nom de l'onglet défini dans votre fichier de module, ou un nom contenu dans $head[$h][2]). Cet onglet sera mis en surbrillance
//$title // Title to show (shown into a special tab that you can't click)
//$notab
//$picto // Name of image to show into title. Possible values are:
// product
// service
// company
</syntaxhighlight>

This function will show required tabs and open an html element ''< div class="" >'' that correspond to the area under the tabs. To close area of a tab, just use ''< /div >'' into your PHP page.

==Create or modify PHP screens (optional)==
'''When''': If the purpose of your module is to add features that require new or modified screens.

===Create a new PHP screen===
You must then create your PHP pages that will show/edit data from tables using the skeleton templates provided as an example in the directory '''modulebuilder/myobject_page.php''' (For the development of a script from the command line, see [[Script development]]).

To create a new user screen, create a subdirectory of '''htdocs''' (if not already done) for your module (in '''htdocs/mymodule''' for example) to store the pages you will create.

Copy, into that directory, the file '''myobject_page.php''' that will serve as a starting point for your page file.
Edit the file to have a correct relative path to the main.inc.php file.
<syntaxhighlight lang="PHP">
// Load Dolibarr environment
$res=0;
// Try main.inc.php into web root known defined into CONTEXT_DOCUMENT_ROOT (not always defined)
if (! $res && ! empty($_SERVER["CONTEXT_DOCUMENT_ROOT"])) $res=@include($_SERVER["CONTEXT_DOCUMENT_ROOT"]."/main.inc.php");
// Try main.inc.php into web root detected using web root calculated from SCRIPT_FILENAME
$tmp=empty($_SERVER['SCRIPT_FILENAME'])?'':$_SERVER['SCRIPT_FILENAME'];$tmp2=realpath(__FILE__); $i=strlen($tmp)-1; $j=strlen($tmp2)-1;
while($i > 0 && $j > 0 && isset($tmp[$i]) && isset($tmp2[$j]) && $tmp[$i]==$tmp2[$j]) { $i--; $j--; }
if (! $res && $i > 0 && file_exists(substr($tmp, 0, ($i+1))."/main.inc.php")) $res=@include(substr($tmp, 0, ($i+1))."/main.inc.php");
if (! $res && $i > 0 && file_exists(dirname(substr($tmp, 0, ($i+1)))."/main.inc.php")) $res=@include(dirname(substr($tmp, 0, ($i+1)))."/main.inc.php");
// Try main.inc.php using relative path
if (! $res && file_exists("../main.inc.php")) $res=@include("../main.inc.php");
if (! $res && file_exists("../../main.inc.php")) $res=@include("../../main.inc.php");
if (! $res && file_exists("../../../main.inc.php")) $res=@include("../../../main.inc.php");
if (! $res) die("Include of main fails");
</syntaxhighlight>
As you can see, there are several tries to load the main.inc.php (or master.inc.php). The goal is to succeed in the most cases as possible. The minimum is 2 lines: one to try to load the master/main.inc.php into the dolibarr root directory and another one to try to load the file to support the case when the module is deployed into the "custom" directory. But you can have more to deal more situation. The provided example should be able to load the file main/master.inc.php in nearly all situation/setups.

Note that you may add more "../" depending on the depth of the file relative to your module directory tree.

It's in the main.inc.php file that is loaded technical environment variables and permissions. The following variables are objects positioned in this file:

*$user Object that contains the characteristics of the user + his permissions.
*$conf Object that contains Dolibarr configuration.
*$db Object that contains an opened connection handler to the database.
*$langs Object that contains the user's language.

Then enter your code to display the page.

*To include a class or library dedicated to the module is done using a Dolibarr function (and not using directly include_once):

''Example :''
<syntaxhighlight lang="PHP">
dol_include_once('/mymodule/class/myclass.class.php', 'MyClass');
</syntaxhighlight>

*To include classes provided with Dolibarr, use the following syntax:

''Example :''
<syntaxhighlight lang="PHP">
require_once DOL_DOCUMENT_ROOT.'/core/class/doli.class.php';
</syntaxhighlight>

===Add some fields into existing forms===
You may want to provide a module that adds more fields into forms (input and view) of some elements.

A heavy solution (but not so bad) may be to replace all pages used to create element (this means to disable the "New element" menu entry and adding yours, and disable tab that shows element to replace with a tab that is your own full page (copied/pasted from original) to do same than original page but modified to add your fields and stored added data into your own table). Go to menu [[#Define your entries in the menu (optional)]] and [[#The tab management (optional)]] if this solution suits you (this solution is more powerful since you can change everything you want into the page).

We will describe here another solution, that works only to "add fields" at end of existing fields, using the element "category" as an example but you can convert this tutorial for invoice, proposal ...

*First thing is to add a table, owned by your module, to store the value of new fields. This table will have only one column called "rowid" (will contain the same value than field rowid of element table) + one column for each new field you want to add. Then create a class with CRUD (Create/Read/Update/Delete) methods for this new table. For this two tasks, go back to previous chapter [[#Create your SQL tables and the PHP DAO class]].
*Next step is to add a hook into your module to add the new fields into the form. See chapter [[Hooks_system#Implement_the_Hook]] for generic documentation to use hooks.

If you follow this tutorial, to be able to add fields into category forms, you must do:
{{ToComplete}}

===Add/replace part of fields supported by hooks===
See chapter [[Hooks_system#Implement_the_Hook]] to know how to use Dolibarr existing hooks to add/replace code at Dolibarr hooks place.

===Database access===
If you need to edit some data in the database inside your own table, use the PHP class generated before.

If you to make access to tables with no dedicated PHP class available, this is always possible (for example if you want to get a list of records with a particular join or filter). In this case, this is a code samples to follow:

To make an insert, update or delete:

<syntaxhighlight lang="PHP">
$db->begin(); // Start transaction
$db->query("My SQL request insert, update or delete");
$db->commit(); // Validate transaction
or $db->rollback() // Cancel transaction
</syntaxhighlight>

To read:

<syntaxhighlight lang="PHP">
$resql=$db->query("My select request");
if ($resql)
{
$num = $db->num_rows($resql);
$i = 0;
if ($num)
{
while ($i < $num)
{
$obj = $db->fetch_object($resql);
if ($obj)
{
// You can use here results
print $obj->field1;
print $obj->field2;
}
$i++;
}
}
}
</syntaxhighlight>

===Define style of your pages===
To have the look of your own pages to match the Dolibarr theme, it is necessary to use the Dolibarr CSS styles.

You can use for example:

*class="'''liste_titre'''" on tags ''tr'' and ''td'' for the head row of a table.
*class="'''pair'''" or class="'''impair'''" on tags ''tr'' and ''td'' of other rows of a table.
*class="'''flat'''" on all input fields (''input, select, textarea''...).
*class="'''button'''" on HTML fields with type ''input type="submit"''.

===Use the Dolibarr date picker===
If you want to use the Dolibarr date selector (with its calendar popup) into your pages, use the following line:
<syntaxhighlight lang="PHP">
$form=new Form($db);
$form->select_date('','mykey',0,0,0,"myform");
</syntaxhighlight>
The string mykey will identify the date selector in the form. You must use different values if you use several date selectors in same page.
The string myform is the name of the FORM in which the selector is included (value found in the form name="myform" in HTML page).
This means a date selector must be included necessarily into an html FORM.

To get value after the POST of your form, the command is:
<syntaxhighlight lang="PHP">
$mydate = dol_mktime(12, 0 , 0, $GETPOST('mykeymonth', 'int'), GETPOST('mykeyday', 'int'), GETPOST('mykeyyear', 'int'));
print strftime('%A %d %B %Y', $mydate);
</syntaxhighlight>

===Overwrite template file (tpl)===
If you want to overwrite tpl file on your module, you need to declare it on the module_parts :
<syntaxhighlight lang="PHP">
'tpl' => 1,
</syntaxhighlight>
Then you can put any tpl file on '''mymodule/core/tpl'''
as soon as the module is activate, the tpl will be overwrited

==Add your own setup page (optional)==
'''When''': If your module needs parameters, which are to be provided by the user, for proper setting up of the module.

===Create your page to edit parameters===
If your module needs several parameters to be setup, you must create a page to edit options (these options will be saved in the [[Table llx_const|table '''llx_const''']]).
Create a page named '''mymodule_setuppage.php''' that shows a form for possible options to update them into the above-mentioned table.
It is necessary to take an example from a page of the directory '''/admin''' that will show you the way to read/save your parameters.
Put this PHP page into the directory '''/admin''' of your module (e.g. mymodule/admin/mymodule_setuppage.php).

===Modify the descriptor file of your module===
Then, within the descriptor file of your module, modify the variable '''config_page_url''' to set the name of this PHP page.
If the page is in the directory '''admin/''', then the path is not required, e.g. like this:
<syntaxhighlight lang="PHP">
$this->config_page_url = array("mymodule_setuppage.php");
</syntaxhighlight>
If the page is in the directory '''mymodule/admin/''', then like this:
<syntaxhighlight lang="PHP">
$this->config_page_url = array("mymodule_setuppage.php@mymodule");
</syntaxhighlight>

===Test your page===
Go into page '''Home->Setup->Modules''', you should see a picture at the end of the line of your module to reach your setup page. Click on it, you should be able to view/edit parameters from your page.

==Define your entries in menu (optional)==
'''When''': If you have created PHP pages, it is necessary that those pages can be reached from menu entries in Dolibarr menu.

===Define your menu entries===
For this, you must define into the module descriptor, the array this->menu that declares all menus added by your module.
This array contains entries that will appear once your module is activated.
The example module descriptor file '''modMyModule.class.php''' contains an example to declare a top menu and also its left menu entries.

This is the example of code to declare your own menu entries in a module descriptor file:
<syntaxhighlight lang="PHP">
// Main menu entries
$this->menu = array(); // List of menus to add
$r=0;

// Add here entries to declare new menus
// Example to declare the Top Menu entry:
$this->menu[$r]=array( 'fk_menu'=>0, // Put 0 if this is a top menu
'type'=>'top', // This is a Top menu entry
'titre'=>'MyModule top menu',
'mainmenu'=>'mymodule',
'leftmenu'=>'mymodule',
'url'=>'/mymodule/pagetop.php',
'langs'=>'mylangfile', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
'position'=>100,
'enabled'=>'1', // Define condition to show or hide menu entry. Use '$conf->mymodule->enabled' if entry must be visible if module is enabled.
'perms'=>'1', // Use 'perms'=>'$user->rights->mymodule->level1->level2' if you want your menu with a permission rules
'target'=>'',
'user'=>2); // 0=Menu for internal users, 1=external users, 2=both
$r++;

// Example to declare a Left Menu entry:
$this->menu[$r]=array( 'fk_menu'=>'fk_mainmenu=xxx', // Use 'fk_mainmenu=xxx' or 'fk_mainmenu=xxx,fk_leftmenu=yyy' where xxx is mainmenucode and yyy is a leftmenucode of parent menu
'type'=>'left', // This is a Left menu entry
'titre'=>'MyModule left menu 1',
'mainmenu'=>'xxx',
'leftmenu'=>'yyy',
'url'=>'/mymodule/pagelevel1.php',
'langs'=>'mylangfile', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
'position'=>100,
'enabled'=>'1', // Define condition to show or hide menu entry. Use '$conf->mymodule->enabled' if entry must be visible if module is enabled.
'perms'=>'1', // Use 'perms'=>'$user->rights->mymodule->level1->level2' if you want your menu with a permission rules
'target'=>'',
'user'=>2); // 0=Menu for internal users,1=external users, 2=both
$r++;
</syntaxhighlight>

To show the menu or not depending on a permission, modify property '''perms''' in the array. See chapter on permissions later to see how to add permissions.

===Test your menu entries===
Disable and re-enable your module under the Dolibarr module setup page, menus entries must appear (if property 'enabled' is declaration array is ok).

==Add your own permissions (optional)==
'''When''': If you want to add new permissions.

The way to define permissions that will manage your module is done inside the module descriptor created previously.
Modify line
<syntaxhighlight lang="PHP">
$this->rights_class = 'mymodule'
</syntaxhighlight>
with correct value for mymodule.

Then you must fill the array $this->rights with as many entries than different permissions you need to manage.

<syntaxhighlight lang="PHP">
$this->rights[$r][0] = 10001;
$this->rights[$r][1] = 'Label by default of permission';
$this->rights[$r][2] = 'r';
$this->rights[$r][3] = 1;
$this->rights[$r][4] = 'action';
$this->rights[$r][5] = 'subaction';
$r++;
</syntaxhighlight>

Into $this->rights[$r][0], put a permission id not already used (See into menu '''System info''' on a working installation of Dolibarr to know list of id already used by standard modules.
Into $this->rights[$r][1], put a label by default for permission (This label will be used if no translation can be found into the file '''admin.lang''' Translation key should be "Permission10001=My permission Label").
Into $this->rights[$r][2], types of the permission. There are three type of permission, 'r' for read, list or expert permission, 'w' for write or update permission and 'd' for delete permission.
Into $this->rights[$r][3], put 1 if this permission must be granted automatically by default to any newly created user.
Into $this->rights[$r][4] and $this->rights[$r][5], put an action and subaction string without spaces. You will be able to test if a user has the permission in your PHP source code with the sequence:

<syntaxhighlight lang="PHP">
if ($user->rights->mymodule->action->subaction) ...
</syntaxhighlight>

==Define your own box (optional)==
'''When''': If your module needs to provide one or several new boxes to show on home page.

===Define your box===
For this, modify the array $this->boxes into the module descriptor file.
All you have to do is to add 2 lines for each box file you will create into directory '''htdocs/mymodule/core/boxes'''

''Example:''
<syntaxhighlight lang="PHP">
$this->boxes[0]['file']='mybox0.php@mymodule'
$this->boxes[0]['note']='My box 0'
...
$this->boxes[n]['file']='myboxn.php@mymodule'
$this->boxes[n]['note']='My box n'
</syntaxhighlight>

Then create files '''htdocs/mymodule/core/boxes/mybox0.php''', '''htdocs/mymodule/core/boxes/mybox1.php'''... by copying an example from an existing box file (found into directory '''htdocs/core/boxes''').

===Test if your box is detected by Dolibarr===
Disable and enabled module.

Go into menu '''Home - Setup - Boxes'''.

Your boxes must appear in the list of boxes you can activate. Activate the box and go on the home page to see if the box is showing correctly.

==Define your own export (optional)==
'''When''': If your module provides new predefined database export profiles (for its own tables or for already existing tables of another module).

===Define export===
For this uncomment and modify arrays $this->export_xxx in your module descriptor file.

===Test your export===
Go into menu Tools -> Export. Your export will appear in the list of available predefined exports (if your module is enabled).
Choose it, you must see a list of all possible fields defined in the export arrays.
Choose on field and try to build an export file. If ok, try again with all fields.

==Define your CSS styles (optional)==
'''When''': If in your PHP pages, you use class styles that are not defined inside Dolibarr themes CSS (not recommanded).

===Create and declare your style sheet===
Create a style sheet CSS named '''mymodule.css''' or '''mymodule.css.php''' and put it into directory '''htdocs/mymodule'''. You can have several CSS files per module.
Remember it's better to use existing styles already available by default into Dolibarr (The CSS file used by Dolibarr is file '''themes/mytheme/''themename''.css.php'''. Create your own CSS files only if you need absolutely to add not already existing styles.

Once your style sheets are ready, declare them into your module descriptor file by modifying the property '''$this->modules_parts'''.
Value to put here must be an array of relative URLs to your CSS files.
For example
<syntaxhighlight lang="PHP">
$this->module_parts = array('css' => array('/mymodule/css/mymodule.css.php','/mymodule/css/myother.css'));
</syntaxhighlight>

===Test your style sheet===
Disable and enable your module.

Go on the home page (index.php). Show the HTML source of the page.

You should see into the HTML header, a line that declares your style sheet.

==Add your Javascript functions (optional)==
'''When''': If in your PHP pages, you use javascript functions not available in Dolibarr (in file lib_head.js)

If you need to use your own javascript functions inside your PHP pages, it is necessary to have your functions, defined into your javascript file '''htdocs/mymodule/js/mymodule.js''', included into the HTML HEAD section.
To ask Dolibarr that forge this header to include your own javascript file, you must just provide it to the llxHeader() function called by your page.

Example for page /htdocs/mymodule/mypage.php :
<syntaxhighlight lang="PHP">
$morejs=array("/mymodule/js/mymodule.js");
llxHeader('','Titre','','','','',$morejs,'',0,0);
</syntaxhighlight>

==Run your own code on any Dolibarr event (optional)==
'''When''': If you want to execute your own code once a common Dolibarr event has occurred (example: I want to update a table in my module when an invoice is created into Dolibarr), you must create a '''triggers'''.

See also [[Interfaces_Dolibarr_toward_foreign_systems]]
and [[Interfaces_from_foreign_systems_toward_Dolibarr]]

==Insert your code inside Dolibarr hooks positions (optional)==
'''When''': When you want to add code or replace Dolibarr code into another situation than a business event (See the previous chapter for adding code during a business event).

See page [[Hooks_system]].

==Add your own numbering rules==
'''When''': When you need a new rule for generated ref of elements that are not covered by existing rules.

See page [[Create numbering module]].

==Add your document template (optional)==
'''When''': When you want to personalized your own generated PDF or ODT documents.

Note: To add this feature you don't need to create a module descriptor.

Documentation to add your own template is available on page [[Create_a_PDF_document_template]] or [[Create_an_ODT_document_template]].

==Add your skin (optional)==
'''When''': When you want to personalized your colors/fonts/images.

Note: To add this feature you don't need to create a module descriptor.

To add your own skin, read page [[Skins]].

=Some coding rules and predefined functions=
The coding rules to be followed are defined in the [[Developer documentation]], under section "General Information - Language and standards development".

A lot of predefined features for developers are also available and described into page [[Developer documentation]] under section "Technical components of Dolibarr".

=Create a package to distribute and install your module=
This process must be used to generate a package to submit it on the http://www.dolistore.com marketplace.
But you can use it to have a package easy to distribute on your own network.

*Go into the directory '''/build''' and copy the file '''makepack-dolibarrmodules.conf''' into '''makepack-mymodule.conf'''. Warning, this directory may not be provided in some packages of stable versions. If so, it can be retrieved from the snapshot available for download on the Dolibarr website in area "Development version" (taken in this case the whole build directory which is autonomous and independent directory).

Edit this file to add a list of file names for all new files you created for your module (module descriptor, new sql tables files, php page, images, etc...)

*Run the script via Perl (need the Perl version 5.0 or later):

<syntaxhighlight lang="bash">
perl makepack-dolibarrmodule.pl
</syntaxhighlight>
The script asks you the name of your module, its major and minor version. A file '''mymodule.zip ''' will then be manufactured containing your module ready to be deployed.

*The person who receives your module must then place the file in the root directory of a Dolibarr installation and perform the command:

<syntaxhighlight lang="bash">
tar -xvf mymodule.zip
</syntaxhighlight>

*If you want your module to be public, you can submit it (the zip file) on Dolibarr marketplace website: {{LinkToPluginDownload}} (you must create an account first and be logged to use the link "Submit a module/product").
**If your module was built correctly, the file will be validated later.
**If quality is enough and license permits it, the code might be added inside main Dolibarr sources (except if you disagree for that).

=Enabling/activation condition of external module on DoliStore=

See [[Module_Dolistore_Validation_Rules|Validation Rules]]
[[Category:Development]]

Triggers system

2023-11-23T10:45:55Z

TanguyP: Update class name as per Dolibarr 18.0.2

[[fr:Système de Triggers]]
[[es:Triggers-acciones]]
[[zh:触发系统]]


{{TemplateDocDevEn}}

=Execute your own code on a Dolibarr business event=
To execute personalized code after a Dolibarr event (create/modify/remove a third party/invoice/product or other), Dolibarr offers a mechanism of business triggers. This mechanism allows you to personalize a work-flow to have Dolibarr business events being synchronized into another application for example.
You can also use triggers to modify the behavior of Dolibarr itself: for example, to create a contract automatically when an invoice is validated, a fill a log file when a record is deleted, ...

Note that triggers is a feature for developers that is limited to business CRUD events (Create | Read | Update | Delete). There is another feature for developers to inject custom code in the application called the [[Hooks system]].

So, to add your own code that will be triggered by a Dolibarr trigger, this is the process:

1) Copy the template trigger file '''htdocs/modulebuilder/template/core/triggers/interface_99_modMyModule_MyModuleTriggers.class.php''' under the new name:

*'''interface_99_all_''Xxx''.class.php'''

or

*'''interface_99_mod''MyModule_Xxx''.class.php'''

where ''Xxx'' is a string of your choice starting with uppercase character, ''99'' is the priority number for the execution of your trigger (1 being the top priority) and ''MyModule'' is the name of a module if you want that trigger is activated only if module MyModule is activated. If you want the trigger to be always active, use ''all'' instead of modMyModule.
This new file must be saved inside same directory.

Note: Value you can use for mod MyModule are values found in directory
''htdocs/includes/modules''.

'''WARNING''': All those parameters are necessary for the trigger to be detected and executed! Eg: if you forget the priority number, your trigger won't be detected!

For example, you can name your new trigger file:
''htdocs/includes/triggers/interface_99_modFacture_Myworkflow.class.php''

By creating such a file with a name like the example, your new trigger file will be executed each time a Dolibarr business event occurs but only if the module Facture is enabled.

'''Note''': If you develop a full module, you can also place the trigger file in your own module's subdirectly. Eg: if your module resides in htdocs/mymodule/, then you can place your triggers inside htdocs/mymodule/core/triggers/. But for this, you must declare the trigger into your module descriptor file (eg: '''/mymodule/core/modules/modMyModule.class.php'''). For this, add into this file triggers->1 into module_parts array:
<syntaxhighlight lang="PHP">
// Defined all module parts (triggers, login, substitutions, menus, etc...) (0=disable,1=enable)
$this->module_parts = array('triggers' => 1);
//$this->module_parts = array('triggers' => 1,
// 'login' => 0,
// 'substitutions' => 0,
// 'menus' => 0);
</syntaxhighlight>
Then disable and reenable your module. This will add a record into [[Table llx_const]] to tell Dolibarr that a trigger file must be searched in the module directory '''htdocs/mymodule/core/triggers/'''

2) Edit the file ''interface_99_modMyModule_Myworkflow.class.php'' to rename class ''InterfaceMyModuleTriggers'' by ''InterfaceMyworkflow''

Then go on page Home -> Admin Tools -> About Dolibarr ->Triggers.
Your new trigger file must appears in the list without any error message. This means preceding actions have been done successfully.

3) Return now to edition of file to add your own code inside function ''run_trigger''.
This function is called at each Dolibarr business event. Put your code according to events on which you want to run. Each event is identified by a code (see following chapter to get full list of codes). So you can react or no after an event by doing just a test on variable '''$action''':

<syntaxhighlight lang="PHP">
function run_trigger($action,$object,$user,$langs,$conf)
{
// Put here code to execute after an action
// The type of Dolibarr business event is stored into $action
// Data of action are stored into object $object
// Setup, user and language are saved into $conf, $user and $lang
if ($action == 'COMPANY_CREATE')
{
dol_syslog("Trigger for action '$action' launched. id=".$object->id);
}
elseif ($action == 'COMPANY_MODIFY')
{
dol_syslog("Trigger for action '$action' launched. id=".$object->id);
}
elseif ($action == 'COMPANY_DELETE')
...
}
</syntaxhighlight>

You can do what you want into this coding part, if you check that function run_trigger returns a return code according to following rule:

<0 if KO, 0 if nothing is done, >0 if OK

You can also use, inside this function, the following preinitialized variables:

*'''$object''' is the object on which action is done (see next chapter)
*'''$user''' is the object containing all information of Dolibarr user that realizes the business event.
*'''$langs''' is the object that contains the user language and translations strings
*'''$conf''' is the object that contains all the Dolibarr configuration.

4) Once your trigger file has been developed, last action is to test by using Dolibarr to execute the business event that should trigger your code. Warning, call of function '''run_trigger''' is encapsulated into a transaction. If your code return a KO code, the calling function may rollback the transaction (this depends on calling function).
Add log information inside your function '''run_trigger''' to know if your code is correctly triggered and runs correctly. For this, you can use the function
dol_syslog("my log message", LOG_DEBUG);

=List of known triggers actions=

Here is a quick view of the events that cause triggers to be searched and executed. An event is characterized by the value of the code ''$action'', with the type of the object received in ''$object''.

Note: The [[Module Agenda En|Module Agenda]] and [[Module Notification]] use the table [[Table llx c action trigger]] as a list of known triggers. This avoid scanning the disk for this information, but this table is just a very limited list.

In general, the trigger action code begins with the name of the module followed by the character _.

{{TemplateListOfTriggers}}
This list may be not complete.

=Manage and create a new trigger's action=

To manage events other than those above, you must modify the Dolibarr code to add the following sequence in the business methods of the classes of the objects handled:

<syntaxhighlight lang="PHP">
// Call trigger
$result = $this->call_trigger('CODE_TRIGGER', $user);
if ($result <0) $error++;
// End call triggers
</syntaxhighlight>

To add context information (for example to dissociate 2 different cases called with the same Trigger code), it is possible to place this information in the properties ->context of the object on which the trigger is called. Example:

<syntaxhighlight lang="PHP">
// Call trigger
$this->context = array('paramX'=>$valueX, 'anyparamofyourchoice'=>$anyvalue);
$result = $this->call_trigger('CODE_TRIGGER',$user);
if ($result < 0) $error++;
// End call triggers
</syntaxhighlight>

It will then be possible to add in the run_trigger method of any trigger file, an if which allows you to manage this code. The run_trigger method would then be of the form:

<syntaxhighlight lang="PHP">
function run_trigger($action,$object,$user,$lang,$conf)
{
// Put here code to execute after an action
// The type of Dolibarr business event is stored into $action
// Data of action are stored into object $object
// Setup, user and language are saved into $conf, $user and $lang
if ($action == 'XXXXX_YYYYY')
{
dol_syslog("Trigger for action '$action' launched. id=".$object->id);
}
elseif ($action == 'COMPANY_CREATE')
{
dol_syslog("Trigger for action '$action' launched. id=".$object->id);
}
elseif ($action == 'COMPANY_MODIFY')
{
dol_syslog("Trigger for action '$action' launched. id=".$object->id);
}
elseif ($action == 'COMPANY_DELETE')
...
}
</syntaxhighlight>

'''Please note the following before adding additional calls to triggers:'''

The rule is to have only 1 trigger call per business CRUD event, even when several actions are done in the same transaction.
As an example: When a new ticket is created with an already assigned user, only the TICKET_CREATE trigger is called, not additionally the TICKET_ASSIGNED trigger. It is the job of the trigger to intercept also this case to scan if an assignment is done directly during creation and to execute its custom code.

=Conclusion=
You can in few minutes, add an interface from Dolibarr towards another system (or why not towards Dolibarr itself), with no risk since you don't touch anything to Dolibarr files. You only "added" a new trigger file inside the trigger directory.
If this new interface can serve a lot of other users, you can package it into a tgz file (see page [[Module_development#Create_a_package_to_distribute_and_install_your_module]]) and submit it on the download area in section external contributions on official Dolibarr web site.

=See also=

*[[Hooks system]]
*[[Interfaces Dolibarr toward foreign systems]]
*[[Interfaces from foreign systems toward Dolibarr]]

Module development

2023-11-05T08:52:32Z

TanguyP: /* Create your SQL tables and the PHP DAO class (optional) */ Language

[[fr:Développement_module]]
[[es:Desarrollo_de_un_módulo]]
[[de:Modul_Entwicklung]]
[[zh:模块开发]]
[[ja:モジュール_開発]]


[[Category:Core]]
{{TemplateDocDevEn}}

To create a new module/addon for Dolibarr, there is several steps. This tutorial will describe you each of them to build a module to extend Dolibarr features, like one or several of the following :

*Add new tables in database.
*Add your own menu entries.
*Add new screens to edit new tables.
*Add or remove tabs on object view (invoice, product, order, event, ...).
*Add predefined exports for the internal export tool.
*Add new information widget in the home page.
*Add new substitutions variables.
*Define new permissions.
*Execute code automatically triggered by a particular Dolibarr action.
*Insert your code inside Dolibarr hooks positions.
*Add your numbering rule to generate the reference of objects
*Add a new document template.
*Add a new skin.

etc...

Following chapters presents how to do all of this manually with an easy way.

=Module creation with the module builder=
From Dolibarr 9.0 it is possible to create the main pages of your module with the Module Builder. To activate it:

*Go into the list of module and enable the module "Module Builder",

[[File:Mod_builder_2.png|400px]]

*Then click on the "bug" image in the top right of screen.

[[File:Mod_builder_3.png|400px]]

=Example of Template External Module=
A good model to start development of external module can be found here : [https://github.com/Dolibarr/dolibarr/tree/develop/htdocs/modulebuilder/template GitHub Dolibarr Module Modèle]

=Create your module=
==Create a Module descriptor for your Module (required)==
'''When it is required''': Required as soon as an addon is developed, whatever its goal is (except for adding a skin).

'''Since Dolibarr 9.0, you should use the ModuleBuilder module provided as a standard module to generate the module descriptor'''

===Create your module descriptor===
The first step is to create a file descriptor for the module.

*Create directory '''/htdocs/custom/''mymodule''/core/modules''' (for an external module) or '''/htdocs/''mymodule''/core/modules''' if you plan to have this module an official core module of Dolibarr. Then copy the file modMyModule.class.php from the directory '''htdocs/modulebuilder/template''' into this directory. Change the name of the file modMyModule.class.php to the name corresponding to the purpose of your module. Name of the file must start with initial 'mod' and end with .class.php (for example if you want to give the name 'NewName' to this file, then the name should be 'modNewName.class.php').

Next modify the contents of this file as follows:

*Replace all "modMyModule" with a value which corresponds to the purpose of your module. This value must always start with 'mod' and contain only alpha characters (again, if the name given to the file was 'NewName', then replace all "modMyModule" with "modNewName").
*Change the number in: $this->numero = 100000 by a number that designates your module id. To avoid conflicts with other modules, you can consult the page that lists already reserved id numbers: [[List of modules id|List of modules id]].
*Modify any other variables defined in the constructor (see comment in the code skeleton for their meaning).

Your file descriptor for your module is ready. See the next step to activate it.

===Test your descriptor===

Launch Dolibarr and go to page '''Setup->module'''?
If you set the property version in the module description you should see a new line with your new module and the possibility to activate it or not. If you set the property version to "develop" or "experiental", to see your module, you must first go into '''Setup-Others''' and set MAIN_FEATURES_LEVEL to 1 to see "experimental" modules or 2 to see "development" modules.

==Tree of path for new module files (required)==
This is how your files must be organized when building a new module (the zip file must also match this rule).
Note: Only the second line is mandatory.

{{TemplateModuleTreeSimple}}

==Create your SQL tables and the PHP DAO class (optional)==
'''When''': If your module needs to manage data of its own

===Create your .sql file===
If your module is designed to manage data of its own, which are not available in the standard version of Dolibarr, it is necessary to define SQL tables to store the data.

Scripts for creating tables and loading data by your own module are saved into a subdirectory sql ('''"mymodule/sql"''') of your module. (With ModuleBuilder, the directory and all sql files will be created automatically when you will create a new Object from tab Object).

Then check into your descriptor file, into function '''init''' that the line

<syntaxhighlight lang="PHP">$this->_load_tables('/mymodule/sql/');</syntaxhighlight>

is not commented.

''Rules to follow:''

*Add the files about creating tables commands on the principle of an '''llx_mytable.sql''' file per table, with an optional '''llx_mytable.key.sql''' file (see existing files in '''install/mysql/tables''' for examples).
*The recommended type and name for SQL fields are defined into page [[Language_and_development_rules#Table_and_fields_structures]].
*To manage data, you must create a file called '''data.sql''' inside directory '''/mymodule/sql/''' that contains SQL command to add/edit/delete data.
*Don't use the double quote for strings (eg 'chaine' not "chaine") because the double quote have a specific meaning in PostGreSQL

Example of content of a file data.sql
<syntaxhighlight lang="sql">
delete from llx_const where name='MYMODULE_IT_WORKS' and entity='__ENTITY__';
insert into llx_const (name, value, type, note, visible, entity) values ('MYMODULE_IT_WORKS','1','chaine','A constant vor my module',1,'__ENTITY__');
</syntaxhighlight>

Files must be operational for the database mysql. Rem: The files of other databases are not maintained. They will be read and converted on the fly by the driver of the other database.

===Test your .sql files===

Once the files ready, you can return to the page to enable Dolibarr modules and disable the module, drop those tables in the database (if they already exists) and reactivate the module. The tables should be recreated by the activation of the module. If this is not the case, check your scripts by passing them by hand, or check the Dolibarr logs.

===Generate the PHP DAO class===
The DAO PHP files should have been generated by ModuleBuilder after creating an object.

You can however create them manually by copying existing object however using ModuleBuilder is highly recommended. You should find examples into '''htdocs/modulebuilder/templates/class/myobject.class.php'''

In this class, there are already operational CRUD (Create/Read/Update/Delete) methods to perform an insert, a fetch (select), an update, a delete of a table row. Edit the file to use the correct module name, tables and place this file in the class subdirectory of the module. The Module Builder allows you to do this with just a few mouse clicks.

==The tab management (optional)==

===Add or remove your own tabs on object sheets===
'''When''': To add a tab on an object (invoices, orders, proposals, member ...)

To do this go into the file descriptor of module previously created and edit the $this->tabs array:

<syntaxhighlight lang="PHP">
// Array to add new pages in new tabs or remove existing one
$this->tabs = array('objecttype:+tabname1:Title1:mylangfile@mymodule:$user->rights->mymodule->read:/mymodule/mypagetab1.php?id=__ID__' // To add a new tab identified by code tabname1
'objecttype:+tabname2:Title2:mylangfile@mymodule:$user->rights->mymodule->read:/mymodule/mypagetab2.php?id=__ID__', // To add a new tab identified by code tabname2
'objecttype:-tabname'); // To remove an existing tab identified by code tabname
</syntaxhighlight>

The table should contain a list of strings, each string representing a new tab.
The format of the string consisting of 5 parts separated by ":"

*Part 1: The element type (object type) where the tab should appear is a value from the following:
{{TemplateModuleTabs}}

*Part 2: A code to identify tab to add (start with +) or to remove (start with -)
*Part 3: The title of the tab. This can be a hard read or better code translation in a file lang.
*Part 4: The name of the file "*.lang" which contains correspondence between the code translation and language to display. If this name is followed with @mymodule, Dolibarr will search translation file "*.lang" within the module, so htdocs/mymodule/langs/code_CODE/mylangfile.lang, otherwise Dolibarr will look for file htdocs/langs/code_CODE/mylangfile.lang
*Part 5: A condition to test if tab must be visible. Put 1 to be always visible.
*Part 6: The URL of the page to display when you click on the tab. The __ID__ string will be replaced automatically by the Id of the element concerned.

To feed the contents of the tab with data from the database, see the next chapter.

In order to get the names 'tabname' of existing tabs, you have to check the names used in the function 'product_prepare_head' of the file 'core/lib/module.lib.php' corresponding to section '$head[$h][2]'.

===Show tabs navigation into your own pages===
'''When''': To show all standard tabs of an object (product, tiers, etc.) on your page.

You must follow these steps :

'''1. Include files you need into your file'''

For each object type, there are two files to include with line
<syntaxhighlight lang="PHP">require_once($url_fichier) ;</syntaxhighlight>

This is example of files to include (DOL_DOCUMENT_ROOT is often dolibarr/htdocs/) :

*Object thirdparty (thirdparty) :
**DOL_DOCUMENT_ROOT/societe/class/societe.class.php
**DOL_DOCUMENT_ROOT/core/lib/company.lib.php
*Object product (product) :
**DOL_DOCUMENT_ROOT/product/class/product.class.php
**DOL_DOCUMENT_ROOT/core/lib/product.lib.php
*Object invoice (invoice) :
**DOL_DOCUMENT_ROOT/compta/facture/class/facture.class.php
**DOL_DOCUMENT_ROOT/core/lib/invoice.lib.php

...

'''2. Create and load the object to show into your tab'''

Create an instance of an object of the correct class and load object from the database by using the fetch method of an object in providing to this method the id you get from URL (ie : /mytab.php?id=1).

''Example :''
<syntaxhighlight lang="PHP">
$id=GETPOST('id','int');
$ref=GETPOST('ref','alpha');
$product = new Product($db) ;
$result = $product->fetch($id,$ref) ; // Test $result to check the database read is ok
</syntaxhighlight>

'''3. Get a list of all tabs to show for your object type'''

Use function XXX_prepare_head($obj), where XXX is name of object. This will return an array with all definition of tab entries to show. The parameter to put into this method is the instance of an object you want tabs.

The resulting array has the following structure
<syntaxhighlight lang="PHP">
$head // Array of tabs
$head[$h] // Element to describe one tab.
$head[$h][0] // Url of page to show when you click on tab
$head[$h][1] // Title of tab
$head[$h][2] // Code name to identify the tab
</syntaxhighlight>

''Example :''
<syntaxhighlight lang="PHP">
$head = product_prepare_head($product, $user) ; // parameter $user is present for some function anly
</syntaxhighlight>

'''4. show tabs into your page'''

Use function dol_fiche_head() to show all tabs defined into array $head returned by XX_prepare_head().

<syntaxhighlight lang="PHP">
dol_fiche_head($links, $active='0', $title='', $notab=0, $picto='')
//$links // Tableau des onglets, appelé $head plus haut.
//$active // Onglet actif (mettre le nom de l'onglet défini dans votre fichier de module, ou un nom contenu dans $head[$h][2]). Cet onglet sera mis en surbrillance
//$title // Title to show (shown into a special tab that you can't click)
//$notab
//$picto // Name of image to show into title. Possible values are:
// product
// service
// company
</syntaxhighlight>

This function will show required tabs and open an html element ''< div class="" >'' that correspond to the area under the tabs. To close area of a tab, just use ''< /div >'' into your PHP page.

==Create or modify PHP screens (optional)==
'''When''': If the purpose of your module is to add features that require new or modified screens.

===Create a new PHP screen===
You must then create your PHP pages that will show/edit data from tables using the skeleton templates provided as an example in the directory '''modulebuilder/myobject_page.php''' (For the development of a script from the command line, see [[Script development]]).

To create a new user screen, create a subdirectory of '''htdocs''' (if not already done) for your module (in '''htdocs/mymodule''' for example) to store the pages you will create.

Copy, into that directory, the file '''myobject_page.phpp''' that will serve as a starting point for your page file.
Edit the file to have a correct relative path to the main.inc.php file.
<syntaxhighlight lang="PHP">
// Load Dolibarr environment
$res=0;
// Try main.inc.php into web root known defined into CONTEXT_DOCUMENT_ROOT (not always defined)
if (! $res && ! empty($_SERVER["CONTEXT_DOCUMENT_ROOT"])) $res=@include($_SERVER["CONTEXT_DOCUMENT_ROOT"]."/main.inc.php");
// Try main.inc.php into web root detected using web root calculated from SCRIPT_FILENAME
$tmp=empty($_SERVER['SCRIPT_FILENAME'])?'':$_SERVER['SCRIPT_FILENAME'];$tmp2=realpath(__FILE__); $i=strlen($tmp)-1; $j=strlen($tmp2)-1;
while($i > 0 && $j > 0 && isset($tmp[$i]) && isset($tmp2[$j]) && $tmp[$i]==$tmp2[$j]) { $i--; $j--; }
if (! $res && $i > 0 && file_exists(substr($tmp, 0, ($i+1))."/main.inc.php")) $res=@include(substr($tmp, 0, ($i+1))."/main.inc.php");
if (! $res && $i > 0 && file_exists(dirname(substr($tmp, 0, ($i+1)))."/main.inc.php")) $res=@include(dirname(substr($tmp, 0, ($i+1)))."/main.inc.php");
// Try main.inc.php using relative path
if (! $res && file_exists("../main.inc.php")) $res=@include("../main.inc.php");
if (! $res && file_exists("../../main.inc.php")) $res=@include("../../main.inc.php");
if (! $res && file_exists("../../../main.inc.php")) $res=@include("../../../main.inc.php");
if (! $res) die("Include of main fails");
</syntaxhighlight>
As you can see, there are several tries to load the main.inc.php (or master.inc.php). The goal is to succeed in the most cases as possible. The minimum is 2 lines: one to try to load the master/main.inc.php into the dolibarr root directory and another one to try to load the file to support the case when the module is deployed into the "custom" directory. But you can have more to deal more situation. The provided example should be able to load the file main/master.inc.php in nearly all situation/setups.

Note that you may add more "../" depending on the depth of the file relative to your module directory tree.

It's in the main.inc.php file that is loaded technical environment variables and permissions. The following variables are objects positioned in this file:

*$user Object that contains the characteristics of the user + his permissions.
*$conf Object that contains Dolibarr configuration.
*$db Object that contains an opened connection handler to the database.
*$langs Object that contains the user's language.

Then enter your code to display the page.

*To include a class or library dedicated to the module is done using a Dolibarr function (and not using directly include_once):

''Example :''
<syntaxhighlight lang="PHP">
dol_include_once('/mymodule/class/myclass.class.php', 'MyClass');
</syntaxhighlight>

*To include classes provided with Dolibarr, use the following syntax:

''Example :''
<syntaxhighlight lang="PHP">
require_once DOL_DOCUMENT_ROOT.'/core/class/doli.class.php';
</syntaxhighlight>

===Add some fields into existing forms===
You may want to provide a module that adds more fields into forms (input and view) of some elements.

A heavy solution (but not so bad) may be to replace all pages used to create element (this means to disable the "New element" menu entry and adding yours, and disable tab that shows element to replace with a tab that is your own full page (copied/pasted from original) to do same than original page but modified to add your fields and stored added data into your own table). Go to menu [[#Define your entries in the menu (optional)]] and [[#The tab management (optional)]] if this solution suits you (this solution is more powerful since you can change everything you want into the page).

We will describe here another solution, that works only to "add fields" at end of existing fields, using the element "category" as an example but you can convert this tutorial for invoice, proposal ...

*First thing is to add a table, owned by your module, to store the value of new fields. This table will have only one column called "rowid" (will contain the same value than field rowid of element table) + one column for each new field you want to add. Then create a class with CRUD (Create/Read/Update/Delete) methods for this new table. For this two tasks, go back to previous chapter [[#Create your SQL tables and the PHP DAO class]].
*Next step is to add a hook into your module to add the new fields into the form. See chapter [[Hooks_system#Implement_the_Hook]] for generic documentation to use hooks.

If you follow this tutorial, to be able to add fields into category forms, you must do:
{{ToComplete}}

===Add/replace part of fields supported by hooks===
See chapter [[Hooks_system#Implement_the_Hook]] to know how to use Dolibarr existing hooks to add/replace code at Dolibarr hooks place.

===Database access===
If you need to edit some data in the database inside your own table, use the PHP class generated before.

If you to make access to tables with no dedicated PHP class available, this is always possible (for example if you want to get a list of records with a particular join or filter). In this case, this is a code samples to follow:

To make an insert, update or delete:

<syntaxhighlight lang="PHP">
$db->begin(); // Start transaction
$db->query("My SQL request insert, update or delete");
$db->commit(); // Validate transaction
or $db->rollback() // Cancel transaction
</syntaxhighlight>

To read:

<syntaxhighlight lang="PHP">
$resql=$db->query("My select request");
if ($resql)
{
$num = $db->num_rows($resql);
$i = 0;
if ($num)
{
while ($i < $num)
{
$obj = $db->fetch_object($resql);
if ($obj)
{
// You can use here results
print $obj->field1;
print $obj->field2;
}
$i++;
}
}
}
</syntaxhighlight>

===Define style of your pages===
To have the look of your own pages to match the Dolibarr theme, it is necessary to use the Dolibarr CSS styles.

You can use for example:

*class="'''liste_titre'''" on tags ''tr'' and ''td'' for the head row of a table.
*class="'''pair'''" or class="'''impair'''" on tags ''tr'' and ''td'' of other rows of a table.
*class="'''flat'''" on all input fields (''input, select, textarea''...).
*class="'''button'''" on HTML fields with type ''input type="submit"''.

===Use the Dolibarr date picker===
If you want to use the Dolibarr date selector (with its calendar popup) into your pages, use the following line:
<syntaxhighlight lang="PHP">
$form=new Form($db);
$form->select_date('','mykey',0,0,0,"myform");
</syntaxhighlight>
The string mykey will identify the date selector in the form. You must use different values if you use several date selectors in same page.
The string myform is the name of the FORM in which the selector is included (value found in the form name="myform" in HTML page).
This means a date selector must be included necessarily into an html FORM.

To get value after the POST of your form, the command is:
<syntaxhighlight lang="PHP">
$mydate = dol_mktime(12, 0 , 0, $GETPOST('mykeymonth', 'int'), GETPOST('mykeyday', 'int'), GETPOST('mykeyyear', 'int'));
print strftime('%A %d %B %Y', $mydate);
</syntaxhighlight>

===Overwrite template file (tpl)===
If you want to overwrite tpl file on your module, you need to declare it on the module_parts :
<syntaxhighlight lang="PHP">
'tpl' => 1,
</syntaxhighlight>
Then you can put any tpl file on '''mymodule/core/tpl'''
as soon as the module is activate, the tpl will be overwrited

==Add your own setup page (optional)==
'''When''': If your module needs parameters, which are to be provided by the user, for proper setting up of the module.

===Create your page to edit parameters===
If your module needs several parameters to be setup, you must create a page to edit options (these options will be saved in the [[Table llx_const|table '''llx_const''']]).
Create a page named '''mymodule_setuppage.php''' that shows a form for possible options to update them into the above-mentioned table.
It is necessary to take an example from a page of the directory '''/admin''' that will show you the way to read/save your parameters.
Put this PHP page into the directory '''/admin''' of your module (e.g. mymodule/admin/mymodule_setuppage.php).

===Modify the descriptor file of your module===
Then, within the descriptor file of your module, modify the variable '''config_page_url''' to set the name of this PHP page.
If the page is in the directory '''admin/''', then the path is not required, e.g. like this:
<syntaxhighlight lang="PHP">
$this->config_page_url = array("mymodule_setuppage.php");
</syntaxhighlight>
If the page is in the directory '''mymodule/admin/''', then like this:
<syntaxhighlight lang="PHP">
$this->config_page_url = array("mymodule_setuppage.php@mymodule");
</syntaxhighlight>

===Test your page===
Go into page '''Home->Setup->Modules''', you should see a picture at the end of the line of your module to reach your setup page. Click on it, you should be able to view/edit parameters from your page.

==Define your entries in menu (optional)==
'''When''': If you have created PHP pages, it is necessary that those pages can be reached from menu entries in Dolibarr menu.

===Define your menu entries===
For this, you must define into the module descriptor, the array this->menu that declares all menus added by your module.
This array contains entries that will appear once your module is activated.
The example module descriptor file '''modMyModule.class.php''' contains an example to declare a top menu and also its left menu entries.

This is the example of code to declare your own menu entries in a module descriptor file:
<syntaxhighlight lang="PHP">
// Main menu entries
$this->menu = array(); // List of menus to add
$r=0;

// Add here entries to declare new menus
// Example to declare the Top Menu entry:
$this->menu[$r]=array( 'fk_menu'=>0, // Put 0 if this is a top menu
'type'=>'top', // This is a Top menu entry
'titre'=>'MyModule top menu',
'mainmenu'=>'mymodule',
'leftmenu'=>'mymodule',
'url'=>'/mymodule/pagetop.php',
'langs'=>'mylangfile', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
'position'=>100,
'enabled'=>'1', // Define condition to show or hide menu entry. Use '$conf->mymodule->enabled' if entry must be visible if module is enabled.
'perms'=>'1', // Use 'perms'=>'$user->rights->mymodule->level1->level2' if you want your menu with a permission rules
'target'=>'',
'user'=>2); // 0=Menu for internal users, 1=external users, 2=both
$r++;

// Example to declare a Left Menu entry:
$this->menu[$r]=array( 'fk_menu'=>'fk_mainmenu=xxx', // Use 'fk_mainmenu=xxx' or 'fk_mainmenu=xxx,fk_leftmenu=yyy' where xxx is mainmenucode and yyy is a leftmenucode of parent menu
'type'=>'left', // This is a Left menu entry
'titre'=>'MyModule left menu 1',
'mainmenu'=>'xxx',
'leftmenu'=>'yyy',
'url'=>'/mymodule/pagelevel1.php',
'langs'=>'mylangfile', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
'position'=>100,
'enabled'=>'1', // Define condition to show or hide menu entry. Use '$conf->mymodule->enabled' if entry must be visible if module is enabled.
'perms'=>'1', // Use 'perms'=>'$user->rights->mymodule->level1->level2' if you want your menu with a permission rules
'target'=>'',
'user'=>2); // 0=Menu for internal users,1=external users, 2=both
$r++;
</syntaxhighlight>

To show the menu or not depending on a permission, modify property '''perms''' in the array. See chapter on permissions later to see how to add permissions.

===Test your menu entries===
Disable and re-enable your module under the Dolibarr module setup page, menus entries must appear (if property 'enabled' is declaration array is ok).

==Add your own permissions (optional)==
'''When''': If you want to add new permissions.

The way to define permissions that will manage your module is done inside the module descriptor created previously.
Modify line
<syntaxhighlight lang="PHP">
$this->rights_class = 'mymodule'
</syntaxhighlight>
with correct value for mymodule.

Then you must fill the array $this->rights with as many entries than different permissions you need to manage.

<syntaxhighlight lang="PHP">
$this->rights[$r][0] = 10001;
$this->rights[$r][1] = 'Label by default of permission';
$this->rights[$r][2] = 'r';
$this->rights[$r][3] = 1;
$this->rights[$r][4] = 'action';
$this->rights[$r][5] = 'subaction';
$r++;
</syntaxhighlight>

Into $this->rights[$r][0], put a permission id not already used (See into menu '''System info''' on a working installation of Dolibarr to know list of id already used by standard modules.
Into $this->rights[$r][1], put a label by default for permission (This label will be used if no translation can be found into the file '''admin.lang''' Translation key should be "Permission10001=My permission Label").
Into $this->rights[$r][2], types of the permission. There are three type of permission, 'r' for read, list or expert permission, 'w' for write or update permission and 'd' for delete permission.
Into $this->rights[$r][3], put 1 if this permission must be granted automatically by default to any newly created user.
Into $this->rights[$r][4] and $this->rights[$r][5], put an action and subaction string without spaces. You will be able to test if a user has the permission in your PHP source code with the sequence:

<syntaxhighlight lang="PHP">
if ($user->rights->mymodule->action->subaction) ...
</syntaxhighlight>

==Define your own box (optional)==
'''When''': If your module needs to provide one or several new boxes to show on home page.

===Define your box===
For this, modify the array $this->boxes into the module descriptor file.
All you have to do is to add 2 lines for each box file you will create into directory '''htdocs/mymodule/core/boxes'''

''Example:''
<syntaxhighlight lang="PHP">
$this->boxes[0]['file']='mybox0.php@mymodule'
$this->boxes[0]['note']='My box 0'
...
$this->boxes[n]['file']='myboxn.php@mymodule'
$this->boxes[n]['note']='My box n'
</syntaxhighlight>

Then create files '''htdocs/mymodule/core/boxes/mybox0.php''', '''htdocs/mymodule/core/boxes/mybox1.php'''... by copying an example from an existing box file (found into directory '''htdocs/core/boxes''').

===Test if your box is detected by Dolibarr===
Disable and enabled module.

Go into menu '''Home - Setup - Boxes'''.

Your boxes must appear in the list of boxes you can activate. Activate the box and go on the home page to see if the box is showing correctly.

==Define your own export (optional)==
'''When''': If your module provides new predefined database export profiles (for its own tables or for already existing tables of another module).

===Define export===
For this uncomment and modify arrays $this->export_xxx in your module descriptor file.

===Test your export===
Go into menu Tools -> Export. Your export will appear in the list of available predefined exports (if your module is enabled).
Choose it, you must see a list of all possible fields defined in the export arrays.
Choose on field and try to build an export file. If ok, try again with all fields.

==Define your CSS styles (optional)==
'''When''': If in your PHP pages, you use class styles that are not defined inside Dolibarr themes CSS (not recommanded).

===Create and declare your style sheet===
Create a style sheet CSS named '''mymodule.css''' or '''mymodule.css.php''' and put it into directory '''htdocs/mymodule'''. You can have several CSS files per module.
Remember it's better to use existing styles already available by default into Dolibarr (The CSS file used by Dolibarr is file '''themes/mytheme/''themename''.css.php'''. Create your own CSS files only if you need absolutely to add not already existing styles.

Once your style sheets are ready, declare them into your module descriptor file by modifying the property '''$this->modules_parts'''.
Value to put here must be an array of relative URLs to your CSS files.
For example
<syntaxhighlight lang="PHP">
$this->module_parts = array('css' => array('/mymodule/css/mymodule.css.php','/mymodule/css/myother.css'));
</syntaxhighlight>

===Test your style sheet===
Disable and enable your module.

Go on the home page (index.php). Show the HTML source of the page.

You should see into the HTML header, a line that declares your style sheet.

==Add your Javascript functions (optional)==
'''When''': If in your PHP pages, you use javascript functions not available in Dolibarr (in file lib_head.js)

If you need to use your own javascript functions inside your PHP pages, it is necessary to have your functions, defined into your javascript file '''htdocs/mymodule/js/mymodule.js''', included into the HTML HEAD section.
To ask Dolibarr that forge this header to include your own javascript file, you must just provide it to the llxHeader() function called by your page.

Example for page /htdocs/mymodule/mypage.php :
<syntaxhighlight lang="PHP">
$morejs=array("/mymodule/js/mymodule.js");
llxHeader('','Titre','','','','',$morejs,'',0,0);
</syntaxhighlight>

==Run your own code on any Dolibarr event (optional)==
'''When''': If you want to execute your own code once a common Dolibarr event has occurred (example: I want to update a table in my module when an invoice is created into Dolibarr), you must create a '''triggers'''.

See also [[Interfaces_Dolibarr_toward_foreign_systems]]
and [[Interfaces_from_foreign_systems_toward_Dolibarr]]

==Insert your code inside Dolibarr hooks positions (optional)==
'''When''': When you want to add code or replace Dolibarr code into another situation than a business event (See the previous chapter for adding code during a business event).

See page [[Hooks_system]].

==Add your own numbering rules==
'''When''': When you need a new rule for generated ref of elements that are not covered by existing rules.

See page [[Create numbering module]].

==Add your document template (optional)==
'''When''': When you want to personalized your own generated PDF or ODT documents.

Note: To add this feature you don't need to create a module descriptor.

Documentation to add your own template is available on page [[Create_a_PDF_document_template]] or [[Create_an_ODT_document_template]].

==Add your skin (optional)==
'''When''': When you want to personalized your colors/fonts/images.

Note: To add this feature you don't need to create a module descriptor.

To add your own skin, read page [[Skins]].

=Some coding rules and predefined functions=
The coding rules to be followed are defined in the [[Developer documentation]], under section "General Information - Language and standards development".

A lot of predefined features for developers are also available and described into page [[Developer documentation]] under section "Technical components of Dolibarr".

=Create a package to distribute and install your module=
This process must be used to generate a package to submit it on the http://www.dolistore.com marketplace.
But you can use it to have a package easy to distribute on your own network.

*Go into the directory '''/build''' and copy the file '''makepack-dolibarrmodules.conf''' into '''makepack-mymodule.conf'''. Warning, this directory may not be provided in some packages of stable versions. If so, it can be retrieved from the snapshot available for download on the Dolibarr website in area "Development version" (taken in this case the whole build directory which is autonomous and independent directory).

Edit this file to add a list of file names for all new files you created for your module (module descriptor, new sql tables files, php page, images, etc...)

*Run the script via Perl (need the Perl version 5.0 or later):

<syntaxhighlight lang="bash">
perl makepack-dolibarrmodule.pl
</syntaxhighlight>
The script asks you the name of your module, its major and minor version. A file '''mymodule.zip ''' will then be manufactured containing your module ready to be deployed.

*The person who receives your module must then place the file in the root directory of a Dolibarr installation and perform the command:

<syntaxhighlight lang="bash">
tar -xvf mymodule.zip
</syntaxhighlight>

*If you want your module to be public, you can submit it (the zip file) on Dolibarr marketplace website: {{LinkToPluginDownload}} (you must create an account first and be logged to use the link "Submit a module/product").
**If your module was built correctly, the file will be validated later.
**If quality is enough and license permits it, the code might be added inside main Dolibarr sources (except if you disagree for that).

=Enabling/activation condition of external module on DoliStore=

See [[Module_Dolistore_Validation_Rules|Validation Rules]]
[[Category:Development]]

Développement module

2023-10-25T13:58:00Z

TanguyP: Orthographe et typographie

[[en:Module_development]]
[[es:Desarrollo_de_un_módulo]]
[[de:Modul_Entwicklung]]
[[zh:模块开发]]
[[ja:モジュール_開発]]


[[Category:Noyau]]
{{TemplateDocDev}}
Pour créer un nouveau module, il existe plusieurs étapes. Ce didacticiel a pour but de vous décrire chacune d'elles afin d'ajouter un module permettant d'étendre les possibilités de Dolibarr, comme par exemple ajouter une ou plusieurs des fonctionnalités suivantes:

*Ajouter de nouvelles tables en base.
*Ajouter vos propres entrées dans les menus.
*Ajouter des objets et des écrans de saisie/consultation de nouvelle tables.
*Ajouter ou supprimer des onglets sur les pages de vues/édition des objets (facture, produit, commande, événement, ...)
*Ajouter des exports prédéfinis pour la fonction export.
*Ajouter de nouvelles boites/widgets pour la home page.
*Ajouter des variables de substitution.
*Définir de nouvelles permissions.
*Déclencher du code automatiquement sur une action Dolibarr particulière.
*Insérer votre code aux emplacements hooks de Dolibarr
*Ajouter un modèle de numérotation de la référence des objets créés.
*Ajouter un modèle de document PDF.
*Ajouter un nouveau thème.

Les chapitres suivants vous présentent comment réaliser tout cela en manuel de manière simple.

=[[File:Art.png]] Création de Module avec le générateur de module=
Depuis Dolibarr 9.0 il est possible de créer les fichiers principaux de votre module avec le "Générateur de module" (aussi appelé "Module Builder"). Pour l'activer :

*Activez le module "Générateur de Module" (ou "Module builder") dans la section "Outils multi-modules" de Configuration > Modules/Applications

[[File:Mod_builder_2.png|400px]]

*Puis cliquez sur l’icône "bug" qui est apparue dans la barre de menu en haut à droite

[[File:Mod_builder_3.png|400px]]

=[[File:Art.png]] Exemple de modèle de module externe=
Un bon modèle/squelette de module externe Dolibarr est disponible ici : [https://github.com/Dolibarr/dolibarr/tree/develop/htdocs/modulebuilder/template GitHub Dolibarr Module Modèle]

=[[File:Art.png]] Créer un module=
Les sous chapitres suivant décrivent les actions à faire pour créer un module Dolibarr. Les premiers chapitres sont obligatoires quelle que soit la vocation du module, les suivants dépendront de ce que doit faire le module.

==Créer un descripteur de Module (obligatoire)==
'''Quand''' : Obligatoire dès qu'une extension est développée, quelle que soit sa vocation.
'''Depuis Dolibarr 9.0, il est possible de créer le descripteur de votre module avec le "Générateur de module"'''. Cet outil est encore encours de développement et de maturité mais peut d'ores et déjà être utilisé.

===Créer votre descripteur avec le générateur de module===

*Lancez le générateur de module en cliquant sur l’icône "bug"

[[File:Mod_builder_3.png|400px]]

*Entrez le nom de votre module sans espaces (le nom de votre module NE DOIT PAS CONTENIR le caractère underscore ou tiret bas : _) et cliquez sur Créer.

[[File:Mod_builder_4.png|400px]]

*Un module avec ses premiers fichiers a été initialisé. Vous pouvez alors modifier les paramètres du descripteur du module :

[[File:Mod_builder_5.png|400px]]

===Alternative : créer votre descripteur manuellement (sans utiliser le générateur de module)===
La première étape est donc de créer un fichier de description du module (descripteur). Pour cela:

*Créez le répertoire '''/htdocs/''monmodule''/core/modules'''. Puis, allez dans le répertoire '''dev/skeletons''' et recopiez le fichier modMyModule.class.php dans ce répertoire '''htdocs/''monmodule''/core/modules'''.
*Renommez le fichier mod'''MyModule'''.class.php en modifiant seulement la partie '''MyModule''' (le fichier doit commencer par mod)

Ensuite, modifiez le contenu de ce fichier afin de remplacer :

*les ''modMyModule'' en une valeur qui corresponde à la vocation de votre module. Cette valeur doit toujours commencer par '<nowiki/>'''mod'''' et ne contenir que des '''caractères alphabétiques'''.
*$this->numero = ''100000'' par un numéro de module libre. Pour éviter tout conflit, vous pouvez consulter la page suivante pour retrouver les numéros déjà alloués : [[List of modules id|Liste des id de modules]].
*Modifier éventuellement les autres variables définies dans le constructeurs (Voir le commentaire dans le code du squelette pour leur signification).

Le descripteur de votre module est alors en place.

===Tester votre descripteur===

Lancez Dolibarr et allez sur la page '''Configuration->module''', vous devez voir apparaître une nouvelle ligne avec votre nouveau module et la possibilité de l'activer ou non (parcourez tous les onglets de chaque catégories de modules jusqu'à le retrouver).
C'est la valeur de $this->special qui détermine dans quel onglet se trouve votre module.

===Nom de module===

Le nom de votre module NE DOIT PAS CONTENIR le caractère underscore ou tiret bas : _

==Arborescence d'un nouveau module==
Voici l'arborescence à respecter pour l'organisation des fichiers d'un module (cette arborescence sera celle prise d'office si vous générer les fichiers à l'aide de ModuleBuilder).

{{TemplateModuleTreeSimple}}

Un bon modèle/squelette de module externe Dolibarr est disponible ici : [https://github.com/Dolibarr/dolibarr/tree/develop/htdocs/modulebuilder/template GitHub Dolibarr Module Modèle]

==Créer vos tables SQL et les classes PHP DAO (optionnel)==
'''Quand''' : Si votre module a besoin de gérer des données qui lui sont propres

===Créer vos fichiers .sql===
Si votre module a vocation à gérer des données bien à lui, qui n'existent pas en base dans la version standard de Dolibarr, il est nécessaire de définir des tables SQL pour stocker ces données.

Créer un sous-répertoire '''sql''' dans le répertoire de votre module ('''monmodule/sql''') afin d'y placer les scripts sql que vous allez créer (Avec ModuleBuilder cette étape sera réalisée automatiquement suite à la création d'un nouvel Objet depuis l'onglet Objet).

Ensuite, vérifiez dans votre fichier descripteur de module, dans la fonction '''init''' que la ligne

<source lang="php">$this->_load_tables('/mymodule/sql/');</source>

n'est pas commentée.

''Règles à respecter:''

*Ajoutez les fichiers d'ordre de création de vos tables sur le principe de 1 fichier par table, nommé '''llx_matable.sql''' (pour la table), accompagné éventuellement du fichier '''llx_matable.key.sql''' (pour les index ou clé étrangères). Voir les exemples dans les fichiers existants dans '''install/mysql/tables''' pour exemple.
*Les types et noms recommandés pour les champs SQL sont définis sur la page [[https://wiki.dolibarr.org/index.php/Langages_et_normes#R.C3.A8gles_de_codage_SQL]].
*Pour ce qui est des commandes permettant d'ajouter/manipuler des données, elles doivent toutes se trouver dans un fichier nommé '''data.sql''' situé dans le même répertoire '''/monmodule/sql/'''.
*N'utilisez pas "chaine" mais 'chaine' car les guillemets doubles (") ont une signification particulière en PostGreSQL

Exemple de contenu de fichier data.sql
<source lang="sql">
delete from llx_const where name='MONMODULE_IT_WORKS' and entity='__ENTITY__';
insert into llx_const (name, value, type, note, visible, entity) values ('MONMODULE_IT_WORKS','1','chaine','A constant for my module',1,'__ENTITY__');
</source>

Les ordres SQL des fichiers doivent être opérationnels pour la base de données '''mysql'''.
Rem: Les fichiers des autres types de bases ne sont pas à maintenir. Ils sont lus et convertis à la volée par le driver de la base de données.

===Tester vos fichiers .sql===

Une fois les fichiers prêts, vous pouvez retourner dans l'écran de gestion des modules de Dolibarr puis désactiver le module, dropper les tables en base (si elles existent déjà) et réactiver le module.
Les tables doivent alors être recréées par l'activation du module.
Si tel n'est pas le cas, vérifiez vos scripts en les passant à la main, ou consultez les logs Dolibarr.

===Générer la classe PHP DAO d'accès aux tables===

Le fichier de classe DAO PHP d'un object est généré automatiquement avec ModuleBuilder lors de la création d'un Object.

À défaut d'utiliser le générateur de module, vous trouverez des exemples dans le squelette de module, fichier '''htdocs/modulebuilder/templates/class/myobject.class.php'''.

Dans cette classe, se trouvent des méthodes CRUD (Create/Read/Update/Delete) déjà opérationnelles pour faire un insert, un fetch (select), un update, un delete d'une ligne de la table. Éditer le fichier pour utiliser le bon nom de module, de tables et placer ce fichier dans le sous-répertoire de '''class''' du module. Le Module Builder permet de faire cela en quelques clics de souris.

==Affichage des onglets (optionnel)==

===Ajouter ou supprimer des onglets sur les fiches objets===
'''Quand''' : Pour ajouter votre propre onglet parmi les onglets d'un object standard (facture, commande, proposition commercial, adhérent...)

Pour cela, allez dans le fichier descripteur de module précédemment créé et modifiez le tableau $this->tabs:
<source lang="php">
// Array to add new pages in new tabs or remove existing one
$this->tabs = array('objecttype:+tabname1:Title1:mylangfile@monmodule:$user->rights->monmodule->read:/monmodule/mapagetab1.php?id=__ID__' // To add a new tab identified by code tabname1
'objecttype:+tabname2:Title2:mylangfile@monmodule:$user->rights->monmodule->read:/monmodule/mapagetab2.php?id=__ID__', // To add a new tab identified by code tabname2
'objecttype:-tabname'); // To remove an existing tab identified by code tabname
</source>

Le tableau doit contenir une liste de chaîne, chaque chaîne représentant un nouvel onglet.
Le format de la chaîne étant composé de 6 parties séparées par ":"

*Partie 1 : le type d'élément (objecttype) dans lequel doit apparaître l'onglet qui est une valeur parmi celle-ci:
{{TemplateModuleTabs-fr}}

*Partie 2 : nom de code pour l'onglet à ajouter (commence par +) ou à enlever (commence par -)
*Partie 3 : le titre de l'onglet. Cela peut être un libellé en dur ou mieux un code traduction présent dans un fichier lang.
*Partie 4 : le nom du fichier .lang (sans l'extension .lang) qui contient la correspondance entre le code traduction et le libellé à afficher. Si ce com est suivi de @monmodule, Dolibarr cherche le fichier dans le répertoire lang propre au module, c'est à dire htdocs/monmodule/langs/code_CODE/monmodule.lang, sinon Dolibarr cherche le fichier traduction dans htdocs/langs/code_CODE/mylangfile.lang
*Partie 5 : une condition à tester pour savoir si l'onglet doit être visible ou pas. Mettre '1' pour qu'il soit toujours visible.
*Partie 6 : l'url de la page à afficher quand on clique sur l'onglet. La chaine __ID__ sera remplacée automatiquement par l'Id de l'entité concernée.

Pour que la déclaration soit effective, il faut désactiver et réactiver le module.

Pour alimenter le contenu de l'onglet avec des données issues de la base, voir le chapitre suivant.

===Ajouter les onglets standard d'un objet sur sa propre page d'onglet===
'''Quand''' : Pour afficher les onglets existant d'un objet standard (produit, tiers, etc.) sur votre nouvelle page onglet.

Il faut appliquer la procédure suivante :

'''1. Inclure les fichiers définissant les fonctions utiles dans vos fichiers'''

Pour chaque fiche entité, il y a deux fichiers à inclure avec l'instruction
<source lang="php">require_once($url_fichier) ;</source>

Voici quelques exemples de fichiers à inclure (DOL_DOCUMENT_ROOT correspond au dossier dolibarr/htdocs/) :

*Entité tiers (thirdparty) :
**DOL_DOCUMENT_ROOT/societe/class/societe.class.php
**DOL_DOCUMENT_ROOT/core/lib/company.lib.php
*Entité produit (product) :
**DOL_DOCUMENT_ROOT/product/class/product.class.php
**DOL_DOCUMENT_ROOT/core/lib/product.lib.php
*Entité facture (invoice) :
**DOL_DOCUMENT_ROOT/compta/facture/facture.class.php
**DOL_DOCUMENT_ROOT/core/lib/invoice.lib.php

'''2. Créer et charger l'objet à afficher dans votre onglet'''

Créez l'objet de la classe voulue, et récupérez les données de l'objet à partir de la base de données. Pour cela il faut utiliser les fonctions fetch() de la classe correspondante, en passant en paramètre l'identifiant de l'objet que vous récupérez depuis l'url (ex : /mononglet.php?id=1).

''Exemple :''
<source lang="php">
$id=GETPOST('id','int');
$ref=GETPOST('ref','alpha');
$product = new Product($db) ;
$result = $product->fetch($id, $ref) ; //Tester $result pour vérifier que l'accès à la base s'est bien passée
</source>

'''3. Récupérer la liste des onglets correspondant à l'entité choisie'''

Utilisez la fonction XXX_prepare_head($obj), ou XXX est le nom de l'entité, permettant de créer un tableau contenant les définitions des onglets à afficher. Le paramètre à passer est l'objet pour lequel vous voulez afficher les onglets.

Le tableau retourné est composé de la façon suivante :
<source lang="php">
$head // Tableau des onglets
$head[$h] // Élément décrivant un onglet. Il y aura autant de $h que d'onglets à afficher
$head[$h][0] // Url de la page affichée quand on clique sur l'onglet
$head[$h][1] // Titre de l’onglet
$head[$h][2] // Code de l'onglet, à utiliser pour choisir quel onglet sera 'actif' (voir paragraphe suivant)
</source>

''Exemple :''
<source lang="php">
$head = product_prepare_head($product, $user) ; //le paramètre $user n'est pas présent sur certaines fonctions
</source>

'''4. Afficher les onglets sur votre page onglet'''

Utilisez la fonction dol_fiche_head() qui affiche les onglets contenus dans le tableau $head retourné par XX_prepare_head().

<source lang="php">
dol_fiche_head($links, $active='0', $title='', $notab=0, $picto='')
//$links // Tableau des onglets, appelé $head plus haut.
//$active // Onglet actif (mettre le nom de l'onglet défini dans votre fichier de module, ou un nom contenu dans $head[$h][2]). Cet onglet sera mis en surbrillance
//$title // ?
//$notab // Mettre ce paramètre à 1 permet de ne pas afficher de zone bleue en dessous des onglets.
//$picto // Nom de l'image à utiliser au début de la barre des onglet. Les choix suivant sont possibles :
// product
// service
// company
</source>

Cette fonction affiche les onglets voulus et ouvre un élément ''< div class="" >'' qui correspond à la zone bleue sous les onglets (si paramètre $notab = 0). Pour fermer la zone bleue, il suffit de fermer l'élément ''< /div >'' dans le code PHP.

''Remarque'' :
Pour plus de détail, se référer à la [http://www.dolibarr.fr/doxygen/ documentation Doxygen] ou directement au code de Dolibarr.

==Créer vos pages écran PHP (optionnel)==
'''Quand''' : Si l'objet de votre module est d'ajouter des fonctionnalités qui nécessitent de nouveaux écrans.

===Créer une page écran PHP brute===
Vous pouvez ensuite créer vos pages PHP, qui se basent sur les données de vos tables, en utilisant les squelettes fournis comme exemple dans le répertoire '''modulebuilder''' (Pour le développement d'un script en ligne de commande, voir [[Développement de scripts]]). La encore, si vous avez utilisez ModuleBuilder, des cas de pages (liste, page de création, onglet notes, etc...) auront été créés automatiquement lors de l'initialisation de l'objet.

Pour créer une nouvelle page écran utilisateur, créez un sous-répertoire de '''htdocs''' (si non déjà fait) propre à votre module (Dans '''htdocs/monmodule''' par exemple) afin d'y placer les pages que vous allez créer.

Y recopier le fichier '''myobject_page.php''' qui va servir de point de départ.
Modifiez le fichier afin que le main.inc.php soit trouvé
<source lang="php">
// Load Dolibarr environment
$res=0;
// Try main.inc.php into web root known defined into CONTEXT_DOCUMENT_ROOT (not always defined)
if (! $res && ! empty($_SERVER["CONTEXT_DOCUMENT_ROOT"])) $res=@include($_SERVER["CONTEXT_DOCUMENT_ROOT"]."/main.inc.php");
// Try main.inc.php into web root detected using web root calculated from SCRIPT_FILENAME
$tmp=empty($_SERVER['SCRIPT_FILENAME'])?'':$_SERVER['SCRIPT_FILENAME'];$tmp2=realpath(__FILE__); $i=strlen($tmp)-1; $j=strlen($tmp2)-1;
while($i > 0 && $j > 0 && isset($tmp[$i]) && isset($tmp2[$j]) && $tmp[$i]==$tmp2[$j]) { $i--; $j--; }
if (! $res && $i > 0 && file_exists(substr($tmp, 0, ($i+1))."/main.inc.php")) $res=@include(substr($tmp, 0, ($i+1))."/main.inc.php");
if (! $res && $i > 0 && file_exists(dirname(substr($tmp, 0, ($i+1)))."/main.inc.php")) $res=@include(dirname(substr($tmp, 0, ($i+1)))."/main.inc.php");
// Try main.inc.php using relative path
if (! $res && file_exists("../main.inc.php")) $res=@include("../main.inc.php");
if (! $res && file_exists("../../main.inc.php")) $res=@include("../../main.inc.php");
if (! $res && file_exists("../../../main.inc.php")) $res=@include("../../../main.inc.php");
if (! $res) die("Include of main fails");
</source>
Comme vous pouvez le constater, plusieurs tentatives de chargement du fichier main.inc.php (ou master.inc.php) ont été tentées. Le but est de réussir dans le plus grand nombre de cas possibles. Le minimum est de 2 lignes: une pour essayer de charger le fichier master / main.inc.php dans le répertoire racine de dolibarr et une autre pour essayer de charger le fichier afin de prendre en charge le cas où le module est déployé dans le répertoire "custom". Mais vous pouvez avoir à gérer plus de situations. L'exemple fourni devrait pouvoir charger le fichier main / master.inc.php dans presque toutes les situations / configurations.

Notez que vous pouvez ajouter plus "../" en fonction de la profondeur du fichier par rapport à l'arborescence de votre module.

C'est dans le main qu'est chargé l'environnement technique ainsi que les habilitations. Les variables objets suivantes sont alors positionnées:

*$user L'objet qui contient les caractéristiques de l'utilisateur + ses droits.
*$conf L'objet qui contient la configuration de Dolibarr.
*$db L'objet qui contient le handler de connexion à la base de données.
*$langs L'objet qui contient la langue de l'utilisateur.

*L'inclusion d'une classe ou librairie dédiée au module, sans savoir d'où le fichier sera appelé, se fait en utilisant une fonction de Dolibarr (et non en utilisant directement le include_once)

''Exemple :''
<source lang="php">
dol_include_once('/monmodule/class/maclasse.class.php', 'MaClasse');
</source>

*L'appel des classes fournies en standard avec Dolibarr se fera par contre par le require_once directe avec la syntaxe suivante:

''Exemple :''
<source lang="php">
require_once DOL_DOCUMENT_ROOT.'/core/class/doli.class.php';
</source>
La raison est que si le dol_include_once est pratique car il scanne chaque répertoire de chemin alternatif pour trouver le fichier, il est aussi moins performant car génère des accès et recherches disque à chaque appel (en effet, PHP intègre un cache des fichiers lus mais n'intègre pas un cache des fichiers "non trouvés". Et comme un fichier donné n'est que dans une seule arborescence, il y a toujours une arborescence alternative où il ne se trouve pas et qui génère des accès superflus au disque dur, pénalisant en terme de performance. Comme pour les fichiers internes à Dolibarr, on connait toujours le chemin exacte, le require_once avec ce chemin direct doit être préféré).

===Accès à la base===
Si vous avez besoin de réaliser des modifications en base dans votre propre table ajoutée, utilisez la classe générée plus haut qui contient les méthodes pour cela.

Si toutefois vous voulez faire des accès dans des tables sans objet PHP dédié, ceci reste possible (par exemple pour récupérer une liste d'enregistrement). Dans ce cas, pensez à suivre ces exemples:

Pour un insert, update ou delete :

<source lang="php">
$db->begin(); // Debut transaction
$db->query("Ma requete insert, update ou delete");
$db->commit(); // Valide
ou $db->rollback() // Annule
</source>

Pour une lecture :

<source lang="php">
$resql=$db->query("Ma requete select");
if ($resql)
{
$num = $db->num_rows($resql);
$i = 0;
if ($num)
{
while ($i < $num)
{
$obj = $db->fetch_object($resql);
if ($obj)
{
// You can use here results
print $obj->field1;
print $obj->field2;
}
$i++;
}
}
}
</source>

===Définition du style===
Pour que le look de la page soit aligné avec le thème Dolibarr, il est nécessaire d'utiliser les styles des CSS de Dolibarr.

Par exemple :

*class="'''liste_titre'''" sur les balises ''tr'' et ''td'' pour une ligne de titre de tableau.
*class="'''pair'''" ou class="'''impair'''" sur les balises ''tr'' et ''td'' des lignes de données de tableau.
*class="'''flat'''" sur tous les champs de saisie (''input, select, textarea''...).
*class="'''button'''" sur les objets de type ''input type="submit"''.

===Utilisez le sélecteur de date de Dolibarr===
Si vous le désirez, vous pouvez profiter du sélecteur de date dans des écrans Dolibarr. Pour cela, utilisez la ligne suivante:
<source lang="php">
$form=new Form($db);
$form->select_date('','mykey',0,0,0,"myform");
</source>
La chaîne mykey identifie la zone date. Il faut y mettre une valeur différente s'il y a plusieurs zones.
La chaine myform est le nom de la zone FORM (dans form name="myform" de la page HTML).
L'affichage d'un sélecteur de date doit donc être intégré dans une zone FORM Html.

Pour récupérer la valeur, à l'issu du POST, la commande est:
<source lang="php">
$mydate = dol_mktime(12, 0 , 0, GETPOST('mykeymonth', 'int'), GETPOST('mykeyday', 'int'), GETPOST('mykeyyear', 'int'));
print strftime('%A %d %B %Y', $mydate);
</source>

==Définir votre page de configuration (optionnel)==
'''Quand''' : si votre module offre plusieurs options paramétrables.

===Créez votre page d'édition de configuration===
Si votre module offre plusieurs options paramétrables, il est nécessaire de créer une page PHP pour éditer les options (qui sont stockées dans la [[Table llx_const|table '''llx_const''']]).
Créez une page PHP nommée '''monmodule_setupapage.php''' qui affiche les options possibles et les met à jour.
Il est nécessaire de prendre exemple sur une page dans '''/admin''' qui vous montre la méthode pour lire ou sauvegarder en base votre option.
Placez cette page de configuration dans le répertoire '''/admin''' également.
Ensuite dans le descripteur de module, modifiez la variable pour indiquer le nom de cette page PHP (sans le chemin qui n'est pas nécessaire, la page étant forcément dans le rep admin).
<source lang="php">
$this->config_page_url = array("setup.php@mymodule");
</source>

===Testez votre page===
Allez sur la page '''Configuration->module''', vous devez voir apparaître une icône qui permet d'accéder à la page de configuration et vous devez être capable de modifier ces options et les voir conservées en base.

==Définir vos entrées de menu (optionnel)==
'''Quand''' : si vous avez créé des pages PHP, il est nécessaire que ces écrans soient accessibles depuis le menu Dolibarr.

===Définissez vos entrées menus===
Pour cela, il vous faut définir dans le fichier descripteur de module, le tableau this->menu qui déclare les menus.
Ce tableau contient toutes les entrées qui apparaîtront dans les menus une fois le module activé.
Le fichier de descripteur de module exemple '''modMonModule.class.php''' possède un exemple de déclaration de menu haut ainsi que de ses entrées menu gauche associées.

Voici un exemple de déclaration d'entrées de menu dans le fichier descripteur:
<source lang="php">
// Main menu entries
$this->menu = array(); // List of menus to add
$r=0;

// Add here entries to declare new menus
// Example to declare the Top Menu entry:
$this->menu[$r]=array( 'fk_menu'=>0, // Put 0 if this is a top menu
'type'=>'top', // This is a Top menu entry
'titre'=>'MonModule top menu',
'mainmenu'=>'monmodule',
'leftmenu'=>'monmodule',
'url'=>'/monmodule/pagetop.php',
'langs'=>'mylangfile', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
'position'=>100,
'enabled'=>'1', // Define condition to show or hide menu entry. Use '$conf->monmodule->enabled' if entry must be visible if module is enabled.
'perms'=>'1', // Use 'perms'=>'$user->rights->monmodule->level1->level2' if you want your menu with a permission rules
'target'=>'',
'user'=>2); // 0=Menu for internal users, 1=external users, 2=both
$r++;

// Example to declare a Left Menu entry:
$this->menu[$r]=array( 'fk_menu'=>'fk_mainmenu=xxx', // Use 'fk_mainmenu=xxx' or 'fk_mainmenu=xxx,fk_leftmenu=yyy' where xxx is mainmenucode and yyy is a leftmenucode of parent menu
'type'=>'left', // This is a Left menu entry
'titre'=>'MonModule left menu 1',
'mainmenu'=>'xxx',
'leftmenu'=>'yyy',
'url'=>'/monmodule/pagelevel1.php',
'langs'=>'mylangfile', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
'position'=>100,
'enabled'=>'1', // Define condition to show or hide menu entry. Use '$conf->monmodule->enabled' if entry must be visible if module is enabled.
'perms'=>'1', // Use 'perms'=>'$user->rights->monmodule->level1->level2' if you want your menu with a permission rules
'target'=>'',
'user'=>2); // 0=Menu for internal users,1=external users, 2=both
$r++;
</source>

Pour conditionner l'accès au menu selon des permission, modifier la propriété '''perms''' du tableau. Voir le chapitre sur les permissions un peu plus loin pour savoir comment ajouter des permissions.

===Testez vos entrées menus===
Désactiver et réactiver votre module sous Dolibarr, les entrées menus doivent alors apparaître (si la condition dans 'enabled' est vraie).

==Définir vos propres permissions (optionnel)==
'''Quand''' : Si vous voulez ajouter de nouvelles permissions.

La définition des permissions que gérera votre module se fait dans le fichier descripteur créé dans la première étape.
Modifier la ligne
<source lang="php">
$this->rights_class = 'monmodule'
</source>
pour y mettre la bonne valeur de monmodule.

Ensuite remplissez le tableau $this->rights avec autant d'entrées que de permissions différentes à gérer.

<source lang="php">
$this->rights[$r][0] = 10001;
$this->rights[$r][1] = 'Libelle par défaut de ma permission';
$this->rights[$r][3] = 1;
$this->rights[$r][4] = 'action';
$this->rights[$r][5] = 'sousaction';
$r++;
</source>

Dans $this->rights[$r][0], mettre un id de permission non déjà pris (Voir dans le menu '''Infos Système''' sur une installation de Dolibarr opérationnelle pour connaître les id déjà utilisés.
Dans $this->rights[$r][3], mettre 1 si cette permission est attribué d'office par défaut quand un utilisateur est créé.
Dans $this->rights[$r][1], mettre un libellé par défaut (il sera affiché si aucune traduction n'est trouvé pour votre permission dans le fichier '''admin.lang'''. La clé de traduction dit être "Permission10001=Description de ma super permission'''"''').
Dans $this->rights[$r][4] et $this->rights[$r][5], mettre une chaîne action et sous action sans espace. Vous pourrez alors tester dans le code PHP si un utilisateurs a bien les droits par la séquence suivante :

<source lang="php">
if ($user->rights->monmodule->action->sousaction) ...
</source>

==Définir vos propres box (optionnel)==
'''Quand''' : si votre module amène avec lui une ou plusieurs Boxes.

===Définissez vos box===
Pour cela, modifiez les tableaux $this->boxes du fichier descripteur de module.
Il suffit d'ajouter 2 lignes par fichier box que vous allez créer dans le répertoire '''htdocs/monmodule/core/boxes'''

''Exemple :''
<source lang="php">
$this->boxes[0]['file']='mabox0.php@monmodule'
$this->boxes[0]['note']='Ma box 0'
...
$this->boxes[n]['file']='maboxn.php@monmodule'
$this->boxes[n]['note']='Ma box n'
</source>

Ensuite créez les fichiers '''htdocs/monmodule/core/boxes/mabox0.php''', '''htdocs/monmodule/core/boxes/mabox1.php'''... en prenant exemple sur des box existantes (exemple dans le répertoire '''htdocs/core/boxes''')

===Testez la présence de vos box dans Dolibarr===
Désactivez et réactivez le module.

Allez dans le menu '''Accueil - Configuration - Boite'''.

Vos box doivent apparaître dans la liste des box activables. Activez les puis allez sur la page d'accueil et vérifiez qu'elles s'affichent correctement.

==Définir vos propres exports (optionnel)==
'''Quand''' : si votre module amène avec lui des exports prédéfinis de données (pour ces propres tables ou des tables déjà existantes d'un autre module de Dolibarr).

===Définissez l'export===
Pour cela, décommentez et modifiez les tableaux $this->export_xxx du votre fichier descripteur de module.

===Testez votre export===
Allez dans le menu outils -> export de Dolibarr. Votre export doit apparaitre dans la liste des exports prédéfinis disponibles (si votre module est bien activé).
Le choisir, vous devez alors voir les champs possibles définis dans le tableau à l'étape précédente.
Choissez quelques champs et tentez une génération du fichier export.

==Définir vos styles CSS (optionnel)==
'''Quand''' : lorsque dans vos écrans PHP, vous utiliser des classes de styles qui ne sont pas celle des thèmes de Dolibarr (non recommandé).

Cette fonctionnalité est décrite mais pas encore opérationnel en 2.4

===Créez et déclarez votre feuille de style===
Créez un fichier de style css nommé '''monmodule.css''' ou '''monmodule.css.php''' et placez le dans le répertoire '''''monmodule''''' dans '''htdocs'''. Il ne peut y avoir qu'un fichier css propre à chaque module.
Rappelons qu'il vaut mieux utiliser les styles déjà existant de Dolibarr (le fichier css utilisé par Dolibarr étant le fichier '''themes/nomtheme/''nomtheme''.css.php'''). Ne créez un fichier css propre à votre module que si vous devez absolument gérer des styles non déjà existants.
Une fois votre feuille de style prête, déclarez la dans votre fichier descripteur de module en modifiant la propriété '''$this->module_parts'''.
La valeur à renseigner ici doit être le chemin relatif de l'URL de votre fichier css.
Par exemple
<source lang="php">
$this->module_parts = array('css' => array('/monmodule/css/monmodule.css.php'));
</source>

===Testez votre feuille de style===
Désactivez et réactivez votre module.

Appelez la page d'accueil de Dolibarr. Affichez la source de la page HTML.

Vous devriez voir dans l'entête HTML, une ligne déclarant votre feuille de style.

==Définir vos fonctions Javascript (optionnel)==
'''Quand''' : lorsque dans vos écrans PHP, vous utiliser des fonctions javascript non dispo en standard (fichier lib_head.js)

Si dans vos écrans PHP, vous utilisez des fonctions javascript, il est nécessaire de faire en sorte que vos fonctions déclarées dans un fichier javascript '''htdocs/monmodule/js/monmodule.js''' soit chargées dans l'entête head html.
Pour demander à Dolibarr qui gère la génération de la section header d'inclure un de vos fichiers javascript, il est nécessaire de fournir en paramètre de la fonction llxHeader() appelée au début de votre page, d'inclure le paramètre qui contient l'URL vers le js à inclure.

Exemple pour la page /htdocs/monmodule/mapage.php :
<source lang="php">
require('../main.inc.php');
$morejs=array("/monmodule/js/monmodule.js");
llxHeader('','Titre','','','','',$morejs,'',0,0);
</source>

==Déclencher du code sur un évènement Dolibarr (optionnel)==
'''Quand''' : lorsque vous voulez que des actions particulières s'exécutent suite au déclenchement d'actions standards de Dolibarr (exemple : je veux mettre à jour une table de mon module quand une facture se crée dans Dolibarr), il vous faut créer un fichier de '''triggers'''.

Voir aussi [[Interfaces_Dolibarr_vers_exterieur|Interfaces de Dolibarr vers l'exterieur]]
et [[Interfaces_Exterieur_vers_Dolibarr|Interfaces exterieures vers Dolibarr]]

==Insérer votre code aux emplacement hooks de Dolibarr (optionnel)==
'''Quand''' : lorsque vous voulez modifier ou ajouter du code autrement que lors d'un événement métier (voir le chapitre précédent pour cela).

Voir la page [[Système de Hooks]].

==Ajouter un module de numérotation (optionnel)==
'''Quand''' : lorsque vous voulez ajouter une règle de numérotation non couverte par les modules par défaut.

Voir la page [[Créer un module de numérotation]].

==Ajouter un nouveau modèle de document (optionnel)==
'''Quand''' : lorsque vous voulez ajouter un nouveau modèle de document.

La documentation au sujet de la génération de documents depuis des modèles est disponible sur la page [[Créer un modèle de document PDF]] ou [[Créer un modèle de document ODT]].

==Ajouter un thème (optionnel)==
'''Quand''': Lorsque vous voulez une interface aux couleurs personnalisées à votre cas.

Voir la page [[Themes]].

=[[File:Art.png]] Quelques règles de codage et fonctions pour développeurs=
Les règles de codage à suivre sont définis dans la [[Documentation Développeur|Documentation développeur]], rubrique "Informations Générales - Langage et normes de développement".

De nombreuses fonctions prédéfinies pour les développeurs sont disponibles et décrites sur la page [[Documentation Développeur|Documentation développeur]] sous la section "Les couches techniques de Dolibarr".

=[[File:Art.png]] Créer un package pour livrer et installer votre module=
Cette procédure doit être utilisée pour fabriquer un package afin de le soumettre sur la place de marché http://www.dolistore.com.
Mais vous pouvez aussi l'utiliser pour distribuer facillement votre module via votre propre réseau de distribution.

*Allez dans le répertoire '''/build''' et recopiez le fichier '''makepack-dolibarrmodules.conf''' en '''makepack-monmodule.conf'''. Attention, ce répertoire peut ne pas être fourni dans les packages de versions stables. Si c'est le cas, il peut être récupéré dans le snapshot disponible en téléchargement sur le site web Dolibarr dans la rubrique Version de développement (prenez dans ce cas tout le répertoire build qui est un répertoire autonome et indépendant de la version).

Saisissez dans ce fichier la liste des noms des nouveaux fichiers que vous avez créé pour votre module (descripteur de module, nouveaux fichiers sql de tables, page php, images, etc...)

*Lancer le script via Perl (besoin de la version Perl 5.0 ou +):

<source lang="bash">
perl makepack-dolibarrmodule.pl
</source>
Le script vous demande le nom de votre module, sa version majeure et mineure.
Un fichier '''monmodule.zip''' va alors être fabriqué contenant votre module prêt pour être déployé.

*La personne qui reçoit votre module doit alors placer le fichier dans son répertoire racine d'installation de Dolibarr et réaliser la commande :

<source lang="bash">
tar -xvf monmodule.zip
</source>

*Si vous désirez que votre module profite à tous, vous pouvez le soumettre (le fichier zip) sur la place de marché des modules complémentaires: {{LinkToPluginDownload}} (vous devez avoir créé un compte auparavant et utiliser le lien "Soumettre un module/produit").
**Si votre module a été fabriqué correctement, le fichier sera validé rapidement.
**Si la qualité est suffisante, que la licence le permet et que la fonctionnalité du module s'avère être d'un intérêt général, le code pourra être ajouté au code source de Dolibarr (sauf si vous ne le désirez pas).

=[[File:Art.png]] Dépôt et validation du module externe sur Dolistore=

Voir [[Module_Dolistore_Validation_Regles|Règles de Validation]]

Développement module

2023-10-25T13:48:32Z

TanguyP: /* Création de Module avec le générateur de module */ Décrire plus précisément l'activation du générateur de modules. MàJ basée sur Dolibarr 18.0.2

[[en:Module_development]]
[[es:Desarrollo_de_un_módulo]]
[[de:Modul_Entwicklung]]
[[zh:模块开发]]
[[ja:モジュール_開発]]


[[Category:Noyau]]
{{TemplateDocDev}}
Pour créer un nouveau module, il existe plusieurs étapes. Ce didacticiel a pour but de vous décrire chacune d'elles afin d'ajouter un module permettant d'étendre les possibilités de Dolibarr, comme par exemple ajouter une ou plusieurs des fonctionnalités suivantes:

*Ajouter de nouvelles tables en base.
*Ajouter vos propres entrées dans les menus.
*Ajouter des objets et des écrans de saisie/consultation de nouvelle tables.
*Ajouter ou supprimer des onglets sur les pages de vues/édition des objets (facture, produit, commande, événement, ...)
*Ajouter des exports prédéfinis pour la fonction export.
*Ajouter de nouvelles boites/widgets pour la home page.
*Ajouter des variables de substitution.
*Définir de nouvelles permissions.
*Déclencher du code automatiquement sur une action Dolibarr particulière.
*Insérer votre code aux emplacements hooks de Dolibarr
*Ajouter un modèle de numérotation de la référence des objets créés.
*Ajouter un modèle de document PDF.
*Ajouter un nouveau thème.

Les chapitres suivants vous présentent comment réaliser tout cela en manuel de manière simple.

=[[File:Art.png]] Création de Module avec le générateur de module=
Depuis Dolibarr 9.0 il est possible de créer les fichiers principaux de votre module avec le "Générateur de module" (aussi appelé "Module Builder"). Pour l'activer :

*Activez le module "Générateur de Module" (ou "Module builder") dans la section "Outils multi-modules" de Configuration > Modules/Applications

[[File:Mod_builder_2.png|400px]]

*Puis cliquez sur l’icône "bug" qui est apparue dans la barre de menu en haut à droite

[[File:Mod_builder_3.png|400px]]

=[[File:Art.png]] Exemple de modèle de module externe=
Un bon modèle/squelette de module externe Dolibarr est disponible ici : [https://github.com/Dolibarr/dolibarr/tree/develop/htdocs/modulebuilder/template GitHub Dolibarr Module Modèle]

=[[File:Art.png]] Créer un module=
Les sous chapitres suivant décrivent les actions à faire pour créer un module Dolibarr. Les premiers chapitres sont obligatoires quelle que soit la vocation du module, les suivants dépendront de ce que doit faire le module.

==Créer un descripteur de Module (obligatoire)==
'''Quand''' : Obligatoire dès qu'une extension est développée, quelle que soit sa vocation.
'''Depuis Dolibarr 9.0, il est possible de créer le descripteur de votre module avec le "Générateur de module"'''. Cet outil est encore encours de développement et de maturité mais peut dors et déjà être utilisé.

===Créer votre descripteur avec le générateur de module===

*Lancez le générateur de module en cliquant sur l’icône "bug"

[[File:Mod_builder_3.png|400px]]

*Entrez le nom de votre module sans espaces (le nom de votre module NE DOIT PAS CONTENIR le caractère underscore ou tiret bas : _) et cliquez sur Créer.

[[File:Mod_builder_4.png|400px]]

*Un module avec ses premiers fichiers a été initialisé. Vous pouvez alors modifier les paramètres du descripteur du module :

[[File:Mod_builder_5.png|400px]]

===Alternative : créer votre descripteur manuellement (sans utiliser le générateur de module)===
La première étape est donc de créer un fichier de description du module (descripteur). Pour cela:

*Créez le répertoire '''/htdocs/''monmodule''/core/modules'''. Puis, allez dans le répertoire '''dev/skeletons''' et recopiez le fichier modMyModule.class.php dans ce répertoire '''htdocs/''monmodule''/core/modules'''.
*Renommez le fichier mod'''MyModule'''.class.php en modifiant seulement la partie '''MyModule''' (le fichier doit commencer par mod)

Ensuite, modifiez le contenu de ce fichier afin de remplacer :

*les ''modMyModule'' en une valeur qui corresponde à la vocation de votre module. Cette valeur doit toujours commencer par '<nowiki/>'''mod'''' et ne contenir que des '''caractères alphabétiques'''.
*$this->numero = ''100000'' par un numéro de module libre. Pour éviter tout conflit, vous pouvez consulter la page suivante pour retrouver les numéros déjà alloués : [[List of modules id|Liste des id de modules]].
*Modifier éventuellement les autres variables définies dans le constructeurs (Voir le commentaire dans le code du squelette pour leur signification).

Le descripteur de votre module est alors en place.

===Tester votre descripteur===

Lancez Dolibarr et allez sur la page '''Configuration->module''', vous devez voir apparaître une nouvelle ligne avec votre nouveau module et la possibilité de l'activer ou non (parcourez tous les onglets de chaque catégories de modules jusqu'à le retrouver).
C'est la valeur de $this->special qui détermine dans quel onglet se trouve votre module.

===Nom de module===

Le nom de votre module NE DOIT PAS CONTENIR le caractère underscore ou tiret bas : _

==Arborescence d'un nouveau module==
Voici l'arborescence à respecter pour l'organisation des fichiers d'un module (cette arborescence sera celle prise d'office si vous générer les fichiers à l'aide de ModuleBuilder).

{{TemplateModuleTreeSimple}}

Un bon modèle/squelette de module externe Dolibarr est disponible ici : [https://github.com/Dolibarr/dolibarr/tree/develop/htdocs/modulebuilder/template GitHub Dolibarr Module Modèle]

==Créer vos tables SQL et les classes PHP DAO (optionnel)==
'''Quand''': Si votre module a besoin de gérer des données qui lui sont propres

===Créer vos fichiers .sql===
Si votre module a vocation à gérer des données bien à lui, qui n'existent pas en base dans la version standard de Dolibarr, il est nécessaire de définir des tables SQL pour stocker ces données.

Créer un sous-répertoire '''sql''' dans le répertoire de votre module ('''monmodule/sql''') afin d'y placer les scripts sql que vous allez créer (Avec ModuleBuilder cette étape sera réalisée automatiquement suite à la création d'un nouvel Objet depuis l'onglet Objet).

Ensuite, vérifiez dans votre fichier descripteur de module, dans la fonction '''init''' que la ligne

<source lang="php">$this->_load_tables('/mymodule/sql/');</source>

n'est pas commentée.

''Règles à respecter:''

*Ajoutez les fichiers d'ordre de création de vos tables sur le principe de 1 fichier par table, nommé '''llx_matable.sql''' (pour la table), accompagné éventuellement du fichier '''llx_matable.key.sql''' (pour les index ou clé étrangères). Voir les exemples dans les fichiers existants dans '''install/mysql/tables''' pour exemple.
*Les types et noms recommandés pour les champs SQL sont définis sur la page [[https://wiki.dolibarr.org/index.php/Langages_et_normes#R.C3.A8gles_de_codage_SQL]].
*Pour ce qui est des commandes permettant d'ajouter/manipuler des données, elles doivent toutes se trouver dans un fichier nommé '''data.sql''' situé dans le même répertoire '''/monmodule/sql/'''.
*N'utilisez pas "chaine" mais 'chaine' car les guillemets doubles (") ont une signification particulière en PostGreSQL

Exemple de contenu de fichier data.sql
<source lang="sql">
delete from llx_const where name='MONMODULE_IT_WORKS' and entity='__ENTITY__';
insert into llx_const (name, value, type, note, visible, entity) values ('MONMODULE_IT_WORKS','1','chaine','A constant for my module',1,'__ENTITY__');
</source>

Les ordres SQL des fichiers doivent être opérationnels pour la base de données '''mysql'''.
Rem: Les fichiers des autres types de bases ne sont pas à maintenir. Ils sont lus et convertis à la volée par le driver de la base de données.

===Tester vos fichiers .sql===

Une fois les fichiers prêts, vous pouvez retourner dans l'écran de gestion des modules de Dolibarr puis désactiver le module, dropper les tables en base (si elles existe déjà) et réactiver le module.
Les tables doivent alors être recréées par l'activation du module.
Si tel n'est pas le cas, vérifiez vos scripts en les passant à la main, ou consultez les logs Dolibarr.

===Générer la classe PHP DAO d'accès aux tables===

Le fichier de classe DAO PHP d'un object est généré automatiquement avec ModuleBuilder lors de la création d'un Object.

A défaut d'utiliser le générateur de module, vous trouverez des exemples dans le squelette de module, fichier '''htdocs/modulebuilder/templates/class/myobject.class.php'''.

Dans cette classe, se trouve des méthodes CRUD (Create/Read/Update/Delete) déjà opérationnelles pour faire un insert, un fetch (select), un update, un delete d'une ligne de la table. Editer le fichier pour utiliser le bon nom de module, de tables et placer ce fichier dans le sous-répertoire de '''class''' du module. Le Module Builder permet de faire cela en quelques clics de souris.

==Affichage des onglets (optionnel)==

===Ajouter ou supprimer des onglets sur les fiches objets===
'''Quand''' : Pour ajouter votre propre onglet parmi les onglets d'un object standard (facture, commande, proposition commercial, adhérent...)

Pour cela, allez dans le fichier descripteur de module précédemment créé et modifiez le tableau $this->tabs:
<source lang="php">
// Array to add new pages in new tabs or remove existing one
$this->tabs = array('objecttype:+tabname1:Title1:mylangfile@monmodule:$user->rights->monmodule->read:/monmodule/mapagetab1.php?id=__ID__' // To add a new tab identified by code tabname1
'objecttype:+tabname2:Title2:mylangfile@monmodule:$user->rights->monmodule->read:/monmodule/mapagetab2.php?id=__ID__', // To add a new tab identified by code tabname2
'objecttype:-tabname'); // To remove an existing tab identified by code tabname
</source>

Le tableau doit contenir une liste de chaîne, chaque chaîne représentant un nouvel onglet.
Le format de la chaîne étant composé de 6 parties séparées par ":"

*Partie 1 : le type d'élément (objecttype) dans lequel doit apparaître l'onglet qui est une valeur parmi celle-ci:
{{TemplateModuleTabs-fr}}

*Partie 2 : nom de code pour l'onglet à ajouter (commence par +) ou à enlever (commence par -)
*Partie 3 : le titre de l'onglet. Cela peut être un libellé en dur ou mieux un code traduction présent dans un fichier lang.
*Partie 4 : le nom du fichier .lang (sans l'extension .lang) qui contient la correspondance entre le code traduction et le libellé à afficher. Si ce com est suivi de @monmodule, Dolibarr cherche le fichier dans le répertoire lang propre au module, c'est à dire htdocs/monmodule/langs/code_CODE/monmodule.lang, sinon Dolibarr cherche le fichier traduction dans htdocs/langs/code_CODE/mylangfile.lang
*Partie 5 : une condition à tester pour savoir si l'onglet doit être visible ou pas. Mettre '1' pour qu'il soit toujours visible.
*Partie 6 : l'url de la page à afficher quand on clique sur l'onglet. La chaine __ID__ sera remplacée automatiquement par l'Id de l'entité concernée.

Pour que la déclaration soit effective, il faut désactiver et réactiver le module.

Pour alimenter le contenu de l'onglet avec des données issues de la base, voir le chapitre suivant.

===Ajouter les onglets standard d'un objet sur sa propre page d'onglet===
'''Quand''' : Pour afficher les onglets existant d'un objet standard (produit, tiers, etc.) sur votre nouvelle page onglet.

Il faut appliquer la procédure suivante :

'''1. Inclure les fichiers définissant les fonctions utiles dans vos fichiers'''

Pour chaque fiche entité, il y a deux fichiers à inclure avec l'instruction
<source lang="php">require_once($url_fichier) ;</source>

Voici quelques exemples de fichiers à inclure (DOL_DOCUMENT_ROOT correspond au dossier dolibarr/htdocs/) :

*Entité tiers (thirdparty) :
**DOL_DOCUMENT_ROOT/societe/class/societe.class.php
**DOL_DOCUMENT_ROOT/core/lib/company.lib.php
*Entité produit (product) :
**DOL_DOCUMENT_ROOT/product/class/product.class.php
**DOL_DOCUMENT_ROOT/core/lib/product.lib.php
*Entité facture (invoice) :
**DOL_DOCUMENT_ROOT/compta/facture/facture.class.php
**DOL_DOCUMENT_ROOT/core/lib/invoice.lib.php

'''2. Créer et charger l'objet à afficher dans votre onglet'''

Créez l'objet de la classe voulue, et récupérez les données de l'objet à partir de la base de données. Pour cela il faut utiliser les fonctions fetch() de la classe correspondante, en passant en paramètre l'identifiant de l'objet que vous récupérez depuis l'url (ex : /mononglet.php?id=1).

''Exemple :''
<source lang="php">
$id=GETPOST('id','int');
$ref=GETPOST('ref','alpha');
$product = new Product($db) ;
$result = $product->fetch($id, $ref) ; //Tester $result pour vérifier que l'accès à la base s'est bien passée
</source>

'''3. Récupérer la liste des onglets correspondants à l'entité choisie'''

Utilisez la fonction XXX_prepare_head($obj), ou XXX est le nom de l'entité, permettant de créer un tableau contenant les définitions des onglets à afficher. Le paramètre à passer est l'objet pour lequel vous voulez afficher les onglets.

Le tableau retourné est composé de la façon suivante :
<source lang="php">
$head // Tableau des onglets
$head[$h] // Élément décrivant un onglet. Il y aura autant de $h que d'onglets à afficher
$head[$h][0] // Url de la page affichée quand on clique sur l'onglet
$head[$h][1] // Titre de l’onglet
$head[$h][2] // Code de l'onglet, à utiliser pour choisir quel onglet sera 'actif' (voir paragraphe suivant)
</source>

''Exemple :''
<source lang="php">
$head = product_prepare_head($product, $user) ; //le paramètre $user n'est pas présent sur certaines fonctions
</source>

'''4. Afficher les onglets sur votre page onglet'''

Utilisez la fonction dol_fiche_head() qui affiche les onglets contenus dans le tableau $head retourné par XX_prepare_head().

<source lang="php">
dol_fiche_head($links, $active='0', $title='', $notab=0, $picto='')
//$links // Tableau des onglets, appelé $head plus haut.
//$active // Onglet actif (mettre le nom de l'onglet défini dans votre fichier de module, ou un nom contenu dans $head[$h][2]). Cet onglet sera mis en surbrillance
//$title // ?
//$notab // Mettre ce paramètre à 1 permet de ne pas afficher de zone bleue en dessous des onglets.
//$picto // Nom de l'image à utiliser au début de la barre des onglet. Les choix suivant sont possibles :
// product
// service
// company
</source>

Cette fonction affiche les onglets voulus et ouvre un élément ''< div class="" >'' qui correspond à la zone bleue sous les onglets (si paramètre $notab = 0). Pour fermer la zone bleue, il suffit de fermer l'élément ''< /div >'' dans le code PHP.

''Remarque'' :
Pour plus de détail, se référer à la [http://www.dolibarr.fr/doxygen/ documentation Doxygen] ou directement au code de Dolibarr.

==Créer vos pages écran PHP (optionnel)==
'''Quand''' : Si l'objet de votre module est d'ajouter des fonctionnalités qui nécessitent de nouveaux écrans.

===Créer une page écran PHP brute===
Vous pouvez ensuite créer vos pages PHP, qui se basent sur les données de vos tables, en utilisant les squelettes fournis comme exemple dans le répertoire '''modulebuilder''' (Pour le développement d'un script en ligne de commande, voir [[Développement de scripts]]). La encore, si vous avez utilisez ModuleBuilder, des cas de pages (liste, page de création, onglet notes, etc...) auront été créés automatiquement lors de l'initialisation de l'objet.

Pour créer une nouvelle page écran utilisateur, créez un sous-répertoire de '''htdocs''' (si non déjà fait) propre à votre module (Dans '''htdocs/monmodule''' par exemple) afin d'y placer les pages que vous allez créer.

Y recopier le fichier '''myobject_page.php''' qui va servir de point de départ.
Modifiez le fichier afin que le main.inc.php soit trouvé
<source lang="php">
// Load Dolibarr environment
$res=0;
// Try main.inc.php into web root known defined into CONTEXT_DOCUMENT_ROOT (not always defined)
if (! $res && ! empty($_SERVER["CONTEXT_DOCUMENT_ROOT"])) $res=@include($_SERVER["CONTEXT_DOCUMENT_ROOT"]."/main.inc.php");
// Try main.inc.php into web root detected using web root calculated from SCRIPT_FILENAME
$tmp=empty($_SERVER['SCRIPT_FILENAME'])?'':$_SERVER['SCRIPT_FILENAME'];$tmp2=realpath(__FILE__); $i=strlen($tmp)-1; $j=strlen($tmp2)-1;
while($i > 0 && $j > 0 && isset($tmp[$i]) && isset($tmp2[$j]) && $tmp[$i]==$tmp2[$j]) { $i--; $j--; }
if (! $res && $i > 0 && file_exists(substr($tmp, 0, ($i+1))."/main.inc.php")) $res=@include(substr($tmp, 0, ($i+1))."/main.inc.php");
if (! $res && $i > 0 && file_exists(dirname(substr($tmp, 0, ($i+1)))."/main.inc.php")) $res=@include(dirname(substr($tmp, 0, ($i+1)))."/main.inc.php");
// Try main.inc.php using relative path
if (! $res && file_exists("../main.inc.php")) $res=@include("../main.inc.php");
if (! $res && file_exists("../../main.inc.php")) $res=@include("../../main.inc.php");
if (! $res && file_exists("../../../main.inc.php")) $res=@include("../../../main.inc.php");
if (! $res) die("Include of main fails");
</source>
Comme vous pouvez le constater, plusieurs tentatives de chargement du fichier main.inc.php (ou master.inc.php) ont été tentées. Le but est de réussir dans le plus grand nombre de cas possibles. Le minimum est de 2 lignes: une pour essayer de charger le fichier master / main.inc.php dans le répertoire racine de dolibarr et une autre pour essayer de charger le fichier afin de prendre en charge le cas où le module est déployé dans le répertoire "custom". Mais vous pouvez avoir à gérer plus de situations. L'exemple fourni devrait pouvoir charger le fichier main / master.inc.php dans presque toutes les situations / configurations.

Notez que vous pouvez ajouter plus "../" en fonction de la profondeur du fichier par rapport à l'arborescence de votre module.

C'est dans le main qu'est chargé l'environnement technique ainsi que les habilitations. Les variables objets suivantes sont alors positionnées:

*$user L'objet qui contient les caractéristiques de l'utilisateur + ses droits.
*$conf L'objet qui contient la configuration de Dolibarr.
*$db L'objet qui contient le handler de connexion à la base de données.
*$langs L'objet qui contient la langue de l'utilisateur.

*L'inclusion d'une classe ou librairie dédiée au module, sans savoir d'où le fichier sera appelé, se fait en utilisant une fonction de Dolibarr (et non en utilisant directement le include_once)

''Exemple :''
<source lang="php">
dol_include_once('/monmodule/class/maclasse.class.php', 'MaClasse');
</source>

*L'appel des classes fournies en standard avec Dolibarr se fera par contre par le require_once directe avec la syntaxe suivante:

''Exemple :''
<source lang="php">
require_once DOL_DOCUMENT_ROOT.'/core/class/doli.class.php';
</source>
La raison est que si le dol_include_once est pratique car il scanne chaque répertoire de chemin alternatif pour trouver le fichier, il est aussi moins performant car génère des accès et recherches disque à chaque appel (en effet, PHP intègre un cache des fichiers lus mais n'intègre pas un cache des fichiers "non trouvés". Et comme un fichier donné n'est que dans une seule arborescence, il y a toujours une arborescence alternative où il ne se trouve pas et qui génère des accès superflus au disque dur, pénalisant en terme de performance. Comme pour les fichiers internes à Dolibarr, on connait toujours le chemin exacte, le require_once avec ce chemin direct doit être préféré).

===Accès à la base===
Si vous avez besoin de réaliser des modifications en base dans votre propre table ajoutée, utilisez la classe générée plus haut qui contient les méthodes pour cela.

Si toutefois vous voulez faire des accès dans des tables sans objet PHP dédié, ceci reste possible (par exemple pour récupérer une liste d'enregistrement). Dans ce cas, pensez à suivre ces exemples:

Pour un insert, update ou delete :

<source lang="php">
$db->begin(); // Debut transaction
$db->query("Ma requete insert, update ou delete");
$db->commit(); // Valide
ou $db->rollback() // Annule
</source>

Pour une lecture :

<source lang="php">
$resql=$db->query("Ma requete select");
if ($resql)
{
$num = $db->num_rows($resql);
$i = 0;
if ($num)
{
while ($i < $num)
{
$obj = $db->fetch_object($resql);
if ($obj)
{
// You can use here results
print $obj->field1;
print $obj->field2;
}
$i++;
}
}
}
</source>

===Définition du style===
Pour que le look de la page soit aligné avec le thème Dolibarr, il est nécessaire d'utiliser les styles des CSS de Dolibarr.

Par exemple :

*class="'''liste_titre'''" sur les balises ''tr'' et ''td'' pour une ligne de titre de tableau.
*class="'''pair'''" ou class="'''impair'''" sur les balises ''tr'' et ''td'' des lignes de données de tableau.
*class="'''flat'''" sur tous les champs de saisie (''input, select, textarea''...).
*class="'''button'''" sur les objets de type ''input type="submit"''.

===Utilisez le sélecteur de date de Dolibarr===
Si vous le désirez, vous pouvez profiter du sélecteur de date dans des écrans Dolibarr. Pour cela, utilisez la ligne suivante:
<source lang="php">
$form=new Form($db);
$form->select_date('','mykey',0,0,0,"myform");
</source>
La chaîne mykey identifie la zone date. Il faut y mettre une valeur différente s'il y a plusieurs zones.
La chaine myform est le nom de la zone FORM (dans form name="myform" de la page HTML).
L'affichage d'un sélecteur de date doit donc être intégré dans une zone FORM Html.

Pour récupérer la valeur, à l'issu du POST, la commande est:
<source lang="php">
$mydate = dol_mktime(12, 0 , 0, GETPOST('mykeymonth', 'int'), GETPOST('mykeyday', 'int'), GETPOST('mykeyyear', 'int'));
print strftime('%A %d %B %Y', $mydate);
</source>

==Définir votre page de configuration (optionnel)==
'''Quand''' : si votre module offre plusieurs options paramétrables.

===Créez votre page d'édition de configuration===
Si votre module offre plusieurs options paramétrables, il est nécessaire de créer une page PHP pour éditer les options (qui sont stockées dans la [[Table llx_const|table '''llx_const''']]).
Créez une page PHP nommée '''monmodule_setupapage.php''' qui affiche les options possibles et les met à jour.
Il est nécessaire de prendre exemple sur une page dans '''/admin''' qui vous montre la méthode pour lire ou sauvegarder en base votre option.
Placez cette page de configuration dans le répertoire '''/admin''' également.
Ensuite dans le descripteur de module, modifiez la variable pour indiquer le nom de cette page PHP (sans le chemin qui n'est pas nécessaire, la page étant forcément dans le rep admin).
<source lang="php">
$this->config_page_url = array("setup.php@mymodule");
</source>

===Testez votre page===
Allez sur la page '''Configuration->module''', vous devez voir apparaître une icône qui permet d'accéder à la page de configuration et vous devez être capable de modifier ces options et les voir conservées en base.

==Définir vos entrées de menu (optionnel)==
'''Quand''' : si vous avez créé des pages PHP, il est nécessaire que ces écrans soient accessibles depuis le menu Dolibarr.

===Définissez vos entrées menus===
Pour cela, il vous faut définir dans le fichier descripteur de module, le tableau this->menu qui déclare les menus.
Ce tableau contient toutes les entrées qui apparaîtront dans les menus une fois le module activé.
Le fichier de descripteur de module exemple '''modMonModule.class.php''' possède un exemple de déclaration de menu haut ainsi que de ses entrées menu gauche associées.

Voici un exemple de déclaration d'entrées de menu dans le fichier descripteur:
<source lang="php">
// Main menu entries
$this->menu = array(); // List of menus to add
$r=0;

// Add here entries to declare new menus
// Example to declare the Top Menu entry:
$this->menu[$r]=array( 'fk_menu'=>0, // Put 0 if this is a top menu
'type'=>'top', // This is a Top menu entry
'titre'=>'MonModule top menu',
'mainmenu'=>'monmodule',
'leftmenu'=>'monmodule',
'url'=>'/monmodule/pagetop.php',
'langs'=>'mylangfile', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
'position'=>100,
'enabled'=>'1', // Define condition to show or hide menu entry. Use '$conf->monmodule->enabled' if entry must be visible if module is enabled.
'perms'=>'1', // Use 'perms'=>'$user->rights->monmodule->level1->level2' if you want your menu with a permission rules
'target'=>'',
'user'=>2); // 0=Menu for internal users, 1=external users, 2=both
$r++;

// Example to declare a Left Menu entry:
$this->menu[$r]=array( 'fk_menu'=>'fk_mainmenu=xxx', // Use 'fk_mainmenu=xxx' or 'fk_mainmenu=xxx,fk_leftmenu=yyy' where xxx is mainmenucode and yyy is a leftmenucode of parent menu
'type'=>'left', // This is a Left menu entry
'titre'=>'MonModule left menu 1',
'mainmenu'=>'xxx',
'leftmenu'=>'yyy',
'url'=>'/monmodule/pagelevel1.php',
'langs'=>'mylangfile', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
'position'=>100,
'enabled'=>'1', // Define condition to show or hide menu entry. Use '$conf->monmodule->enabled' if entry must be visible if module is enabled.
'perms'=>'1', // Use 'perms'=>'$user->rights->monmodule->level1->level2' if you want your menu with a permission rules
'target'=>'',
'user'=>2); // 0=Menu for internal users,1=external users, 2=both
$r++;
</source>

Pour conditionner l'accès au menu selon des permission, modifier la propriété '''perms''' du tableau. Voir le chapitre sur les permissions un peu plus loin pour savoir comment ajouter des permissions.

===Testez vos entrées menus===
Désactiver et réactiver votre module sous Dolibarr, les entrées menus doivent alors apparaître (si la condition dans 'enabled' est vraie).

==Définir vos propres permissions (optionnel)==
'''Quand''' : Si vous voulez ajouter de nouvelles permissions.

La définition des permissions que gérera votre module se fait dans le fichier descripteur créé dans la première étape.
Modifier la ligne
<source lang="php">
$this->rights_class = 'monmodule'
</source>
pour y mettre la bonne valeur de monmodule.

Ensuite remplissez le tableau $this->rights avec autant d'entrées que de permissions différentes à gérer.

<source lang="php">
$this->rights[$r][0] = 10001;
$this->rights[$r][1] = 'Libelle par défaut de ma permission';
$this->rights[$r][3] = 1;
$this->rights[$r][4] = 'action';
$this->rights[$r][5] = 'sousaction';
$r++;
</source>

Dans $this->rights[$r][0], mettre un id de permission non déjà pris (Voir dans le menu '''Infos Système''' sur une installation de Dolibarr opérationnelle pour connaître les id déjà utilisés.
Dans $this->rights[$r][3], mettre 1 si cette permission est attribué d'office par défaut quand un utilisateur est créé.
Dans $this->rights[$r][1], mettre un libellé par défaut (il sera affiché si aucune traduction n'est trouvé pour votre permission dans le fichier '''admin.lang'''. La clé de traduction dit être "Permission10001=Description de ma super permission'''"''').
Dans $this->rights[$r][4] et $this->rights[$r][5], mettre une chaîne action et sous action sans espace. Vous pourrez alors tester dans le code PHP si un utilisateurs a bien les droits par la séquence suivante :

<source lang="php">
if ($user->rights->monmodule->action->sousaction) ...
</source>

==Définir vos propres box (optionnel)==
'''Quand''' : si votre module amène avec lui une ou plusieurs Boxes.

===Définissez vos box===
Pour cela, modifiez les tableaux $this->boxes du fichier descripteur de module.
Il suffit d'ajouter 2 lignes par fichier box que vous allez créer dans le répertoire '''htdocs/monmodule/core/boxes'''

''Exemple :''
<source lang="php">
$this->boxes[0]['file']='mabox0.php@monmodule'
$this->boxes[0]['note']='Ma box 0'
...
$this->boxes[n]['file']='maboxn.php@monmodule'
$this->boxes[n]['note']='Ma box n'
</source>

Ensuite créez les fichiers '''htdocs/monmodule/core/boxes/mabox0.php''', '''htdocs/monmodule/core/boxes/mabox1.php'''... en prenant exemple sur des box existantes (exemple dans le répertoire '''htdocs/core/boxes''')

===Testez la présence de vos box dans Dolibarr===
Désactivez et réactivez le module.

Allez dans le menu '''Accueil - Configuration - Boite'''.

Vos box doivent apparaître dans la liste des box activables. Activez les puis allez sur la page d'accueil et vérifiez qu'elles s'affichent correctement.

==Définir vos propres exports (optionnel)==
'''Quand''' : si votre module amène avec lui des exports prédéfinis de données (pour ces propres tables ou des tables déjà existantes d'un autre module de Dolibarr).

===Définissez l'export===
Pour cela, décommentez et modifiez les tableaux $this->export_xxx du votre fichier descripteur de module.

===Testez votre export===
Allez dans le menu outils -> export de Dolibarr. Votre export doit apparaitre dans la liste des exports prédéfinis disponibles (si votre module est bien activé).
Le choisir, vous devez alors voir les champs possibles définis dans le tableau à l'étape précédente.
Choissez quelques champs et tentez une génération du fichier export.

==Définir vos styles CSS (optionnel)==
'''Quand''' : lorsque dans vos écrans PHP, vous utiliser des classes de styles qui ne sont pas celle des thèmes de Dolibarr (non recommandé).

Cette fonctionnalité est décrite mais pas encore opérationnel en 2.4

===Créez et déclarez votre feuille de style===
Créez un fichier de style css nommé '''monmodule.css''' ou '''monmodule.css.php''' et placez le dans le répertoire '''''monmodule''''' dans '''htdocs'''. Il ne peut y avoir qu'un fichier css propre à chaque module.
Rappelons qu'il vaut mieux utiliser les styles déjà existant de Dolibarr (le fichier css utilisé par Dolibarr étant le fichier '''themes/nomtheme/''nomtheme''.css.php'''). Ne créez un fichier css propre à votre module que si vous devez absolument gérer des styles non déjà existants.
Une fois votre feuille de style prête, déclarez la dans votre fichier descripteur de module en modifiant la propriété '''$this->module_parts'''.
La valeur à renseigner ici doit être le chemin relatif de l'URL de votre fichier css.
Par exemple
<source lang="php">
$this->module_parts = array('css' => array('/monmodule/css/monmodule.css.php'));
</source>

===Testez votre feuille de style===
Désactivez et réactivez votre module.

Appelez la page d'accueil de Dolibarr. Affichez la source de la page HTML.

Vous devriez voir dans l'entête HTML, une ligne déclarant votre feuille de style.

==Définir vos fonctions Javascript (optionnel)==
'''Quand''' : lorsque dans vos écrans PHP, vous utiliser des fonctions javascript non dispo en standard (fichier lib_head.js)

Si dans vos écrans PHP, vous utilisez des fonctions javascript, il est nécessaire de faire en sorte que vos fonctions déclarées dans un fichier javascript '''htdocs/monmodule/js/monmodule.js''' soit chargées dans l'entête head html.
Pour demander à Dolibarr qui gère la génération de la section header d'inclure un de vos fichiers javascript, il est nécessaire de fournir en paramètre de la fonction llxHeader() appelée au début de votre page, d'inclure le paramètre qui contient l'URL vers le js à inclure.

Exemple pour la page /htdocs/monmodule/mapage.php :
<source lang="php">
require('../main.inc.php');
$morejs=array("/monmodule/js/monmodule.js");
llxHeader('','Titre','','','','',$morejs,'',0,0);
</source>

==Déclencher du code sur un évènement Dolibarr (optionnel)==
'''Quand''' : lorsque vous voulez que des actions particulières s'exécutent suite au déclenchement d'actions standards de Dolibarr (exemple : je veux mettre à jour une table de mon module quand une facture se crée dans Dolibarr), il vous faut créer un fichier de '''triggers'''.

Voir aussi [[Interfaces_Dolibarr_vers_exterieur|Interfaces de Dolibarr vers l'exterieur]]
et [[Interfaces_Exterieur_vers_Dolibarr|Interfaces exterieures vers Dolibarr]]

==Insérer votre code aux emplacement hooks de Dolibarr (optionnel)==
'''Quand''' : lorsque vous voulez modifier ou ajouter du code autrement que lors d'un événement métier (voir le chapitre précédent pour cela).

Voir la page [[Système de Hooks]].

==Ajouter un module de numérotation (optionnel)==
'''Quand''' : lorsque vous voulez ajouter une règle de numérotation non couverte par les modules par défaut.

Voir la page [[Créer un module de numérotation]].

==Ajouter un nouveau modèle de document (optionnel)==
'''Quand''' : lorsque vous voulez ajouter un nouveau modèle de document.

La documentation au sujet de la génération de documents depuis des modèles est disponible sur la page [[Créer un modèle de document PDF]] ou [[Créer un modèle de document ODT]].

==Ajouter un thème (optionnel)==
'''Quand''': Lorsque vous voulez une interface aux couleurs personnalisées à votre cas.

Voir la page [[Themes]].

=[[File:Art.png]] Quelques règles de codage et fonctions pour développeurs=
Les règles de codage à suivre sont définis dans la [[Documentation Développeur|Documentation développeur]], rubrique "Informations Générales - Langage et normes de développement".

De nombreuses fonctions prédéfinies pour les développeurs sont disponibles et décrites sur la page [[Documentation Développeur|Documentation développeur]] sous la section "Les couches techniques de Dolibarr".

=[[File:Art.png]] Créer un package pour livrer et installer votre module=
Cette procédure doit être utilisée pour fabriquer un package afin de le soumettre sur la place de marché http://www.dolistore.com.
Mais vous pouvez aussi l'utiliser pour distribuer facillement votre module via votre propre réseau de distribution.

*Allez dans le répertoire '''/build''' et recopiez le fichier '''makepack-dolibarrmodules.conf''' en '''makepack-monmodule.conf'''. Attention, ce répertoire peut ne pas être fourni dans les packages de versions stables. Si c'est le cas, il peut être récupéré dans le snapshot disponible en téléchargement sur le site web Dolibarr dans la rubrique Version de développement (prenez dans ce cas tout le répertoire build qui est un répertoire autonome et indépendant de la version).

Saisissez dans ce fichier la liste des noms des nouveaux fichiers que vous avez créé pour votre module (descripteur de module, nouveaux fichiers sql de tables, page php, images, etc...)

*Lancer le script via Perl (besoin de la version Perl 5.0 ou +):

<source lang="bash">
perl makepack-dolibarrmodule.pl
</source>
Le script vous demande le nom de votre module, sa version majeure et mineure.
Un fichier '''monmodule.zip''' va alors être fabriqué contenant votre module prêt pour être déployé.

*La personne qui reçoit votre module doit alors placer le fichier dans son répertoire racine d'installation de Dolibarr et réaliser la commande :

<source lang="bash">
tar -xvf monmodule.zip
</source>

*Si vous désirez que votre module profite à tous, vous pouvez le soumettre (le fichier zip) sur la place de marché des modules complémentaires: {{LinkToPluginDownload}} (vous devez avoir créé un compte auparavant et utiliser le lien "Soumettre un module/produit").
**Si votre module a été fabriqué correctement, le fichier sera validé rapidement.
**Si la qualité est suffisante, que la licence le permet et que la fonctionnalité du module s'avère être d'un intérêt général, le code pourra être ajouté au code source de Dolibarr (sauf si vous ne le désirez pas).

=[[File:Art.png]] Dépôt et validation du module externe sur Dolistore=

Voir [[Module_Dolistore_Validation_Regles|Règles de Validation]]

List of modules id

2023-10-25T13:44:50Z

TanguyP: Add range of 50 module IDs reserved for myself

{{TemplateDocDevEn}}
{{TemplateDocDevEs}}
{{TemplateDocDevFr}}

{{Flag en}}
This page list all reserved modules numbers / ID. If you build or want to build your own modules (like this [[:Category:Complementary_modules|complementary module]]), you should take an ID range here. Please pick range into existing holes first.

{{Flag fr}}
Cette page recense tous les numéros / ID réservés de modules. Si vous avez réalisé ou voulez réaliser vos propres modules (comme les [[:Category:Modules complémentaires|modules complémentaires suivant]]), vous devriez prendre une plage d'ID ici. Merci de prendre dans les trous existant en priorité !

{{Flag sp}}
Esta página contiene un listado de todos los id reservados para los módulos. Si ha creado o quiere realizar sus propios módulos, (como estos [[:Category:Módulos_complementarios|módulos complementarios]]), deberá reservarse un rango de ID aquí.

=ID 0 - 99999=
{{Flag en}}
Reserved for Dolibarr's internal modules.

{{Flag fr}}
Réservé aux modules internes de Dolibarr.

{{Flag sp}}
Reservado a los módulos internos de Dolibarr.

=ID 100000 - 499999=
{{Flag en}}
'''Reserved area for editors in need for an ID range. You can edit this page to add your own range (take a range of 50 numbers only the first time, ask us for more)'''

{{Flag fr}}Zone réservée aux éditeurs qui ont besoin d'une plage d'ID spécifiques. Vous pouvez modifier cette page pour réserver votre plage (limitée à 50 valeurs la première fois, demandez nous pour plus)

{{Flag sp}}
Área reservada para los partners que necesiten un rango de ID. Puede modificar esta página para reservar su rango (limitado a 50 valores por editor)

[[File:Warning.png]] If you reserve more than 50, we may automatically change your reservation range without information and you may experience conflicts with other modules in a future, so please follow the rules!

*ID 100000 - 100999: OpenThink (http://www.openthink.be)
*ID 101000 - 101999: NLTechno (https://www.nltechno.com)
*ID 102000 - 102999: Tiaris (http://www.tiaris.fr)
*ID 103000 - 103999: Open-concept.pro (http://www.open-concept.pro)
*ID 104000 - 104999: ATM Consulting (http://www.atm-consulting.fr)
*ID 105000 - 105999: GPC.solutions
*ID 106000 - 106999: PHPASSO
*ID 107000 - 107999: TecLib (http://www.teclib.com) / Auguria (http://www.auguria.net)
*ID 108000 - 108999: ETHICWEB
*ID 109000 - 109999: Aplose ([http://www.aplose.fr https://www.aplose.fr])
*ID 110000 - 110999: Librethic (https://librethic.io)
*ID 111000 - 111999: Asset IT (www.assetit.ch)
*ID 112000 - 112999: Aarboard AG (www.aarboard.ch)
*ID 113000 - 113999: Asilib - Alexandre Spangaro
*ID 114000 - 114999: Iceleaf OÜ
*ID 115000 - 115999: 2A2C Conseil - Cyril ZEKSER
*ID 116000 - 116999: Wolftec GmbH
*ID 117000 - 117999: Oscim (http://www.oscim.fr)
*ID 118000 - 118999: Oarces Web (dev.oarces.com)
*ID 119000 - 119999: Manuel Berrocal - Absolacom
*ID 120000 - 120999: Régis Houssin (http://www.inodbox.com)
*ID 121000 - 121999: Oscss - Shop
*ID 122000 - 122999: MrSof - la Nation du Web
*ID 123000 - 123999: Bruno Généré (webiseasy.org)
*ID 124000 - 124999: backbone internet service (www.backbone.co.at)
*ID 125000 - 125999: ProgSI (www.progsi.ma)
*ID 126000 - 126999: Catalanet
*ID 127000 - 127999: Virgilio Filho pt-BR Brasil (@dolibarr.br)
*ID 128000 - 128999: Nicolas Frappé France (www.sospc.info)
*ID 129000 - 129999: Adeo-Informatique
*ID 130000 - 130999: Technicks ICT (http://www.technicks.eu)
*ID 131000 - 131999: Joan Louis (itaca.fr)
*ID 132000 - 132999: Jean-Marie Arsac (https://azimut.fr)
*ID 133000 - 133999: Oriel Systems Ltd, UK. (www.orielsystems.com)
*ID 134000 - 134999: ALSOFT PVT. LTD. (https://www.alsoft.org)
*ID 135000 - 135999: Net-Logic (https://netlogic.fr)
*ID 136000 - 136050: MONA.RE - France
*ID 136051 - 136099: La Vida Marketing
*ID 136100 - 136149: Synergies-Tech France. (https://www.synergies-france.fr/)
*ID 136150 - 136199: Lyta
*ID 136200 - 136219: Maison Théophile Leclerc
*ID 136220 - 139999: '''Free (take ranges of 50 only please at once, ask us for more)'''
*ID 140000 - 140999: Altairis (http://altairis.fr)
*ID 141000 - 141050: Projet2Team (https://www.projet2team.fr)
*ID 141051 - 141099: Elistair (http://elistair.com)
*ID 141100 - 141149: Blue Networks Technologies (https://www.blnt.fr)
*ID 141150 - 141199: Mainlab S.r.l. (https://www.mainlabonline.it)
*ID 141150 - 141199: Florian DUFOURG - France
*ID 142000 - 142049: ITANéA (https://www.itanea.fr)
*ID 142050 - 142099: ERP Consulting NZ ([https://www.erpconsulting.co.nz www.erpconsulting.co.nz])
*ID 142100 - 142149: Bloxera GmbH (https://www.bloxera.com)
*ID 142150 - 142199: Evangelos Souglakos - Greece
*ID 142200 - 142249: Luc CALARESU - France
*ID 142250 - 142299: OmnIT Services - Belgique (https://www.omnitservices.biz)
*ID 142300 - 142349: Gwadeyes - Guadeloupe (https://www.gwadeyes-informatique.com/)
*ID 142350 - 142399: Solution Libre (https://www.solution-libre.fr/)
*ID 142400 - 142449: Res Digital (https://res.digital)
*ID 149000 - 149999: SydTech - America Central (https://www.sydtech.io/)
*ID 150000 - 150999: Jeffinfo
*ID 151000 - 151999: Konverseo (https://konverseo.com)
*ID 152000 - 152049: Tanguy Pénet (http://tanguype.net)
*ID 160000 - 160999: Charles-François BENKE (http://www.patas-monkey.com)
*ID 161000 - 161999: Abbes Bahfir (http://dolipar.org)
*ID 162000 - 162999: Jacques Rébiscoul
*ID 163000 - 163999: Open-DSI (https://www.open-dsi.fr)
*ID 164000 - 164999: Pixelada S. Coop. And. (https://pixelada.org)
*ID 165000 - 165049: DovConnect
*ID 165050 - 165099: Mind Operated Systems (https://www.mosystems.biz)
*ID 165100 - 165150: SD-Formation (https://sdformation.fr)
*ID 165151 - 165199: NUM'X (https://www.numx-sets.eu)
*ID 165200 - 165249: Benjam Préjent (https://www.benjam-prejent.fr)
*ID 165250 - 165299: Dhi Loka Private Limited, India (https://www.dhiloka.com)
*ID 170000 - 170999: TRIDENT CONSULTING LTD (www.tridentdxb.com)
*ID 171000 - 171999: LVSInformatique (www.lvsinformatique.com)
*ID 172000 - 172299: Ray Soft-Systems (https://www.ray-soft-systems.com)
*ID 172300 - 172349: Günter Lukas Consulting (https://gl.co.at)
*ID 172350 - 172399: MB Informatique (https://www.mb-informatique.fr)
*ID 172400 - 172449: Professional Structures Limited (https://pstructures.com)
*ID 172450 - 172699: IT-BS (https://www.it-bs.fr)
*ID 172700 - 172749: Indelog (https://www.indelog.fr)
*ID 172750 - 172799: NS-INFO90 (https://www.ns-info90.fr)
*ID 180000 - 180999: Triangle Ingénierie
*ID 181000 - 181999: TI Sin Problemas (https://www.tisinproblemas.com)
*ID 182000 - 182049: Chipserv Pawel Wlizlo (https://www.testware.it)
*ID 183000 - 183999: BB2A Anthony Berton (https://www.bb2a.fr)
*ID 184000 - 184999: DPS PRINTING & DOCUMENTS SOCIEDAD ANONIMA (https://www.dps-lat.com)
*ID 190000 - 190999: Diciannove (http://19.coop)
*ID 191000 - 191999: Elonet (https://elonet.fr)
*ID 199000 - 199999: RFMS
*ID 200000 - 200999: Noxiome
*ID 201000 - 201999: Sasa Ostrouska (saxa)
*ID 202000 - 202999: Z-Application
*ID 203000 - 203099: Elidee - elidee.com
*ID 203100 - 203999: Garcia MICHEL (soamichel.fr)
*ID 204000 - 204999: Ari Elbaz elarifr - accedinfo.com
*ID 205000 - 205999: Kreiz IT
*ID 206000 - 206999: GBINFO (www.gbinfo.fr)
*ID 207000 - 207099: MacroProg (https://www.macroprog.com)
*ID 207100 - 207149: Reactiva Software
*ID 207150 - 207199: Ndejje University Water Research and Development Centre ([https://github.com/NDUWRDC/LIMS/])
*ID 207200 - 207299: Massaoud Bouzenad ([https://www.dzprod.net dzprod.net])
*ID 207300 - 207349: Ksar
*ID 207350 - 207399: Easylinux (www.easylinux.fr)
*ID 222000 - 222999: dolibit (https://www.dolibit.de)
*ID 230000 - 230049: Unareil (https://www.unareil.eu)
*ID 230050 - 230099: Lyra Network (https://www.lyra.com/)
*ID 230100 - 230149: Gheorghe Iftimi - CTW - RO
*ID 230150 - 230199: MEMA Machinery & Tools (https://www.mema.be)
*ID 230200 - 230249: Teleassist
*ID 230250 - 230299: Nh Developer
*ID 230300 - 230499: Chickenforce/code-chicken, IT Services Hahn (https://github.com/code-chicken [http://itservices-hahn.de/ https://itservices-hahn.de])
*ID 230500 - 230549: Hidup Consulting (https://consulting.hidup.io)
*ID 230550 - 230599 : CMR Conseil (https://www.weblockup.fr)
*ID 230600 - 230649 : aFreeMind Studio
*ID 230650 - 230699 : Unideal (https://www.uni-deal.com)
*ID 230700 - 230749 : DevLansdes (https://devlandes.com/)
*ID 262700 - 262799: Scopen (https://www.scopen.fr)
*ID 274250 - 274299: Nerv Project (www.nerv-project.eu)
*ID 274300 - 274349: Knowhere Consulting S.L. (https://www.knowhere-consulting.eu)
*ID 274350 - 274399: Milen karaganski (https://blacktiehost.com)
*ID 274400 - 274449: Vincent MAURY ([https://www.timgroup.fr www.timgroup.fr])
*ID 274450 - 274499: Daraelmin
*ID 274500 - 274550: Emilie LAFORET (http://www.ermvallon.com)
*ID 279000 - 279049: VSDigital Electronics (https://vsdigital.ar) - Argentina
*ID 280000 - 280050: Bingroup (https://www.beinng.com)
*ID 280051 - 280100: Medialta (https://medialta.com)
*ID 290000 - 290099: BNS - Project doliBRA ([https://www.beinng.com https://www.bns.net.br]) - Brasil
*ID 300000 - 300049: RapidProgress (https://www.rapidprogress.eu) - Bulgaria
*ID 300050 : 300099: M@ Solution (https://www.ma-solution.fr/)
*ID 300100 : 300149: LAVA RUN (https://www.lavarun.re)
*ID 300200 : 300249 : Computences (https://www.computences.com/)
*ID 300250 : 300299 : LEVEL IT (https://levelit.com.ar)
*ID 300300 : 300349 : Progiseize (https://progiseize.fr)
*ID 300350 - 300399: MB Informatique (https://www.mb-informatique.fr)
*ID 300400 - 300449: Anouar Touati
*ID 300450 - 300499: Martin Danger
*ID 300500 - 301499: Whale Blows
*ID 301500 - 301549: Tom Trust - International
*ID 302500 - 302549: Diamubi (https://diamubi.com)
*ID 302550 - 302599: Datolab (https://www.datolab.com)
*ID 302600 - 302649: DuMaCo (https://www.dumaco.de)
*ID 302650 - 302699: Resilio SA
*ID 302700 - 302749: Aroga
*ID 302750 - 302799: Productivix (https://www.productivix.com)
*ID 302800 - 302849: Slibzz
*ID 302850 - 302899: idea design (https://ideadesign.dz)
*ID 302900 - 302949: AL MISBAH INFORMATIQUE (https://www.almisbah.ma)
*ID 302950 - 302999: Atis Solutions - France
*ID 303000 - 303499: Obixav - Nigeria
*ID 303500 - 303550: buschler plus GmbH, Germany (https://buschler.plus)
*ID 303551 - 303599: Prestalidaire - France (https://prestalidaire.com)
*ID 314000 - 314049: Ruemmler IT Solutions (https://www.ruemmler.net)
*ID 320000 - 320999: Novus Studios (www.novusstudios.it)
*ID 321000 - 321999: AtooNet (http://www.atoo-net.com)
*ID 332000 - 332099: Gecka (https://gecka.nc)
*ID 332100 - 332149: Agence Milkshake (http://agencemilkshake.com)
*ID 332150 - 332199: Daniel Prowald IT – Service (https://prowald-it.de)
*ID 332200 - 332249: UNITICE (https://unitice.com)
*ID 332250 - 332299: Sidonie Moulart
*ID 332300 - 332349: LTDJ (Antonin MARCHAL - Le Temple du Jeu)
*ID 330000 - 330049: XTEC Industries (www.xtec-ind.com)
*ID 330050 - 330099: 10100 S.R.L. - (www.10100.to)
*ID 330100 - 330149: AES Dana SRL (https://aes-dana.be)
*ID 330150 - 330199: Freshcore (https://www.freshcore.fr)
*ID 330200 - 399999: (take ranges of 50 only please, ask us for more)
*ID 333300 - 333349: Sense Africa (http://sense.africa)
*ID 350000 - 350049: SOUNDOU & MIDAS (https://www.soundou.org/)
*ID 400000 - 400999: 2byte.es (http://www.2byte.es)
*ID 401000 - 401999: B&D Informática
*ID 402000 - 402999: Marcos García de La Fuente (marcosgdf)
*ID 403000 - 403999: Sergibyte
*ID 404000 - 404999: Aikhan
*ID 405000 - 405999: AIME (http://www.aime.mx)
*ID 406000 - 406999: Som Núvol (https://somnuvol.coop)
*ID 409000 - 409999: LliureTIC (https://www.lliuretic.cat)
*ID 410000 - 410999: DoliGov
*ID 420000 - 420099: BBS Concept
*ID 420100 - 420199: LeMousticProduction (www.lemousticproduction.info) -< module DoliRH
*ID 420200 - 421199: VatCheck (www.abnc.be)
*ID 422200 - 422999: Artaban (http://artaban.fr)
*ID 423000 - 423050: cyberesprit
*ID 423051 - 423099: R.Bossard
*ID 423100 - 423199: Joliciel (www.joliciel.fr)
*ID 424000 - 424049: A3sys - Mon-Dolibarr (http://www.mon-dolibarr.fr) by Philazerty
*ID 424050 - 424099: Pragma-tech (www.pragma-tech.fr)
*ID 424100 - 424149: Ohoo Solutions (http://www.ohoosolutions.com)
*ID 424150 - 424199: DAGARCAM Informática (https://www.dagarcam.com/)
*ID 424200 - 424999: Lab51 (https://github.com/lab51org)
*ID 425000 - 425999: Sébastien SERRE Thivinfo (www.thivinfo.com)
*ID 426000 - 426099: Arkesis-Solution
*ID 426100 - 426149: GetLandy (www.getlandy.com)
*ID 426150 - 426649: OOB Software
*ID 426650 - 426849: Soft-Task Serviços e Sistemas (www.soft-task.com.br)
*ID 426850 - 427000: Bruno Caldas (https://github.com/BCaldas)
*ID 427001 - 427999: Kevin GUERRIER (alias xcl.saian)
*ID 428000 - 428099: af83
*ID 428100 - 428199: Arnaud Serrut - Adalon
*ID 428200 - 428249: imschweiler consulting (http://www.imschweiler-consulting.de'''<nowiki/>''')
*ID 428250 - 428299: AL1FO
*ID 428300 - 428349: Federico García-Patiño Barbolani (<federico.garcia.patino@gmail.com>)
*ID 428350 - 428399: INTM Groupe - France (www.intm.com)
*ID 428400 - 428449: Nick Fragoulis - Greece
*ID 428450 - 428499: Letusgeek - France
*id 428500 - 428549 hkwhitten - USA
*ID 428550 - 428999 SmartOne
*ID 429000 - 429999: induslab
*ID 430000 - 430099: Mixity sprl (www.mixity.be)
*ID 430100 - 430199: sgiraud
*ID 430200 - 430299: Merlion TI (www.merlion-si.com.br)
*ID 430300 - 431299: Libre Expert (www.libre-expert.com)
*ID 431300 - 431399: ptibogxiv (www.ptibogxiv.net)
*ID 431400 - 431499: Befox (www.befox.fr)
*ID 431500 - 431599: rue Béjo (www.ruebejo.fr)
*ID 431600 - 431699: Avizzeo (www.avizzeo.com)
*ID 431700 - 432199: Multisistemas (www.multisistemas.com.sv)
*ID 432200 - 432399: Burbuja - Chile (www.burbuja.cl)
*ID 432400 - 433399: INOVEA CONSEIL (https://www.inovea-conseil.com)
*ID 433400 - 434399: Rachid HRICH - Maroc (HricH ServiceS.)
*ID 434400 - 435399: Lance Bleakley - LanceIT (www.lanceit.net)
*ID 436000 - 436099: SOWEBIO (www.soweb.io)
*ID 436100 - 436199: CAP-REL (www.cap-rel.fr)
*ID 436200 - 436300: TDE-INFORMATIQUE (www.tde-informatique.fr)
*ID 436301 - 436349: Evarisk ([https://www.evarisk.com/id-module-dolibarr/ www.evarisk.com])
*ID 436350 - 436399: Eoxia ([https://www.eoxia.com/dolibarr/modules/ www.eoxia.com])
*ID 436400 - 437399: Mohamed AHERDANE - Morocco - IT Consultant ( www.wave.ma )
*ID 437400 - 437449: Martin Neubauer - Germany
*ID 437450 - 437599: Club1click (www.club1click.es)
*ID 437600 - 437629: Coulon Vincent (https://github.com/HoverEpic)
*ID 437630 - 437649: Aytechnet (https://www.aytechnet.fr/) - François Pons
*ID 437650 - 437699: LibreMaster (https://libremaster.com) - Christophe T.
*ID 437700 - 437749: STELLAR Broadband (https://www.stellarbb.com) - U.S.A. - Philip Laycock
*ID 437750 - 437799: DIGITA.LU Ajous Solutions
*ID 437800 - 437850: iProspective (https://iprospective.fr) - Mathieu Moulin
*ID 437851 - 437900: Theobald Groupe.
*ID 437901 - 437950: Neuronnexion (http://neuronnexion.coop)
*ID 437951 - 437952: jmbc - APIA-ASSO (https://www.apia-asso.fr)
*ID 437953 - 438002: IPCZEN SARL (https://www.ipczeninformatique.fr/)
*ID 438003 - 438052: FESF IT Department (https://fesf.org.pk)
*ID 438053 - 438399: '''Free (take ranges of 50 only please at once, ask us for more)'''
*ID 438400 - 439399: Tetras Libre - France - Développement logiciels libres (www.tetras-libre.fr)
*ID 439400 - 440399: Dolibarr-pro - France - Développement Dolibarr (www.dolibarr-pro.com)
*ID 440400 - 441399: Quidlab Co., Ltd - Thailand - ( www.quidlab.com )
*ID 441400 - 442399: Ide@log - France - (https://www.idealog-info.net) - Laurent Leblanc
*ID 442400 - 443399: Valerio Bianchi (www.valeriobianchi.com)
*ID 443400 - 444399: delassalle - France - (www.delassalle.fr) - Joseph Delassalle
*ID 444400 - 445399: Webartis - Maroc - (www.webartis.net) - François Dry
*ID 445400 - 445499: SCOP Au-delà des nuages - France
*ID 446000 - 446999: iouston (http://www.iouston.com) - France - Julien Marchand
*ID 447000 - 447999: rSanjoSEO - Rafael San José Tovar (www.rsanjoseo.com) - Spain
*ID 448000 - 448999: Code 42 (www.code42.fr)
*ID 449000 - 449999: TakePOS (www.takepos.com)
*ID 450000 - 450999: Pierre ARDOIN
*ID 451000 - 451999: Éditeur depordi.fr
*ID 452000 - 452999: Dylan NAKONG
*ID 453000 - 453999: Menahd Ouchenir - France - menahd-ouchenir.com
*ID 454000 - 454999: Withheld - Canada
*ID 455000 - 455999: Gaëtan MAISON - Info Libre @ Dom - France (https://www.infolibreadom.com)
*ID 456000 - 456999: Laurent LEBLEU - B.L.C. - Blue Line Company - Lille - France (www.bluelinecompany.fr/dolibarr)
*ID 457000 - 457999: Sébastien BOUCHER
*ID 458000 - 458999: Lester HERNÁNDEZ - Argentina - (freelancerlrhd@gmail.com)
*ID 459000 - 459999: Infopen - France
*ID 460000 - 460050: torvista - Spain
*ID 461000 - 461999: MEGALOGI - Maroc (www.erpcloud.ma)
*ID 462000 - 462999: Making Digital (www.making-digital.fr) - France
*ID 463000 - 463999: linx s.r.l.s.
*ID 464000 - 464999: NimbleCubed Inc. (www.nimblecubed.com)
*ID 465000 - 465999: Artefacts - CourantAlternatif
*ID 466000 - 466999: CDM Consultores - (www.cdm.guru)
*ID 467000 - 467999: M71 Service GmbH - (www.m71-service.de)
*ID 468000 - 468049: Clément Segonzac - France (clement.segonzac@gmail.com)
*ID 468050 - 468099: Flavien Belli - France (https://github.com/Marshlyin || belliflaviencontactpro@gmail.com)
*ID 468100 - 468119: Chl (https://code.bugness.org/Dolibarr)
*ID 468120 - 468170: Commotron GmbH (https://www.commotron.com/)
*ID 468171 - 468220: Infans Group (franck.lauby@infans.fr)
*ID 468221 - 468174 '''Free (take ranges of 50 only please at once, ask us for more)'''
*ID 468175 - 468199: Gaëlle Rauffet - France (kiwiscan.net)
*ID 468200 - 468250: Paulo Oliveira - Brasil (paulorcdo@gmail.com)
*ID 468251 - 468270: CD-Systems - France (https://www.cd-systems.fr)
*ID 468300 - 468349: Uvensys - Germany (https://uvensys.de)
*ID 468350 - 468399 : Laudeco - Belgium (http://github.com/laudeco)
*ID 468400 - 468449 : Alexis LAURIER - France (https://www.alexislaurier.fr)
*ID 468450 - 468499 : Mehdi Belkhayat - Maroc (https://opensi.ma)
*ID 468500 - 468599 : InvIT GmbH - Germany (https://invit.sh)
*ID 468600 - 468649 : Ricardo Sequeira - Portugal (https://ricardo-sequeira.com)
*ID 468650 - 468699 : J-IT - Belgique (https://www.j-it.be)
*ID 468700 - 468749 : Fidesio - France (https://www.fidesio.com/)
*ID 468750 - 468799 : Sgestion - Spain (http://www.sgestion.net/)
*ID 468800 - 468849 : Denis JULIEN - Brasil (matrinxa@free.fr)
*ID 468850 - 468900: Mmariko - Module GED - Effios
*ID 468901 - 468950: Maazou Amadou Abdoul aziz - Maroc (yaronfada@gmail.com)
*ID 468951 - 469000: Alexis LAURIER - France (https://www.alexislaurier.fr)
*ID 469001 - 469050: John Livingston (https://github.com/JohnXLivingston/)
*ID 469051 - 469100: Macrorom ICT-services (https://macrorom.nl/)
*ID 469101 - 469150: HABOT IT - France (https://habot.it)
*ID 469151 - 469160: CaribbeanConsult.Com CCC - France Guadeloupe (https://dolibarr.ccc.gp)
*ID 469161 - 469171: GMBG - Portugal
*ID 469172 - 469192: BGi Lda - Portugal
*ID 469949 - 469999: Goldoweb (http://goldoweb.com)
*ID 470000 - 470999: Reindeer Digital (https://rdeer.cz)
*ID 471000 - 471099: CAP-REL (www.cap-rel.fr)
*ID 471100 - 471199: M. Morillon
*ID 471200 - 471209: Pablo Nuñez
*ID 481000 - 482000: Alhaidab-ITIS (https://alhaidab.dolibarr.sd)
*ID 482001 - 483000: Basix IT (https://www.basix.de)
*ID 483001 - 483050: SASCO SpA (https://www.sasco.cl)
*ID 483051 - 483100: WIP Engineering (https://www.wip-gmbh.com)
*ID 483101 - 483150: J.Kaiser
*ID 483151 - 483201: CodLines (https://www.codlines.com)
*ID 485000 - 485049: Gest Info Service Plus (contact@gest-plus.fr)
*ID 490000 - 490050: VOLD (https://vold.lu)
*ID 491000 - 491050: NORD ERP CRM (https://www.nord-erp-crm.fr/)
*ID 491051 - 491100: KJR-online (https://kjr-online.fr/)
*ID 491101 - 491149: eNova
*ID 491150 - 491200: App 4 Business
*ID 491201 - 491250: Mil24 (http://www.mil24.com.py)
*ID 491251 - 491301: M2AM

DO NOT ADD RECORD HERE, PLEASE FILL HOLES FIRST !!!!
...

=ID > 500000=

This range can't be reserved. It is a common range. If you don't plan to distribute your module, you can use an ID in this range with no need to reserve it.

{{Flag en}}
If you don't already have reserved ids and need some, please don't use hazardous number and use a number higher than 500000, but it is better to ask a wiki account, and reserve your own range by editing the 100000 - 499999 range (50 ids at once, 1000 ids maximum per partner).

{{Flag fr}}
Si vous n'avez pas de numéros réservés et en avez besoin, n'utilisez pas de chiffres au hasard et utilisez une valeur supérieure à 500000, toutefois, il est préférable d'obtenir un compte wiki, et réserver vous-même votre plage en ajoutant votre entrée dans la zone 100000 - 499999 (par lot de 50 d'abord, pas plus de 1000 numéros par partenaire).

{{Flag sp}}
Si no dispone de número reservado y necesita, no use cifras redondeadas y usa un valor superior a 500000. Si tiene una cuenta wiki, puede reservarse usted mismo sus id añadiendo su entrada en la zona 100000 - 499999 (no más de 1000 id por partner).