Module development: Difference between revisions

Then change the contents of this file to replace:

Your file descriptor for your module is ready.

Create a subdirectory called "sql" into directory of your module (eg htdocs/mymodule/sql) to put the sql scripts that you will create. Then in the "load_tables" function of your file descriptor module, modify the line

by

''Rules to follow:''

Example of content of a file data.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__');

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.

Once you have created your tables into the database, move to the dev/skeletons directory and run the script

Note: If the command does not work, try to use php-cli php instead.

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

// Array to add new pages in new tabs

$this->tabs = array('product:ComposedProducts:@composition:/composition/show_composition.php?id=__ID__');

// 'propal'          to add a tab in propal view

// 'member'          to add a tab in fundation member view

The table should contain a list of strings, each string representing a new tab.  

Copy, into that directory, the file '''skeletons_page.php''' that will serve as a starting point for your page file and also file '''pre.inc.php'''.

Edit the file '''pre.inc.php''' to have a correct relative path to the main.inc.php file.

include("../../main.inc.php)";

This depends on the depth of the directory in which the file is pre.inc.php (Add or remove "../").  

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:

To make an insert, update or delete:

$db->begin();  // Start transaction

$db->query("My SQL request insert, update or delete");

$db->commit();      // Validate transaction

or $db->rollback()  // Cancel transaction

To read:

$resql=$db->query("My select request");

if ($resql)

}

}

== Define style of your pages ==

== Use the Dolibarr date selector ==

If you want to use the Dolibarr date selector (with its calendar popup) into your pages, use the following line:

  $form=new Form($db);

  $form->select_date('','mykey',0,0,0,"myform");

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).

To get value after the POST of your form, the command is:

$mydate = dol_mktime(12, 0 , 0, $_POST['mykeymonth'], $_POST['mykeyday'], $_POST['mykeyyear']);

print strftime('%A %d %B %Y', $mydate);

= [[File:Art.png]] Add your own setup page (optionnal)  =

Put this page into directory '''/admin'''.

Then, into the descriptor file of your module, modify the variable config_page_url to set name of this PHP page (without the path that is not necesary if page is inside directory admin).

$this->config_page_url = array("mymodule_setuppage.php");

== Test your page ==

This is the example of code to declare your own menu entries in a module descriptor file:

// Main menu entries

$this->menu = array(); // List of menus to add

'user'=>2); // 0=Menu for internal users,1=external users, 2=both

$r++;

To show menu or not depending on a permission, modify property '''perms''' in array. See chapter on permissions later to see how to add 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 $this->rights_class = 'facture' par

$this->rights_class = 'monmodule'

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

$this->rights[$r][0] = 10001;

$this->rights[$r][1] = 'Libelle par défaut de ma permission';

$this->rights[$r][5] = 'sousaction';

$r++;

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 connaitre les id déjà utilisés.

''Exemple:''

this->boxes[0][1]='mabox0.php'

this->boxes[1][1]='mabox1.php'

...

this->boxes[n][1]='maboxn.php'

Ensuite creer les fichiers mabox0.php, mabox1.php... en prenant exemple sur des box existantes (dans le répertoire htdocs/include/boxes

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

perl makepack-dolibarrmodule.pl

The script asks you the name of your module, its major and minor version. A file '''mymodule.tgz ''' 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:

tar -xvf monmodule.tgz

* If you want your module to be public, you can submit it (the tgz file) on Dolibarr web site on download area: http://www.dolibarr.org -> downloads -> contrib -> submit a file (you must create an account and be logged to have link appeared).