dolibarr  17.0.3
modStock.class.php
Go to the documentation of this file.
1 <?php
2 /* Copyright (C) 2003-2006 Rodolphe Quiedeville <rodolphe@quiedeville.org>
3  * Copyright (C) 2004-2008 Laurent Destailleur <eldy@users.sourceforge.net>
4  * Copyright (C) 2005-2009 Regis Houssin <regis.houssin@inodbox.com>
5  * Copyright (C) 2012 Juanjo Menent <jmenent@2byte.es>
6  * Copyright (C) 2021 Ferran Marcet <fmarcet@2byte.es>
7  *
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 3 of the License, or
11  * (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program. If not, see <https://www.gnu.org/licenses/>.
20  */
21 
30 include_once DOL_DOCUMENT_ROOT.'/core/modules/DolibarrModules.class.php';
31 
32 
37 {
43  public function __construct($db)
44  {
45  global $conf, $langs;
46 
47  $this->db = $db;
48  $this->numero = 52;
49 
50  $this->family = "products";
51  $this->module_position = '39';
52  // Module label (no space allowed), used if translation string 'ModuleXXXName' not found (where XXX is value of numeric property 'numero' of module)
53  $this->name = preg_replace('/^mod/i', '', get_class($this));
54  $this->description = "Gestion des stocks";
55 
56  // Possible values for version are: 'development', 'experimental', 'dolibarr' or version
57  $this->version = 'dolibarr';
58 
59  $this->const_name = 'MAIN_MODULE_'.strtoupper($this->name);
60  $this->picto = 'stock';
61 
62  // Data directories to create when module is enabled
63  $this->dirs = array("/stock/temp");
64 
65  $this->config_page_url = array("stock.php");
66 
67  // Dependencies
68  $this->hidden = false; // A condition to hide module
69  $this->depends = array("modProduct"); // List of module class names as string that must be enabled if this module is enabled
70  $this->requiredby = array("modProductBatch"); // List of module ids to disable if this one is disabled
71  $this->conflictwith = array(); // List of module class names as string this module is in conflict with
72  $this->phpmin = array(7, 0); // Minimum version of PHP required by module
73  $this->langfiles = array("stocks");
74 
75  // Constants
76  $this->const = array();
77  $r = 0;
78 
79  $this->const[$r] = array('STOCK_ALLOW_NEGATIVE_TRANSFER', 'chaine', '1', '', 1);
80 
81  $r++;
82  $this->const[$r][0] = "STOCK_ADDON_PDF";
83  $this->const[$r][1] = "chaine";
84  $this->const[$r][2] = "standard";
85  $this->const[$r][3] = 'Name of PDF model of stock';
86  $this->const[$r][4] = 0;
87 
88  $r++;
89  $this->const[$r][0] = "MOUVEMENT_ADDON_PDF";
90  $this->const[$r][1] = "chaine";
91  $this->const[$r][2] = "stdmovement";
92  $this->const[$r][3] = 'Name of PDF model of stock mouvement';
93  $this->const[$r][4] = 0;
94 
95  $r++;
96  $this->const[$r][0] = "STOCK_ADDON_PDF_ODT_PATH";
97  $this->const[$r][1] = "chaine";
98  $this->const[$r][2] = "DOL_DATA_ROOT/doctemplates/stocks";
99  $this->const[$r][3] = "";
100  $this->const[$r][4] = 0;
101 
102  $r++;
103  $this->const[$r][0] = "MOUVEMENT_ADDON_PDF_ODT_PATH";
104  $this->const[$r][1] = "chaine";
105  $this->const[$r][2] = "DOL_DATA_ROOT/doctemplates/stocks/mouvements";
106  $this->const[$r][3] = "";
107  $this->const[$r][4] = 0;
108 
109  // Boxes
110  $this->boxes = array();
111 
112  // Permissions
113  $this->rights = array();
114  $this->rights_class = 'stock';
115 
116  $this->rights[0][0] = 1001;
117  $this->rights[0][1] = 'Lire les stocks';
118  $this->rights[0][2] = 'r';
119  $this->rights[0][3] = 0;
120  $this->rights[0][4] = 'lire';
121  $this->rights[0][5] = '';
122 
123  $this->rights[1][0] = 1002;
124  $this->rights[1][1] = 'Creer/Modifier les stocks';
125  $this->rights[1][2] = 'w';
126  $this->rights[1][3] = 0;
127  $this->rights[1][4] = 'creer';
128  $this->rights[1][5] = '';
129 
130  $this->rights[2][0] = 1003;
131  $this->rights[2][1] = 'Supprimer les stocks';
132  $this->rights[2][2] = 'd';
133  $this->rights[2][3] = 0;
134  $this->rights[2][4] = 'supprimer';
135  $this->rights[2][5] = '';
136 
137  $this->rights[3][0] = 1004;
138  $this->rights[3][1] = 'Lire mouvements de stocks';
139  $this->rights[3][2] = 'r';
140  $this->rights[3][3] = 0;
141  $this->rights[3][4] = 'mouvement';
142  $this->rights[3][5] = 'lire';
143 
144  $this->rights[4][0] = 1005;
145  $this->rights[4][1] = 'Creer/modifier mouvements de stocks';
146  $this->rights[4][2] = 'w';
147  $this->rights[4][3] = 0;
148  $this->rights[4][4] = 'mouvement';
149  $this->rights[4][5] = 'creer';
150 
151  $this->rights[5][0] = 1011;
152  $this->rights[5][1] = 'inventoryReadPermission'; // Permission label
153  $this->rights[5][3] = 0; // Permission by default for new user (0/1)
154  $this->rights[5][4] = 'inventory_advance'; // In php code, permission will be checked by test if ($user->rights->permkey->level1->level2)
155  $this->rights[5][5] = 'read'; // In php code, permission will be checked by test if ($user->rights->permkey->level1->level2)
156 
157  $this->rights[6][0] = 1012;
158  $this->rights[6][1] = 'inventoryCreatePermission'; // Permission label
159  $this->rights[6][3] = 0; // Permission by default for new user (0/1)
160  $this->rights[6][4] = 'inventory_advance'; // In php code, permission will be checked by test if ($user->rights->permkey->level1->level2)
161  $this->rights[6][5] = 'write'; // In php code, permission will be checked by test if ($user->rights->permkey->level1->level2)
162 
163  $this->rights[6][0] = 1013;
164  $this->rights[6][1] = 'inventoryDeletePermission'; // Permission label
165  $this->rights[6][3] = 0; // Permission by default for new user (0/1)
166  $this->rights[6][4] = 'inventory_advance'; // In php code, permission will be checked by test if ($user->rights->permkey->level1->level2)
167  $this->rights[6][5] = 'delete'; // In php code, permission will be checked by test if ($user->rights->permkey->level1->level2)
168 
169 
170  if ($conf->global->MAIN_FEATURES_LEVEL >= 2) {
171  $this->rights[8][0] = 1014;
172  $this->rights[8][1] = 'inventoryValidatePermission'; // Permission label
173  $this->rights[8][3] = 0; // Permission by default for new user (0/1)
174  $this->rights[8][4] = 'inventory_advance'; // In php code, permission will be checked by test if ($user->rights->permkey->level1->level2)
175  $this->rights[8][5] = 'validate'; // In php code, permission will be checked by test if ($user->rights->permkey->level1->level2)
176 
177  $this->rights[9][0] = 1015;
178  $this->rights[9][1] = 'inventoryChangePMPPermission'; // Permission label
179  $this->rights[9][3] = 0; // Permission by default for new user (0/1)
180  $this->rights[9][4] = 'inventory_advance'; // In php code, permission will be checked by test if ($user->rights->permkey->level1->level2)
181  $this->rights[9][5] = 'changePMP'; // In php code, permission will be checked by test if ($user->rights->permkey->level1->level2)
182 
183  $this->rights[10][0] = 1016;
184  $this->rights[10][1] = 'inventoryDeletePermission'; // Permission label
185  $this->rights[10][3] = 0; // Permission by default for new user (0/1)
186  $this->rights[10][4] = 'inventory_advance'; // In php code, permission will be checked by test if ($user->rights->permkey->level1->level2)
187  $this->rights[10][5] = 'delete'; // In php code, permission will be checked by test if ($user->rights->permkey->level1->level2)
188  }
189 
190  // Main menu entries
191  $this->menu = array(); // List of menus to add
192  $r = 0;
193 
194  // Menus
195  //-------
196  $this->menu = 1; // This module add menu entries. They are coded into menu manager.
197 
198 
199  // Exports
200  //--------
201  $r = 0;
202 
203  // Export warehouses
204  $r++;
205  $this->export_code[$r] = $this->rights_class.'_emplacement';
206  $this->export_label[$r] = "Warehouses"; // Translation key (used only if key ExportDataset_xxx_z not found)
207  $this->export_icon[$r] = "warehouse";
208  $this->export_permission[$r] = array(array("stock", "lire"));
209  $this->export_fields_array[$r] = array(
210  'e.rowid'=>'IdWarehouse', 'e.ref'=>'LocationSummary', 'e.description'=>'DescWareHouse', 'e.lieu'=>'LieuWareHouse', 'e.address'=>'Address', 'e.zip'=>'Zip', 'e.town'=>'Town',
211  'd.code_departement'=>'Departement', 'c.code'=>'CountryCode',
212  'e.phone'=>'Phone', 'e.fax'=>'Fax', 'e.statut'=>'Status', 'pe.rowid'=>'ParentWarehouse', 'pe.ref'=>'LocationSummary'
213  );
214  $this->export_TypeFields_array[$r] = array(
215  'e.ref'=>'Text', 'e.description'=>'Text', 'e.lieu'=>'Text', 'e.address'=>'Text', 'e.zip'=>'Text', 'e.town'=>'Text',
216  'd.code_departement'=>'List:c_departements:code_departement:code_departement:', 'c.code'=>'List:c_country:code:code:',
217  'e.phone'=>'Text', 'e.fax'=>'Text', 'e.statut'=>'Text', 'pe.rowid'=>'List:entrepot:ref:rowid:stock', 'pe.ref'=>'Text'
218  );
219  $this->export_entities_array[$r] = array(); // We define here only fields that use another icon that the one defined into export_icon
220  $this->export_aggregate_array[$r] = array();
221  $keyforselect = 'warehouse';
222  $keyforelement = 'warehouse';
223  $keyforaliasextra = 'extra';
224  include DOL_DOCUMENT_ROOT.'/core/extrafieldsinexport.inc.php';
225 
226  $this->export_sql_start[$r] = 'SELECT DISTINCT ';
227  $this->export_sql_end[$r] = ' FROM '.MAIN_DB_PREFIX.'entrepot as e';
228  $this->export_sql_end[$r] .= ' LEFT JOIN '.MAIN_DB_PREFIX.'c_departements as d ON d.rowid = e.fk_departement';
229  $this->export_sql_end[$r] .= ' LEFT JOIN '.MAIN_DB_PREFIX.'c_country as c ON c.rowid = e.fk_pays';
230  $this->export_sql_end[$r] .= ' LEFT JOIN '.MAIN_DB_PREFIX.'entrepot as pe ON pe.rowid = e.fk_parent';
231  $this->export_sql_end[$r] .= ' LEFT JOIN '.MAIN_DB_PREFIX.'entrepot_extrafields as extra ON extra.fk_object = e.rowid';
232  $this->export_sql_end[$r] .= ' WHERE e.entity IN ('.getEntity('stock').')';
233 
234  // Export stock (without batch number)
235  $r++;
236  $this->export_code[$r] = $this->rights_class.'_emplacement_product';
237  $this->export_label[$r] = "Stocks"; // Translation key (used only if key ExportDataset_xxx_z not found)
238  $this->export_icon[$r] = "warehouse";
239  $this->export_permission[$r] = array(array("stock", "lire"));
240  $this->export_fields_array[$r] = array(
241  'e.rowid'=>'IdWarehouse', 'e.ref'=>'LocationSummary', 'e.description'=>'DescWareHouse', 'e.lieu'=>'LieuWareHouse', 'e.address'=>'Address', 'e.zip'=>'Zip', 'e.town'=>'Town',
242  'p.rowid'=>"ProductId", 'p.ref'=>"Ref", 'p.fk_product_type'=>"Type", 'p.label'=>"Label", 'p.description'=>"Description", 'p.note'=>"Note",
243  'p.price'=>"Price", 'p.tva_tx'=>'VAT', 'p.tosell'=>"OnSell", 'p.tobuy'=>'OnBuy', 'p.duration'=>"Duration",
244  'p.datec'=>'DateCreation', 'p.tms'=>'DateModification', 'p.pmp'=>'PMPValue', 'p.cost_price'=>'CostPrice',
245  'p.seuil_stock_alerte'=>'StockLimit',
246  );
247  $this->export_TypeFields_array[$r] = array(
248  'e.rowid'=>'List:entrepot:ref::stock', 'e.ref'=>'Text', 'e.lieu'=>'Text', 'e.address'=>'Text', 'e.zip'=>'Text', 'e.town'=>'Text',
249  'p.rowid'=>"Numeric", 'p.ref'=>"Text", 'p.fk_product_type'=>"Text", 'p.label'=>"Text", 'p.description'=>"Text", 'p.note'=>"Text",
250  'p.price'=>"Numeric", 'p.tva_tx'=>'Numeric', 'p.tosell'=>"Boolean", 'p.tobuy'=>"Boolean", 'p.duration'=>"Duree",
251  'p.datec'=>'Date', 'p.tms'=>'Date', 'p.pmp'=>'Numeric', 'p.cost_price'=>'Numeric',
252  'ps.reel'=>'Numeric',
253  'p.seuil_stock_alerte'=>'Numeric',
254  );
255  $this->export_entities_array[$r] = array(
256  'p.rowid'=>"product", 'p.ref'=>"product", 'p.fk_product_type'=>"product", 'p.label'=>"product", 'p.description'=>"product", 'p.note'=>"product",
257  'p.price'=>"product", 'p.tva_tx'=>'product', 'p.tosell'=>"product", 'p.tobuy'=>"product", 'p.duration'=>"product",
258  'p.datec'=>'product', 'p.tms'=>'product', 'p.pmp'=>'product', 'p.cost_price'=>'product',
259  'ps.reel'=>'stock',
260  'p.seuil_stock_alerte'=>'product',
261  ); // We define here only fields that use another icon that the one defined into export_icon
262  $this->export_aggregate_array[$r] = array('ps.reel'=>'SUM'); // TODO Not used yet
263  $this->export_dependencies_array[$r] = array('stock'=>array('p.rowid', 'e.rowid')); // We must keep this until the aggregate_array is used. To have a unique key, if we ask a field of a child, to avoid the DISTINCT to discard them.
264  $keyforselect = 'product';
265  $keyforelement = 'product';
266  $keyforaliasextra = 'extra';
267  include DOL_DOCUMENT_ROOT.'/core/extrafieldsinexport.inc.php';
268  $this->export_fields_array[$r] = array_merge($this->export_fields_array[$r], array('ps.reel'=>'Stock'));
269 
270  $this->export_sql_start[$r] = 'SELECT DISTINCT ';
271  $this->export_sql_end[$r] = ' FROM '.MAIN_DB_PREFIX.'product as p LEFT JOIN '.MAIN_DB_PREFIX.'product_extrafields as extra ON extra.fk_object = p.rowid, '.MAIN_DB_PREFIX.'product_stock as ps, '.MAIN_DB_PREFIX.'entrepot as e';
272  $this->export_sql_end[$r] .= ' WHERE p.rowid = ps.fk_product AND ps.fk_entrepot = e.rowid';
273  $this->export_sql_end[$r] .= ' AND e.entity IN ('.getEntity('stock').')';
274 
275  // Export stock including batch number
276  if (isModEnabled('productbatch')) {
277  $langs->load("productbatch");
278 
279  // This request is same than previous but without field ps.stock (real stock in warehouse) and with link to subtable productbatch
280  $r++;
281 
282  $this->export_code[$r] = $this->rights_class.'_emplacement_product_lot';
283  $this->export_label[$r] = "StocksWithBatch"; // Translation key (used only if key ExportDataset_xxx_z not found)
284  $this->export_icon[$r] = "warehouse";
285  $this->export_permission[$r] = array(array("stock", "lire"));
286  $this->export_fields_array[$r] = array(
287  'e.rowid'=>'IdWarehouse', 'e.ref'=>'LocationSummary', 'e.description'=>'DescWareHouse', 'e.lieu'=>'LieuWareHouse', 'e.address'=>'Address', 'e.zip'=>'Zip', 'e.town'=>'Town',
288  'p.rowid'=>"ProductId", 'p.ref'=>"Ref", 'p.fk_product_type'=>"Type", 'p.label'=>"Label", 'p.description'=>"Description", 'p.note'=>"Note",
289  'p.price'=>"Price", 'p.tva_tx'=>'VAT', 'p.tosell'=>"OnSell", 'p.tobuy'=>'OnBuy', 'p.duration'=>"Duration",
290  'p.datec'=>'DateCreation', 'p.tms'=>'DateModification', 'p.pmp'=>'PMPValue', 'p.cost_price'=>'CostPrice',
291  'pb.rowid'=>'Id', 'pb.batch'=>'Batch', 'pb.qty'=>'Qty',
292  'pl.eatby'=>'EatByDate', 'pl.sellby'=>'SellByDate'
293  );
294  $this->export_TypeFields_array[$r] = array(
295  'e.rowid'=>'List:entrepot:ref::stock', 'e.ref'=>'Text', 'e.lieu'=>'Text', 'e.description'=>'Text', 'e.address'=>'Text', 'e.zip'=>'Text', 'e.town'=>'Text',
296  'p.rowid'=>"Numeric", 'p.ref'=>"Text", 'p.fk_product_type'=>"Text", 'p.label'=>"Text", 'p.description'=>"Text", 'p.note'=>"Text",
297  'p.price'=>"Numeric", 'p.tva_tx'=>'Numeric', 'p.tosell'=>"Boolean", 'p.tobuy'=>"Boolean", 'p.duration'=>"Duree",
298  'p.datec'=>'DateCreation', 'p.tms'=>'DateModification', 'p.pmp'=>'PMPValue', 'p.cost_price'=>'CostPrice',
299  'pb.batch'=>'Text', 'pb.qty'=>'Numeric',
300  'pl.eatby'=>'Date', 'pl.sellby'=>'Date'
301  );
302  $this->export_entities_array[$r] = array(
303  'p.rowid'=>"product", 'p.ref'=>"product", 'p.fk_product_type'=>"product", 'p.label'=>"product", 'p.description'=>"product", 'p.note'=>"product",
304  'p.price'=>"product", 'p.tva_tx'=>'product', 'p.tosell'=>"product", 'p.tobuy'=>"product", 'p.duration'=>"product",
305  'p.datec'=>'product', 'p.tms'=>'product', 'p.pmp'=>'product', 'p.cost_price'=>'product',
306  'pb.rowid'=>'batch', 'pb.batch'=>'batch', 'pb.qty'=>'batch',
307  'pl.eatby'=>'batch', 'pl.sellby'=>'batch'
308  ); // We define here only fields that use another icon that the one defined into export_icon
309  $this->export_aggregate_array[$r] = array('ps.reel'=>'SUM'); // TODO Not used yet
310  $this->export_dependencies_array[$r] = array('stockbatch'=>array('pb.rowid'), 'batch'=>array('pb.rowid')); // We must keep this until the aggregate_array is used. To add unique key if we ask a field of a child to avoid the DISTINCT to discard them.
311  $keyforselect = 'product_lot';
312  $keyforelement = 'batch';
313  $keyforaliasextra = 'extra';
314  include DOL_DOCUMENT_ROOT.'/core/extrafieldsinexport.inc.php';
315 
316  $this->export_sql_start[$r] = 'SELECT DISTINCT ';
317  $this->export_sql_end[$r] = ' FROM '.MAIN_DB_PREFIX.'product_batch as pb';
318  $this->export_sql_end[$r] .= ' INNER JOIN '.MAIN_DB_PREFIX.'product_stock as ps ON ps.rowid = pb.fk_product_stock';
319  $this->export_sql_end[$r] .= ' INNER JOIN '.MAIN_DB_PREFIX.'product as p ON p.rowid = ps.fk_product';
320  $this->export_sql_end[$r] .= ' LEFT JOIN '.MAIN_DB_PREFIX.'product_lot as pl ON pl.fk_product = p.rowid AND pl.batch = pb.batch';
321  $this->export_sql_end[$r] .= ' LEFT JOIN '.MAIN_DB_PREFIX.'product_lot_extrafields as extra ON extra.fk_object = pl.rowid,';
322  $this->export_sql_end[$r] .= ' '.MAIN_DB_PREFIX.'entrepot as e';
323  $this->export_sql_end[$r] .= ' WHERE ps.fk_entrepot = e.rowid';
324  $this->export_sql_end[$r] .= ' AND e.entity IN ('.getEntity('stock').')';
325  }
326 
327  // Export of stock movements
328  $r++;
329  $this->export_code[$r] = $this->rights_class.'_movement';
330  $this->export_label[$r] = "StockMovements"; // Translation key (used only if key ExportDataset_xxx_z not found)
331  $this->export_icon[$r] = "movement";
332  $this->export_permission[$r] = array(array("stock", "lire"));
333  $this->export_fields_array[$r] = array(
334  'sm.rowid'=>'MovementId', 'sm.value'=>'Qty', 'sm.datem'=>'DateMovement', 'sm.label'=>'MovementLabel', 'sm.inventorycode'=>'InventoryCode',
335  'e.rowid'=>'IdWarehouse', 'e.ref'=>'LocationSummary', 'e.description'=>'DescWareHouse', 'e.lieu'=>'LieuWareHouse', 'e.address'=>'Address', 'e.zip'=>'Zip', 'e.town'=>'Town',
336  'p.rowid'=>"ProductId", 'p.ref'=>"Ref", 'p.fk_product_type'=>"Type", 'p.label'=>"Label", 'p.description'=>"Description", 'p.note'=>"Note",
337  'p.price'=>"Price", 'p.tva_tx'=>'VAT', 'p.tosell'=>"OnSell", 'p.tobuy'=>'OnBuy', 'p.duration'=>"Duration", 'p.datec'=>'DateCreation', 'p.tms'=>'DateModification'
338  );
339  $this->export_TypeFields_array[$r] = array(
340  'sm.rowid'=>'Numeric', 'sm.value'=>'Numeric', 'sm.datem'=>'Date', 'sm.batch'=>'Text', 'sm.label'=>'Text', 'sm.inventorycode'=>'Text',
341  'e.rowid'=>'List:entrepot:ref::stock', 'e.ref'=>'Text', 'e.description'=>'Text', 'e.lieu'=>'Text', 'e.address'=>'Text', 'e.zip'=>'Text', 'e.town'=>'Text',
342  'p.rowid'=>"Numeric", 'p.ref'=>"Text", 'p.fk_product_type'=>"Text", 'p.label'=>"Text", 'p.description'=>"Text", 'p.note'=>"Text",
343  'p.price'=>"Numeric", 'p.tva_tx'=>'Numeric', 'p.tosell'=>"Boolean", 'p.tobuy'=>"Boolean", 'p.duration'=>"Duree", 'p.datec'=>'Date', 'p.tms'=>'Date'
344  );
345  $this->export_entities_array[$r] = array(
346  'e.rowid'=>'warehouse', 'e.ref'=>'warehouse', 'e.description'=>'warehouse', 'e.lieu'=>'warehouse', 'e.address'=>'warehouse', 'e.zip'=>'warehouse', 'e.town'=>'warehouse',
347  'p.rowid'=>"product", 'p.ref'=>"product", 'p.fk_product_type'=>"product", 'p.label'=>"product", 'p.description'=>"product", 'p.note'=>"product",
348  'p.price'=>"product", 'p.tva_tx'=>'product', 'p.tosell'=>"product", 'p.tobuy'=>"product", 'p.duration'=>"product", 'p.datec'=>'product', 'p.tms'=>'product'
349  ); // We define here only fields that use another icon that the one defined into export_icon
350  if (isModEnabled('productbatch')) {
351  $this->export_fields_array[$r]['sm.batch'] = 'Batch';
352  $this->export_TypeFields_array[$r]['sm.batch'] = 'Text';
353  $this->export_entities_array[$r]['sm.batch'] = 'movement';
354  }
355  $this->export_aggregate_array[$r] = array('sm.value'=>'SUM'); // TODO Not used yet
356  $this->export_dependencies_array[$r] = array('movement'=>array('sm.rowid')); // We must keep this until the aggregate_array is used. To add unique key if we ask a field of a child to avoid the DISTINCT to discard them.
357 
358  $this->export_sql_start[$r] = 'SELECT DISTINCT ';
359  $this->export_sql_end[$r] = ' FROM '.MAIN_DB_PREFIX.'product as p, '.MAIN_DB_PREFIX.'stock_mouvement as sm, '.MAIN_DB_PREFIX.'entrepot as e';
360  $this->export_sql_end[$r] .= ' WHERE p.rowid = sm.fk_product AND sm.fk_entrepot = e.rowid';
361  $this->export_sql_end[$r] .= ' AND e.entity IN ('.getEntity('stock').')';
362 
363  // Imports
364  //--------
365 
366  $r = 0;
367 
368  // Import warehouses
369  $r++;
370  $this->import_code[$r] = $this->rights_class.'_'.$r;
371  $this->import_label[$r] = "Warehouses"; // Translation key
372  $this->import_icon[$r] = "warehouse";
373  $this->import_entities_array[$r] = array(); // We define here only fields that use another icon that the one defined into import_icon
374  $this->import_tables_array[$r] = array('e'=>MAIN_DB_PREFIX.'entrepot');
375  $this->import_tables_creator_array[$r] = array('e'=>'fk_user_author');
376  $this->import_fields_array[$r] = array('e.ref'=>"LocationSummary*",
377  'e.description'=>"DescWareHouse",
378  'e.lieu'=>"LieuWareHouse",
379  'e.address'=>"Address",
380  'e.zip'=>'Zip',
381  'e.fk_departement'=>'StateCode',
382  'e.fk_pays'=>'CountryCode',
383  'e.phone'=>'Phone',
384  'e.fax'=>'Fax',
385  'e.statut'=>'Status',
386  'e.fk_parent'=>'ParentWarehouse'
387  );
388 
389  $this->import_convertvalue_array[$r] = array(
390  'e.fk_departement'=>array('rule'=>'fetchidfromcodeid', 'classfile'=>'/core/class/cstate.class.php', 'class'=>'Cstate', 'method'=>'fetch', 'dict'=>'DictionaryStateCode'),
391  'e.fk_pays'=>array('rule'=>'fetchidfromcodeid', 'classfile'=>'/core/class/ccountry.class.php', 'class'=>'Ccountry', 'method'=>'fetch', 'dict'=>'DictionaryCountry'),
392  'e.fk_parent'=>array('rule'=>'fetchidfromref', 'classfile'=>'/product/stock/class/entrepot.class.php', 'class'=>'Entrepot', 'method'=>'fetch', 'element'=>'ref')
393  );
394  $this->import_regex_array[$r] = array('e.statut'=>'^[0|1]');
395  $this->import_examplevalues_array[$r] = array('e.ref'=>"ALM001",
396  'e.description'=>"Central Warehouse",
397  'e.lieu'=>"Central",
398  'e.address'=>"Route 66",
399  'e.zip'=>'28080',
400  'e.fk_departement'=>'matches field "code_departement" in table "'.MAIN_DB_PREFIX.'c_departements"',
401  'e.fk_pays'=>'US/FR/DE etc. matches field "code" in table "'.MAIN_DB_PREFIX.'c_country"',
402  'e.phone'=>'(+33)(0)123456789',
403  'e.fax'=>'(+33)(0)123456790',
404  'e.statut'=>'1',
405  'e.fk_parent'=>'id or ref of warehouse'
406  );
407  $this->import_updatekeys_array[$r] = array('p.ref'=>'Ref');
408 
409  // Import stocks
410  $r++;
411  $this->import_code[$r] = $this->rights_class.'_'.$r;
412  $this->import_label[$r] = "Stocks"; // Translation key
413  $this->import_icon[$r] = "stock";
414  $this->import_entities_array[$r] = array(); // We define here only fields that use another icon that the one defined into import_icon
415  $this->import_tables_array[$r] = array('ps'=>MAIN_DB_PREFIX.'product_stock');
416  $this->import_fields_array[$r] = array('ps.fk_product'=>"Product*", 'ps.fk_entrepot'=>"Warehouse*", 'ps.reel'=>"Stock*");
417 
418  $this->import_convertvalue_array[$r] = array(
419  'ps.fk_product'=>array('rule'=>'fetchidfromref', 'classfile'=>'/product/class/product.class.php', 'class'=>'Product', 'method'=>'fetch', 'element'=>'product'),
420  'ps.fk_entrepot'=>array('rule'=>'fetchidfromref', 'classfile'=>'/product/stock/class/entrepot.class.php', 'class'=>'Entrepot', 'method'=>'fetch', 'element'=>'ref')
421  );
422  $this->import_examplevalues_array[$r] = array(
423  'ps.fk_product'=>"id or ref of product", 'ps.fk_entrepot'=>"id or ref of warehouse", 'ps.reel'=>"10"
424  );
425  $this->import_updatekeys_array[$r] = array('ps.fk_product'=>'Product', 'ps.fk_entrepot'=>"Warehouse");
426  $this->import_run_sql_after_array[$r] = array( // Because we may change data that are denormalized, we must update dernormalized data after.
427  'UPDATE '.MAIN_DB_PREFIX.'product as p SET p.stock = (SELECT SUM(ps.reel) FROM '.MAIN_DB_PREFIX.'product_stock ps WHERE ps.fk_product = p.rowid);'
428  );
429  }
430 
431 
440  public function init($options = '')
441  {
442  global $conf, $langs;
443 
444  $result = $this->_load_tables('/install/mysql/', 'stock');
445  if ($result < 0) {
446  return -1; // Do not activate module if error 'not allowed' returned when loading module SQL queries (the _load_table run sql with run_sql with the error allowed parameter set to 'default')
447  }
448 
449  // Permissions
450  $this->remove($options);
451 
452  //ODT template
453  $src = DOL_DOCUMENT_ROOT.'/install/doctemplates/stocks/template_warehouse.odt';
454  $dirodt = DOL_DATA_ROOT.'/doctemplates/stocks';
455  $dest = $dirodt.'/template_warehouse.odt';
456 
457  if (file_exists($src) && !file_exists($dest)) {
458  require_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
459  dol_mkdir($dirodt);
460  $result = dol_copy($src, $dest, 0, 0);
461  if ($result < 0) {
462  $langs->load("errors");
463  $this->error = $langs->trans('ErrorFailToCopyFile', $src, $dest);
464  return 0;
465  }
466  }
467 
468  $sql = array();
469 
470  $sql = array(
471  "DELETE FROM ".MAIN_DB_PREFIX."document_model WHERE nom = '".$this->db->escape($this->const[1][2])."' AND type = 'stock' AND entity = ".((int) $conf->entity),
472  "INSERT INTO ".MAIN_DB_PREFIX."document_model (nom, type, entity) VALUES('".$this->db->escape($this->const[1][2])."','stock',".((int) $conf->entity).")",
473  "DELETE FROM ".MAIN_DB_PREFIX."document_model WHERE nom = '".$this->db->escape($this->const[2][2])."' AND type = 'mouvement' AND entity = ".((int) $conf->entity),
474  "INSERT INTO ".MAIN_DB_PREFIX."document_model (nom, type, entity) VALUES('".$this->db->escape($this->const[2][2])."','mouvement',".((int) $conf->entity).")",
475  );
476 
477  return $this->_init($sql, $options);
478  }
479 }
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
modStock\__construct
__construct($db)
Constructor.
Definition: modStock.class.php:43
DolibarrModules\_load_tables
_load_tables($reldir, $onlywithsuffix='')
Create tables and keys required by module:
Definition: DolibarrModules.class.php:1084
name
$conf db name
Definition: repair.php:122
dol_copy
dol_copy($srcfile, $destfile, $newmask=0, $overwriteifexists=1)
Copy a file to another file.
Definition: files.lib.php:713
DolibarrModules\_init
_init($array_sql, $options='')
Enables a module.
Definition: DolibarrModules.class.php:397
isModEnabled
isModEnabled($module)
Is Dolibarr module enabled.
Definition: functions.lib.php:137
modStock
Class to describe and enable module Stock.
Definition: modStock.class.php:36
modStock\init
init($options='')
Function called when module is enabled.
Definition: modStock.class.php:440
dol_mkdir
dol_mkdir($dir, $dataroot='', $newmask='')
Creation of a directory (this can create recursive subdir)
Definition: functions.lib.php:6789
DolibarrModules
Class DolibarrModules.
Definition: DolibarrModules.class.php:37