Changes

Jump to navigation Jump to search
Line 72: Line 72:  
On peut stocker les paramètres qui définissent une configuration dans une table de la base de données ou bien dans un fichier. Bien que traditionnellement on préfère utiliser les constantes base de données pour stocker les paramètres de l’application, on distingue plusieurs avantages pour l’utilisation de fichiers à la place:  
 
On peut stocker les paramètres qui définissent une configuration dans une table de la base de données ou bien dans un fichier. Bien que traditionnellement on préfère utiliser les constantes base de données pour stocker les paramètres de l’application, on distingue plusieurs avantages pour l’utilisation de fichiers à la place:  
   −
# Un fichier est plus facilement consultable qu’une table de base de données. Il peut même être consulté sans installation de Dolibarr.
+
#Un fichier est plus facilement consultable qu’une table de base de données. Il peut même être consulté sans installation de Dolibarr.
# Les modifications dans un fichier peuvent être gérées par un gestionnaire de versions tel que GIT. Dans le cas d’une table, Il faudra créer une table spéciale pour gérer l’historique avec le traitement qui s’ensuit.
+
#Les modifications dans un fichier peuvent être gérées par un gestionnaire de versions tel que GIT. Dans le cas d’une table, Il faudra créer une table spéciale pour gérer l’historique avec le traitement qui s’ensuit.
# Dans le cas de Dolibarr, il existe encore un troisième avantage, qui est celui de pouvoir définir des métadonnées en commentaires sur les paramètres au lieu d'utiliser les champs limités de la table llx_const. C'est ce qui a permis de définir plusieurs types de données  dans les fichiers de configurations de modules paramétrable (Voir ci dessous).
+
#Dans le cas de Dolibarr, il existe encore un troisième avantage, qui est celui de pouvoir définir des métadonnées en commentaires sur les paramètres au lieu d'utiliser les champs limités de la table llx_const. C'est ce qui a permis de définir plusieurs types de données  dans les fichiers de configurations de modules paramétrable (Voir ci dessous).
    
Il existe toutefois quelques inconvénients mineurs :
 
Il existe toutefois quelques inconvénients mineurs :
Line 86: Line 86:  
Les modules paramétrables sont des modules conçus pour interagir efficacement avec le module de paramétrage. Leurs caractéristiques sont :
 
Les modules paramétrables sont des modules conçus pour interagir efficacement avec le module de paramétrage. Leurs caractéristiques sont :
   −
# Tous les paramètres de ces modules sont stockés sur un fichier de configuration.  
+
#Tous les paramètres de ces modules sont stockés sur un fichier de configuration.
# Les paramètres sont consultables et modifiables dans la configuration du module.  
+
#Les paramètres sont consultables et modifiables dans la configuration du module.
# On définit 3 types de paramètres : chaîne,intervalle et booléens.  
+
#On définit 3 types de paramètres : chaîne,intervalle et booléens.
# Dans la page de configuration du module, on peut définir une ou plusieurs pages qui affichent une section de paramétrage pour changer les valeurs de paramètres à la volée.  
+
#Dans la page de configuration du module, on peut définir une ou plusieurs pages qui affichent une section de paramétrage pour changer les valeurs de paramètres à la volée.
# Chaque paramètre peut être configuré pour apparaître ou non dans les sections de paramétrage autres que la page de configuration du module.  
+
#Chaque paramètre peut être configuré pour apparaître ou non dans les sections de paramétrage autres que la page de configuration du module.
 
  −
==== Exemple de contenu fichier de configuration ( Contenu du fichier de paramétrage du module Menupar ) : ====
  −
 
      
=====Le module de paramétrage :=====
 
=====Le module de paramétrage :=====
Line 105: Line 102:     
    4. L’inclusion de sections de paramétrage adaptées à des pages spécifiques.
 
    4. L’inclusion de sections de paramétrage adaptées à des pages spécifiques.
 +
 +
= Exemple de module paramétrable et de fichier de configuration : =
 +
L'exemple le plus représentatif de module paramétrable est le module Cashdeskpar dont la démo est disponible sous le lien: http://dolipar.org/dolibarr/htdocs/custom_dolipar/cashdeskpar/affIndex.php?menu=facturation
 +
 +
Ci dessous une copie d'écran de sa page principale :
 +
 +
 +
''<?php''
 +
 +
''global $conf,$langs;''
 +
 +
''$langs->load('menupar@menupar');''
 +
 +
''//param_BD''
 +
 +
''$conf->global->CHARTOFACCOUNTS=113;//Plan comptable''
 +
 +
''//param_CASHDESKPAR--------------''
 +
 +
''define('CASHDESKPAR_AUTOCOMPLETE',0);//bm//0//1-requiert 2:Formulaire autocomplete pour sélection''
 +
 +
''define('CASHDESKPAR_DONT_POPUP_TICKET',0);//bm//0//2-inhibe l'ouverture automatique du ticket''
 +
 +
''define('CASHDESKPAR_DONT_PRINT_TICKET',0);//bm//0//3-inhibe l'impression automatique du ticket''
 +
 +
''define('CASHDESKPAR_FOCUS_LISTE',0);//bm//0//4-Rend le focus à la liste si ref vide''
 +
 +
''define('CASHDESKPAR_HIDE_REMISE_PERCENT',0);//bm//0//5-Cacher remise en pourcentage''
 +
 +
''define('CASHDESKPAR_HIDE_TVA',0);//bm//0//6-cache TVA dans cashdesk''
 +
 +
''define('CASHDESKPAR_MODIFIABLE_PRICE',0);//bm//0//7-prix modifiable''
 +
 +
''define('CASHDESKPAR_MODIFY_DELETED',1);//bm//0//8-Modifier une ligne aprés suppression''
 +
 +
''define('CASHDESKPAR_MONNAIE_CODE',1);//bm//////9-xx''
 +
 +
''define('CASHDESKPAR_MONNAIE_VIDE',0);//bm//0//10-Ticket sans type de monnaie''
 +
 +
''define('CASHDESKPAR_PANIER_RAPIDE',0);//bm//0//11-saisie rapide''
 +
 +
''define('CASHDESKPAR_PAIEMENT_AUTO',0);//bm//0//12-saisie automatique du paiement égal au montant total''
 +
 +
''define('CASHDESKPAR_PARAMETRES',1);//bm//0//13-Formulaire de parametrage''
 +
 +
''define('CASHDESKPAR_QTE_ENTER_KEY',1);//bm//0//14-Faire passer au champ suivant à la validation sur le champ Qte''
 +
 +
''define('CASHDESKPAR_SHOW_LINES',1);//bm//0//15-Voir les lignes facture''
 +
 +
''define('CASHDESKPAR_SHOW_TEL',1);//bm//0//16-Affiche le nº de telephone dans le ticket''
 +
 +
''define('CASHDESKPAR_THEME_31',0);//bm//////17-''
 +
 +
''define('CASHDESKPAR_TICKET_RAPIDE_POPUP',1);//bm//0//18-requiert 4:Montre le ticket en popup''
 +
 +
''define('CASHDESKPAR_TICKET_RAPIDE',0);//bm//0//19-4:Bouton ticket direct''
 +
 +
''define('CASHDESKPAR_TICKET_TITRE_BONLIVRAISON',1);//bm//0//20-requiert 3:Titre ticket (Bon de livraison)''
 +
 +
''define('CASHDESKPAR_CREATION_CHANGEMENT_CLIENTS',0);//bm//0//21-Créer et changer le client''
 +
 +
''define('CASHDESKPAR_SEARCH_POS',-1);//im-1:10//0//22-Position de début pour recherche totale''
 +
 +
''define('CASHDESKPAR_MOBILE_LAYOUT',0);//bm//0//23-Adapter le thème à l'écran de téléphone''
 +
 +
''define('CASHDESKPAR_ANDROID_TICKET',1);//bm//0//24-Le ticket sera stocké dans une image sur laquelle un programme est lancé pour imprimer l'étiquette''
 +
 +
''define('CASHDESKPAR_ANDROID_JS_TICKET',1);//bm//0//25-Le ticket stocké dans une image sera imprimé dans une webview par Javascript''
 +
 +
''define('CASHDESKPAR_OPEN_SECTIONS',0);//bm//0//26-Ouvrir les sections au lancement de la page''
 +
 +
''//param_PRODUCT--------------''
 +
 +
''define('CASHDESKPAR_PRODUCT_ZY_AUTOCOMPLETE_LIMIT_RESULTS_VALUE',22);//im1-100//0//nombre de résultats d'autocomplete''
 +
 +
''define('CASHDESKPAR_PRODUCT_ZY_AUTOSELECT_LENGTH',2);//im1-10//1//Nombre de caractéres minimum pour recherche''
 +
 +
''define('CASHDESKPAR_PRODUCT_SELECT_BY_REFS',0);//bm//0//Activer Autoselect sur les références seulement''
 +
 +
''define('CASHDESKPAR_PRODUCT_FORM_LIST_SORT_KEY',0);//bm//0//xxx''
 +
 +
 +
Ce fichier de configuration composé de plusieurs sections. L'analyseur syntaxique de configuration interprète des métadonnées en commentaires pour présenter les paramètres de configuration dans la section de paramétrage.
    
=La composition de configurations :=
 
=La composition de configurations :=
 
<br />
 
<br />
204

edits

Navigation menu