Développement module: Difference between revisions

Créer un sous-répertoire '''sql''' dans le repertoire de votre module (par exemple '''htdocs/monmodule/sql''') afin d'y placer les scripts sql que vous aller créer.

Ensuite, dans la fonction load_tables de votre fichier descripteur de module, modifier la ligne

par

''Règles à respecter:''

Une fois votre ou vos tables créées en base, aller dans le répertoire '''dev/skeletons''' et lancez le script

Remarque: Si la commande ne fonctionne pas, essayer d'utiliser php-cli plutot que php.

Pour cela, aller dans le fichier descripteur de module précédemment créé et modifier le tableau $this->tabs:

// 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

Le tableau doit contenir une liste de chaine, chaque chaine représentant un nouvel onglet.

Y recopier le fichier '''skeletons_page.php''' qui va servir de point de départ à votre page ainsi que le fichier '''pre.inc.php'''.

Modifier le fichier '''pre.inc.php''' afin que le chemin relatif du

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

soit correct, en fonction de la profondeur de répertoire dans laquelle se trouve le fichier '''pre.inc.php''' (Enlever ou supprimer des "../").

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

=== Compléter votre descripteur de module ===

Dans votre descripteur de module, compléter la déclaration du tableau this->const afin d'ajouter la constante MAIN_MODULE_monmodule_NEEDSMARTY.

$this->const=array(1=>array('MAIN_MODULE_MONMODULE_NEEDSMARTY','chaine',1,'Need smarty',0));

Ceci aura pour effet, lors de l'initialisation de l'objet $conf, de remplir le tableau $conf->need_smarty des modules qui ont besoin de smarty et si au moins un module est requis, le code dans main.inc.php chargera systématiquement les librairies de Smarty.

Pour un insert, update ou delete:

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

$db->query("Ma requete insert, update ou delete");

$db->commit();      // Valide

ou $db->rollback()  // Annule

Pour une lecture:

$resql=$db->query("Ma requete select");

if ($resql)

}

}

== Définition du style ==

Si vous le désirez, vous pouvez profiter du sélecteur de date dans des écrans Dolibarr. Pour cela, utilisez la ligne suivante:

$form=new Form($db);

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

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

Pour récupérer la valeur, à l'issu du POST, la commande est:

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

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

= [[File:Art.png]] Définir votre page de configuration (optionnel)  =

Placer cette page de configuration dans le répertoire '''/admin''' également.

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

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

== Tester votre page ==

Voici un exemple de déclaration d'entrées de menu dans le fichier descripteur:

// Main menu entries

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

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

$r++;

Pour conditionner l'accès au menu selon des permission, modifier la propriété '''perms''' du tableau. Voir le chapitre sur le permission un peu plus loin pour savoir comment ajouter des 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.

Dans $this->rights[$r][4] et $this->rights[$r][5], mettre une chaine action et sousaction sans espaces. Vous pourrez alors tester dans le code PHP si un utilisateurs a bien les droits par la séquence suivante:

if ($user->rights->monmodule->action->sousaction) ...

= [[File:Art.png]] Définir vos propres box (optionnel) =

''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

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

perl makepack-dolibarrmodule.pl

Le script vous demande le nom de votre module, sa version majeure et mineure.

Un fichier '''monmodule.tgz''' 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:

tar -xvf monmodule.tgz

* Si vous désirez que votre module profite à tous, vous pouvez le soumettre (le fichier tgz) sur le site web de Dolibarr dans la section téléchargements: http://www.dolibarr.org -> downloads -> contrib -> submit a file (vous devez avoir créer un compte auparavant et être loggué pour que le lien apparaisse).