dolibarr  16.0.5
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 <https://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, 6); // 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  $conf->multicurrency = new stdClass();
131  $conf->multicurrency->enabled = 0;
132  }
133  $this->dictionaries = array();
134 
135 
136  // Boxes
137  // Add here list of php file(s) stored in core/boxes that contains class to show a box.
138  $this->boxes = array(); // List of boxes
139  // Example:
140  //$this->boxes=array(
141  // 0=>array('file'=>'myboxa.php@multicurrency','note'=>'','enabledbydefaulton'=>'Home'),
142  // 1=>array('file'=>'myboxb.php@multicurrency','note'=>''),
143  // 2=>array('file'=>'myboxc.php@multicurrency','note'=>'')
144  //);
145 
146  // Permissions
147  $this->rights = array(); // Permission array used by this module
148  $r = 0;
149 
150  // Add here list of permission defined by an id, a label, a boolean and two constant strings.
151  // Example:
152  // $this->rights[$r][0] = $this->numero + $r; // Permission id (must not be already used)
153  // $this->rights[$r][1] = 'Permision label'; // Permission label
154  // $this->rights[$r][3] = 0; // Permission by default for new user (0/1)
155  // $this->rights[$r][4] = 'level1'; // In php code, permission will be checked by test if ($user->rights->permkey->level1->level2)
156  // $this->rights[$r][5] = 'level2'; // In php code, permission will be checked by test if ($user->rights->permkey->level1->level2)
157  // $r++;
158 
159  // Main menu entries
160  $this->menu = array(); // List of menus to add
161  $r = 0;
162 
163  // Add here entries to declare new menus
164  //
165  // Example to declare a new Top Menu entry and its Left menu entry:
166  // $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
167  // 'type'=>'top', // This is a Top menu entry
168  // 'titre'=>'MyModule top menu',
169  // 'mainmenu'=>'multicurrency',
170  // 'leftmenu'=>'multicurrency',
171  // 'url'=>'/multicurrency/pagetop.php',
172  // 'langs'=>'mylangfile@multicurrency', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
173  // 'position'=>100,
174  // '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.
175  // 'perms'=>'1', // Use 'perms'=>'$user->rights->multicurrency->level1->level2' if you want your menu with a permission rules
176  // 'target'=>'',
177  // 'user'=>2); // 0=Menu for internal users, 1=external users, 2=both
178  // $r++;
179  //
180  // Example to declare a Left Menu entry into an existing Top menu entry:
181  // $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
182  // 'type'=>'left', // This is a Left menu entry
183  // 'titre'=>'MyModule left menu',
184  // 'mainmenu'=>'xxx',
185  // 'leftmenu'=>'multicurrency',
186  // 'url'=>'/multicurrency/pagelevel2.php',
187  // 'langs'=>'mylangfile@multicurrency', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
188  // 'position'=>100,
189  // '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.
190  // 'perms'=>'1', // Use 'perms'=>'$user->rights->multicurrency->level1->level2' if you want your menu with a permission rules
191  // 'target'=>'',
192  // 'user'=>2); // 0=Menu for internal users, 1=external users, 2=both
193  // $r++;
194 
195 
196  // Exports
197  $r = 1;
198 
199  // Example:
200  // $this->export_code[$r]=$this->rights_class.'_'.$r;
201  // $this->export_label[$r]='MyModule'; // Translation key (used only if key ExportDataset_xxx_z not found)
202  // $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.
203  // $this->export_icon[$r]='generic:MyModule';
204  // $this->export_permission[$r]=array(array("multicurrency","level1","level2"));
205  // $this->export_fields_array[$r]=array(
206  // 's.rowid'=>"IdCompany",'s.nom'=>'CompanyName','s.address'=>'Address','s.zip'=>'Zip','s.town'=>'Town','s.fk_pays'=>'Country','s.phone'=>'Phone',
207  // 's.siren'=>'ProfId1','s.siret'=>'ProfId2','s.ape'=>'ProfId3','s.idprof4'=>'ProfId4','s.code_compta'=>'CustomerAccountancyCode',
208  // 's.code_compta_fournisseur'=>'SupplierAccountancyCode','f.rowid'=>"InvoiceId",'f.ref'=>"InvoiceRef",'f.datec'=>"InvoiceDateCreation",
209  // 'f.datef'=>"DateInvoice",'f.total_ht'=>"TotalHT",'f.total_ttc'=>"TotalTTC",'f.total_tva'=>"TotalVAT",'f.paye'=>"InvoicePaid",'f.fk_statut'=>'InvoiceStatus',
210  // 'f.note'=>"InvoiceNote",'fd.rowid'=>'LineId','fd.description'=>"LineDescription",'fd.price'=>"LineUnitPrice",'fd.tva_tx'=>"LineVATRate",
211  // 'fd.qty'=>"LineQty",'fd.total_ht'=>"LineTotalHT",'fd.total_tva'=>"LineTotalTVA",'fd.total_ttc'=>"LineTotalTTC",'fd.date_start'=>"DateStart",
212  // 'fd.date_end'=>"DateEnd",'fd.fk_product'=>'ProductId','p.ref'=>'ProductRef'
213  //);
214  // $this->export_TypeFields_array[$r]=array(
215  // 't.date'=>'Date', 't.qte'=>'Numeric', 't.poids'=>'Numeric', 't.fad'=>'Numeric', 't.paq'=>'Numeric', 't.stockage'=>'Numeric', 't.fadparliv'=>'Numeric',
216  // 't.livau100'=>'Numeric', 't.forfait'=>'Numeric', 's.nom'=>'Text','s.address'=>'Text','s.zip'=>'Text','s.town'=>'Text','c.code'=>'Text','s.phone'=>'Text',
217  // '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',
218  // 'f.ref'=>"Text",'f.datec'=>"Date",'f.datef'=>"Date",'f.date_lim_reglement'=>"Date",'f.total_ht'=>"Numeric",'f.total_ttc'=>"Numeric",'f.total_tva'=>"Numeric",
219  // 'f.paye'=>"Boolean",'f.fk_statut'=>'Status','f.note_private'=>"Text",'f.note_public'=>"Text",'fd.description'=>"Text",'fd.subprice'=>"Numeric",
220  // 'fd.tva_tx'=>"Numeric",'fd.qty'=>"Numeric",'fd.total_ht'=>"Numeric",'fd.total_tva'=>"Numeric",'fd.total_ttc'=>"Numeric",'fd.date_start'=>"Date",
221  // 'fd.date_end'=>"Date",'fd.special_code'=>'Numeric','fd.product_type'=>"Numeric",'fd.fk_product'=>'List:product:label','p.ref'=>'Text','p.label'=>'Text',
222  // 'p.accountancy_code_sell'=>'Text'
223  //);
224  // $this->export_entities_array[$r]=array(
225  // 's.rowid'=>"company",'s.nom'=>'company','s.address'=>'company','s.zip'=>'company','s.town'=>'company','s.fk_pays'=>'company','s.phone'=>'company',
226  // 's.siren'=>'company','s.siret'=>'company','s.ape'=>'company','s.idprof4'=>'company','s.code_compta'=>'company','s.code_compta_fournisseur'=>'company',
227  // 'f.rowid'=>"invoice",'f.ref'=>"invoice",'f.datec'=>"invoice",'f.datef'=>"invoice",'f.total_ht'=>"invoice",'f.total_ttc'=>"invoice",
228  // 'f.total_tva'=>"invoice",'f.paye'=>"invoice",'f.fk_statut'=>'invoice','f.note'=>"invoice",'fd.rowid'=>'invoice_line','fd.description'=>"invoice_line",
229  // 'fd.price'=>"invoice_line",'fd.total_ht'=>"invoice_line",'fd.total_tva'=>"invoice_line",'fd.total_ttc'=>"invoice_line",'fd.tva_tx'=>"invoice_line",
230  // 'fd.qty'=>"invoice_line",'fd.date_start'=>"invoice_line",'fd.date_end'=>"invoice_line",'fd.fk_product'=>'product','p.ref'=>'product'
231  //);
232  // $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
233  // $this->export_sql_start[$r]='SELECT DISTINCT ';
234  // $this->export_sql_end[$r] =' FROM ('.MAIN_DB_PREFIX.'facture as f, '.MAIN_DB_PREFIX.'facturedet as fd, '.MAIN_DB_PREFIX.'societe as s)';
235  // $this->export_sql_end[$r] .=' LEFT JOIN '.MAIN_DB_PREFIX.'product as p on (fd.fk_product = p.rowid)';
236  // $this->export_sql_end[$r] .=' WHERE f.fk_soc = s.rowid AND f.rowid = fd.fk_facture';
237  // $this->export_sql_order[$r] .=' ORDER BY s.nom';
238  // $r++;
239  }
240 
249  public function init($options = '')
250  {
251  $sql = array();
252 
253  $res = $this->_init($sql, $options);
254 
255  if ($res) {
256  $this->createFirstCurrency();
257  }
258 
259  return $res;
260  }
261 
270  public function remove($options = '')
271  {
272  $sql = array();
273 
274  return $this->_remove($sql, $options);
275  }
276 
283  private function createFirstCurrency()
284  {
285  global $conf, $user, $langs;
286 
287  $multicurrency = new MultiCurrency($this->db);
288 
289  if (! $multicurrency->checkCodeAlreadyExists($conf->currency)) {
290  $langs->loadCacheCurrencies('');
291 
292  $multicurrency->code = $conf->currency;
293  $multicurrency->name = $langs->cache_currencies[$conf->currency]['label'].' ('.$langs->getCurrencySymbol($conf->currency).')';
294  $r = $multicurrency->create($user);
295 
296  if ($r > 0) {
297  $multicurrency->addRate(1);
298  }
299  }
300  }
301 }
db
$conf db
API class for accounts.
Definition: inc.php:41
description
print *****$script_file(".$version.") pid cd cd cd description as description
Definition: email_expire_services_to_customers.php:83
modMultiCurrency\init
init($options='')
Function called when module is enabled.
Definition: modMultiCurrency.class.php:249
name
$conf db name
Definition: repair.php:122
DolibarrModules\_remove
_remove($array_sql, $options='')
Disable function.
Definition: DolibarrModules.class.php:482
modMultiCurrency
Description and activation class for module MyModule.
Definition: modMultiCurrency.class.php:34
MultiCurrency
Class Currency.
Definition: multicurrency.class.php:39
modMultiCurrency\__construct
__construct($db)
Constructor.
Definition: modMultiCurrency.class.php:41
DolibarrModules\_init
_init($array_sql, $options='')
Enables a module.
Definition: DolibarrModules.class.php:383
modMultiCurrency\createFirstCurrency
createFirstCurrency()
Function called when module is enabled Create the currency from general setting.
Definition: modMultiCurrency.class.php:283
DolibarrModules
Class DolibarrModules.
Definition: DolibarrModules.class.php:37