dolibarr  9.0.0
modMultiCurrency.class.php
Go to the documentation of this file.
1 <?php
2 /* Copyright (C) 2003 Rodolphe Quiedeville <rodolphe@quiedeville.org>
3  * Copyright (C) 2004-2015 Laurent Destailleur <eldy@users.sourceforge.net>
4  * Copyright (C) 2005-2016 Regis Houssin <regis.houssin@inodbox.com>
5  * Copyright (C) 2016 Pierre-Henry Favre <phf@atm-consulting.fr>
6  *
7  * This program is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 3 of the License, or
10  * (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program. If not, see <http://www.gnu.org/licenses/>.
19  */
20 
28 include_once DOL_DOCUMENT_ROOT.'/core/modules/DolibarrModules.class.php';
29 
30 
35 {
41  public function __construct($db)
42  {
43  global $langs, $conf;
44 
45  $this->db = $db;
46 
47  // Id for module (must be unique).
48  // Use here a free id (See in Home -> System information -> Dolibarr for list of used modules id).
49  $this->numero = 40000;
50  // Key text used to identify module (for permissions, menus, etc...)
51  $this->rights_class = 'multicurrency';
52 
53  // Family can be 'crm','financial','hr','projects','products','ecm','technic','other'
54  // It is used to group modules in module setup page
55  $this->family = "technic";
56  // Module position in the family
57  $this->module_position = '40';
58 
59  // Module label (no space allowed), used if translation string 'ModuleXXXName' not found (where XXX is value of numeric property 'numero' of module)
60  $this->name = preg_replace('/^mod/i', '', get_class($this));
61  // Module description, used if translation string 'ModuleXXXDesc' not found (where XXX is value of numeric property 'numero' of module)
62  $this->description = "Module to manage several foreign currencies in prices and documents";
63 
64  // Possible values for version are: 'development', 'experimental', 'dolibarr' or 'dolibarr_deprecated' or version
65  $this->version = 'dolibarr';
66  // Key used in llx_const table to save module status enabled/disabled (where MYMODULE is value of property name of module in uppercase)
67  $this->const_name = 'MAIN_MODULE_'.strtoupper($this->name);
68  // Name of image file used for this module.
69  // If file is in theme/yourtheme/img directory under name object_pictovalue.png, use this->picto='pictovalue'
70  // If file is in module/img directory under name object_pictovalue.png, use this->picto='pictovalue@module'
71  $this->picto = 'multicurrency';
72 
73  // Defined all module parts (triggers, login, substitutions, menus, css, etc...)
74  // for default path (eg: /multicurrency/core/xxxxx) (0=disable, 1=enable)
75  // for specific path of parts (eg: /multicurrency/core/modules/barcode)
76  // for specific css file (eg: /multicurrency/css/multicurrency.css.php)
77  $this->module_parts = array();
78 
79  // Data directories to create when module is enabled.
80  // Example: this->dirs = array("/multicurrency/temp");
81  $this->dirs = array();
82 
83  // Config pages. Put here list of php page, stored into multicurrency/admin directory, to use to setup module.
84  $this->config_page_url = array("multicurrency.php");
85 
86  // Dependencies
87  $this->hidden = false; // A condition to hide module
88  $this->depends = array(); // List of modules id that must be enabled if this module is enabled
89  $this->requiredby = array(); // List of modules id to disable if this one is disabled
90  $this->conflictwith = array(); // List of modules id this module is in conflict with
91  $this->phpmin = array(5, 4); // Minimum version of PHP required by module
92  $this->need_dolibarr_version = array(3, 0); // Minimum version of Dolibarr required by module
93  $this->langfiles = array("multicurrency");
94 
95  // Constants
96  // List of particular constants to add when module is enabled (key, 'chaine', value, desc, visible, 'current' or 'allentities', deleteonunactive)
97  // Example: $this->const=array(0=>array('MYMODULE_MYNEWCONST1','chaine','myvalue','This is a constant to add',1),
98  // 1=>array('MYMODULE_MYNEWCONST2','chaine','myvalue','This is another constant to add',0, 'current', 1)
99  // );
100  $this->const = array();
101 
102  // Array to add new pages in new tabs
103  // Example: $this->tabs = array('objecttype:+tabname1:Title1:mylangfile@multicurrency:$user->rights->multicurrency->read:/multicurrency/mynewtab1.php?id=__ID__', // To add a new tab identified by code tabname1
104  // 'objecttype:+tabname2:SUBSTITUTION_Title2:mylangfile@multicurrency:$user->rights->othermodule->read:/multicurrency/mynewtab2.php?id=__ID__', // To add another new tab identified by code tabname2. Label will be result of calling all substitution functions on 'Title2' key.
105  // 'objecttype:-tabname:NU:conditiontoremove'); // To remove an existing tab identified by code tabname
106  // where objecttype can be
107  // 'categories_x' to add a tab in category view (replace 'x' by type of category (0=product, 1=supplier, 2=customer, 3=member)
108  // 'contact' to add a tab in contact view
109  // 'contract' to add a tab in contract view
110  // 'group' to add a tab in group view
111  // 'intervention' to add a tab in intervention view
112  // 'invoice' to add a tab in customer invoice view
113  // 'invoice_supplier' to add a tab in supplier invoice view
114  // 'member' to add a tab in fundation member view
115  // 'opensurveypoll' to add a tab in opensurvey poll view
116  // 'order' to add a tab in customer order view
117  // 'order_supplier' to add a tab in supplier order view
118  // 'payment' to add a tab in payment view
119  // 'payment_supplier' to add a tab in supplier payment view
120  // 'product' to add a tab in product view
121  // 'propal' to add a tab in propal view
122  // 'project' to add a tab in project view
123  // 'stock' to add a tab in stock view
124  // 'thirdparty' to add a tab in third party view
125  // 'user' to add a tab in user view
126  $this->tabs = array();
127 
128  // Dictionaries
129  if (!isset($conf->multicurrency->enabled))
130  {
131  $conf->multicurrency = new stdClass();
132  $conf->multicurrency->enabled = 0;
133  }
134  $this->dictionaries = array();
135  /* Example:
136  if (! isset($conf->multicurrency->enabled)) $conf->multicurrency->enabled=0; // This is to avoid warnings
137  $this->dictionaries=array(
138  'langs'=>'mylangfile@multicurrency',
139  'tabname'=>array(MAIN_DB_PREFIX."table1",MAIN_DB_PREFIX."table2",MAIN_DB_PREFIX."table3"), // List of tables we want to see into dictonnary editor
140  'tablib'=>array("Table1","Table2","Table3"), // Label of tables
141  'tabsql'=>array('SELECT f.rowid as rowid, f.code, f.label, f.active FROM '.MAIN_DB_PREFIX.'table1 as f','SELECT f.rowid as rowid, f.code, f.label, f.active FROM '.MAIN_DB_PREFIX.'table2 as f','SELECT f.rowid as rowid, f.code, f.label, f.active FROM '.MAIN_DB_PREFIX.'table3 as f'), // Request to select fields
142  // Sort order
143  'tabsqlsort'=>array("label ASC","label ASC","label ASC"),
144  'tabfield'=>array("code,label","code,label","code,label"), // List of fields (result of select to show dictionary)
145  'tabfieldvalue'=>array("code,label","code,label","code,label"), // List of fields (list of fields to edit a record)
146  'tabfieldinsert'=>array("code,label","code,label","code,label"), // List of fields (list of fields for insert)
147  'tabrowid'=>array("rowid","rowid","rowid"), // Name of columns with primary key (try to always name it 'rowid')
148  'tabcond'=>array($conf->multicurrency->enabled,$conf->multicurrency->enabled,$conf->multicurrency->enabled) // Condition to show each dictionary
149  );
150  */
151 
152  // Boxes
153  // Add here list of php file(s) stored in core/boxes that contains class to show a box.
154  $this->boxes = array(); // List of boxes
155  // Example:
156  //$this->boxes=array(
157  // 0=>array('file'=>'myboxa.php@multicurrency','note'=>'','enabledbydefaulton'=>'Home'),
158  // 1=>array('file'=>'myboxb.php@multicurrency','note'=>''),
159  // 2=>array('file'=>'myboxc.php@multicurrency','note'=>'')
160  //);
161 
162  // Permissions
163  $this->rights = array(); // Permission array used by this module
164  $r = 0;
165 
166  // Add here list of permission defined by an id, a label, a boolean and two constant strings.
167  // Example:
168  // $this->rights[$r][0] = $this->numero + $r; // Permission id (must not be already used)
169  // $this->rights[$r][1] = 'Permision label'; // Permission label
170  // $this->rights[$r][3] = 0; // Permission by default for new user (0/1)
171  // $this->rights[$r][4] = 'level1'; // In php code, permission will be checked by test if ($user->rights->permkey->level1->level2)
172  // $this->rights[$r][5] = 'level2'; // In php code, permission will be checked by test if ($user->rights->permkey->level1->level2)
173  // $r++;
174 
175  // Main menu entries
176  $this->menu = array(); // List of menus to add
177  $r = 0;
178 
179  // Add here entries to declare new menus
180  //
181  // Example to declare a new Top Menu entry and its Left menu entry:
182  // $this->menu[$r]=array( 'fk_menu'=>'', // '' if this is a top menu. For left menu, use 'fk_mainmenu=xxx' or 'fk_mainmenu=xxx,fk_leftmenu=yyy' where xxx is mainmenucode and yyy is a leftmenucode
183  // 'type'=>'top', // This is a Top menu entry
184  // 'titre'=>'MyModule top menu',
185  // 'mainmenu'=>'multicurrency',
186  // 'leftmenu'=>'multicurrency',
187  // 'url'=>'/multicurrency/pagetop.php',
188  // 'langs'=>'mylangfile@multicurrency', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
189  // 'position'=>100,
190  // 'enabled'=>'$conf->multicurrency->enabled', // Define condition to show or hide menu entry. Use '$conf->multicurrency->enabled' if entry must be visible if module is enabled.
191  // 'perms'=>'1', // Use 'perms'=>'$user->rights->multicurrency->level1->level2' if you want your menu with a permission rules
192  // 'target'=>'',
193  // 'user'=>2); // 0=Menu for internal users, 1=external users, 2=both
194  // $r++;
195  //
196  // Example to declare a Left Menu entry into an existing Top menu entry:
197  // $this->menu[$r]=array( 'fk_menu'=>'fk_mainmenu=xxx', // '' if this is a top menu. For left menu, use 'fk_mainmenu=xxx' or 'fk_mainmenu=xxx,fk_leftmenu=yyy' where xxx is mainmenucode and yyy is a leftmenucode
198  // 'type'=>'left', // This is a Left menu entry
199  // 'titre'=>'MyModule left menu',
200  // 'mainmenu'=>'xxx',
201  // 'leftmenu'=>'multicurrency',
202  // 'url'=>'/multicurrency/pagelevel2.php',
203  // 'langs'=>'mylangfile@multicurrency', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
204  // 'position'=>100,
205  // 'enabled'=>'$conf->multicurrency->enabled', // Define condition to show or hide menu entry. Use '$conf->multicurrency->enabled' if entry must be visible if module is enabled. Use '$leftmenu==\'system\'' to show if leftmenu system is selected.
206  // 'perms'=>'1', // Use 'perms'=>'$user->rights->multicurrency->level1->level2' if you want your menu with a permission rules
207  // 'target'=>'',
208  // 'user'=>2); // 0=Menu for internal users, 1=external users, 2=both
209  // $r++;
210 
211 
212  // Exports
213  $r = 1;
214 
215  // Example:
216  // $this->export_code[$r]=$this->rights_class.'_'.$r;
217  // $this->export_label[$r]='MyModule'; // Translation key (used only if key ExportDataset_xxx_z not found)
218  // $this->export_enabled[$r]='1'; // Condition to show export in list (ie: '$user->id==3'). Set to 1 to always show when module is enabled.
219  // $this->export_icon[$r]='generic:MyModule';
220  // $this->export_permission[$r]=array(array("multicurrency","level1","level2"));
221  // $this->export_fields_array[$r]=array(
222  // 's.rowid'=>"IdCompany",'s.nom'=>'CompanyName','s.address'=>'Address','s.zip'=>'Zip','s.town'=>'Town','s.fk_pays'=>'Country','s.phone'=>'Phone',
223  // 's.siren'=>'ProfId1','s.siret'=>'ProfId2','s.ape'=>'ProfId3','s.idprof4'=>'ProfId4','s.code_compta'=>'CustomerAccountancyCode',
224  // 's.code_compta_fournisseur'=>'SupplierAccountancyCode','f.rowid'=>"InvoiceId",'f.facnumber'=>"InvoiceRef",'f.datec'=>"InvoiceDateCreation",
225  // 'f.datef'=>"DateInvoice",'f.total'=>"TotalHT",'f.total_ttc'=>"TotalTTC",'f.tva'=>"TotalVAT",'f.paye'=>"InvoicePaid",'f.fk_statut'=>'InvoiceStatus',
226  // 'f.note'=>"InvoiceNote",'fd.rowid'=>'LineId','fd.description'=>"LineDescription",'fd.price'=>"LineUnitPrice",'fd.tva_tx'=>"LineVATRate",
227  // 'fd.qty'=>"LineQty",'fd.total_ht'=>"LineTotalHT",'fd.total_tva'=>"LineTotalTVA",'fd.total_ttc'=>"LineTotalTTC",'fd.date_start'=>"DateStart",
228  // 'fd.date_end'=>"DateEnd",'fd.fk_product'=>'ProductId','p.ref'=>'ProductRef'
229  //);
230  // $this->export_TypeFields_array[$r]=array(
231  // 't.date'=>'Date', 't.qte'=>'Numeric', 't.poids'=>'Numeric', 't.fad'=>'Numeric', 't.paq'=>'Numeric', 't.stockage'=>'Numeric', 't.fadparliv'=>'Numeric',
232  // 't.livau100'=>'Numeric', 't.forfait'=>'Numeric', 's.nom'=>'Text','s.address'=>'Text','s.zip'=>'Text','s.town'=>'Text','c.code'=>'Text','s.phone'=>'Text',
233  // 's.siren'=>'Text','s.siret'=>'Text','s.ape'=>'Text','s.idprof4'=>'Text','s.code_compta'=>'Text','s.code_compta_fournisseur'=>'Text','s.tva_intra'=>'Text',
234  // 'f.facnumber'=>"Text",'f.datec'=>"Date",'f.datef'=>"Date",'f.date_lim_reglement'=>"Date",'f.total'=>"Numeric",'f.total_ttc'=>"Numeric",'f.tva'=>"Numeric",
235  // 'f.paye'=>"Boolean",'f.fk_statut'=>'Status','f.note_private'=>"Text",'f.note_public'=>"Text",'fd.description'=>"Text",'fd.subprice'=>"Numeric",
236  // 'fd.tva_tx'=>"Numeric",'fd.qty'=>"Numeric",'fd.total_ht'=>"Numeric",'fd.total_tva'=>"Numeric",'fd.total_ttc'=>"Numeric",'fd.date_start'=>"Date",
237  // 'fd.date_end'=>"Date",'fd.special_code'=>'Numeric','fd.product_type'=>"Numeric",'fd.fk_product'=>'List:product:label','p.ref'=>'Text','p.label'=>'Text',
238  // 'p.accountancy_code_sell'=>'Text'
239  //);
240  // $this->export_entities_array[$r]=array(
241  // 's.rowid'=>"company",'s.nom'=>'company','s.address'=>'company','s.zip'=>'company','s.town'=>'company','s.fk_pays'=>'company','s.phone'=>'company',
242  // 's.siren'=>'company','s.siret'=>'company','s.ape'=>'company','s.idprof4'=>'company','s.code_compta'=>'company','s.code_compta_fournisseur'=>'company',
243  // 'f.rowid'=>"invoice",'f.facnumber'=>"invoice",'f.datec'=>"invoice",'f.datef'=>"invoice",'f.total'=>"invoice",'f.total_ttc'=>"invoice",
244  // 'f.tva'=>"invoice",'f.paye'=>"invoice",'f.fk_statut'=>'invoice','f.note'=>"invoice",'fd.rowid'=>'invoice_line','fd.description'=>"invoice_line",
245  // 'fd.price'=>"invoice_line",'fd.total_ht'=>"invoice_line",'fd.total_tva'=>"invoice_line",'fd.total_ttc'=>"invoice_line",'fd.tva_tx'=>"invoice_line",
246  // 'fd.qty'=>"invoice_line",'fd.date_start'=>"invoice_line",'fd.date_end'=>"invoice_line",'fd.fk_product'=>'product','p.ref'=>'product'
247  //);
248  // $this->export_dependencies_array[$r]=array('invoice_line'=>'fd.rowid','product'=>'fd.rowid'); // To add unique key if we ask a field of a child to avoid the DISTINCT to discard them
249  // $this->export_sql_start[$r]='SELECT DISTINCT ';
250  // $this->export_sql_end[$r] =' FROM ('.MAIN_DB_PREFIX.'facture as f, '.MAIN_DB_PREFIX.'facturedet as fd, '.MAIN_DB_PREFIX.'societe as s)';
251  // $this->export_sql_end[$r] .=' LEFT JOIN '.MAIN_DB_PREFIX.'product as p on (fd.fk_product = p.rowid)';
252  // $this->export_sql_end[$r] .=' WHERE f.fk_soc = s.rowid AND f.rowid = fd.fk_facture';
253  // $this->export_sql_order[$r] .=' ORDER BY s.nom';
254  // $r++;
255  }
256 
265  public function init($options = '')
266  {
267  $sql = array();
268 
269  //$this->_load_tables('/multicurrency/sql/');
270  $res = $this->_init($sql, $options);
271 
272  if ($res)
273  {
274  $this->createFirstCurrency();
275  }
276 
277  return $res;
278  }
279 
288  public function remove($options = '')
289  {
290  $sql = array();
291 
292  return $this->_remove($sql, $options);
293  }
294 
301  private function createFirstCurrency()
302  {
303  global $conf, $user, $langs;
304 
305  if (!MultiCurrency::checkCodeAlreadyExists($conf->currency))
306  {
307  $langs->loadCacheCurrencies('');
308 
309  $multicurrency = new MultiCurrency($this->db);
310  $multicurrency->code = $conf->currency;
311  $multicurrency->name = $langs->cache_currencies[$conf->currency]['label'].' ('.$langs->getCurrencySymbol($conf->currency).')';
312  $r = $multicurrency->create($user);
313 
314  if ($r > 0) $multicurrency->addRate(1);
315  }
316  }
317 }
318 
Class DolibarrModules.
</td >< td class="liste_titre" align="right"></td ></tr >< tr class="liste_titre">< input type="checkbox" onClick="toggle(this)"/> Ref p ref Label p label Duration p duration warehouseinternal SELECT description FROM product_lang WHERE qty< br > qty qty qty StockTooLow img yes disabled img no img no< tr class="oddeven">< td >< input type="checkbox" class="check" name="' . $i . '"' . $disabled . '></td >< td >< input type="checkbox" class="check" name="choose'.$i.'"></td >< td class="nowrap"></td >< td >< input type="hidden" name="desc' . $i . '" value="' . dol_escape_htmltag($objp-> description
Only used if Module[ID]Desc translation string is not found.
Definition: replenish.php:573
_remove($array_sql, $options='')
Disable function.
Description and activation class for module MyModule.
$conf db name
Only used if Module[ID]Name translation string is not found.
Definition: repair.php:103
static checkCodeAlreadyExists($code)
Check in database if the current code already exists.
createFirstCurrency()
Function called when module is enabled Create the currency from general setting.
init($options='')
Function called when module is enabled.
__construct($db)
Constructor.
_init($array_sql, $options='')
Enables a module.
Class Currency.