Module development: Difference between revisions

m
Line 199: Line 199:
= [[File:Art.png]] Add your own setup page (optionnal)  =
= [[File:Art.png]] Add your own setup page (optionnal)  =
'''When''': If your module need to ask user several parameters.
'''When''': If your module need to ask user several parameters.
{{ToTranslate}}
 
== Creer votre page d'édition de configuration ==
== Create your page to edit parameters ==
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''').
If your module need several parameters to be setup, you must create a page to edit options (that will be saved into [[Table llx_const|table '''llx_const''']]).
Créer une page PHP nommée '''monmodule_setupapage.php''' qui affiche les options possibles et les met à jour.
Create a page named '''mymodule_setuppage.php''' that show possibles options and update them into table from a form.
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.
It is a necessary to take an example from a page into directory '''/admin''' that will show you the way to read/save your parameter.
Placer cette page de configuration dans le répertoire '''/admin''' également.
Put this page into directory '''/admin'''.
Ensuite dans le descripteur de module, modifier 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).
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).
<pre>
<pre>
$this->config_page_url = array("monmodule_setupapage.php");
$this->config_page_url = array("mymodule_setuppage.php");
</pre>
</pre>


== Tester votre page ==
== Test your page ==
Aller sur la page '''Configuration->module''', vous devez voir apparaitre un icone qui permet d'accéder à la page de configuratione tvous devez etre capable de modifier ces options et les voir conservé en base.
Go into page '''Home->Setup->Modules''', you should see a picto 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.


= [[File:Art.png]] Define your entries in menu (optionnal) =
= [[File:Art.png]] Define your entries in menu (optionnal) =