dolibarr 20.0.0
modExpedition.class.php
Go to the documentation of this file.
1<?php
2/* Copyright (C) 2003-2005 Rodolphe Quiedeville <rodolphe@quiedeville.org>
3 * Copyright (C) 2004-2016 Laurent Destailleur <eldy@users.sourceforge.net>
4 * Copyright (C) 2005-2011 Regis Houssin <regis.houssin@inodbox.com>
5 * Copyright (C) 2011 Juanjo Menent <jmenent@2byte.es>
6 * Copyright (C) 2013 Philippe Grand <philippe.grand@atoo-net.com>
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
31include_once DOL_DOCUMENT_ROOT.'/core/modules/DolibarrModules.class.php';
32
33
38{
44 public function __construct($db)
45 {
46 global $conf, $user; // $conf is required by /core/extrafieldsinexport.inc.php
47
48 $this->db = $db;
49 $this->numero = 80;
50
51 $this->family = "crm";
52 $this->module_position = '40';
53 // Module label (no space allowed), used if translation string 'ModuleXXXName' not found (where XXX is value of numeric property 'numero' of module)
54 $this->name = preg_replace('/^mod/i', '', get_class($this));
55 $this->description = "Gestion des expeditions";
56
57 // Possible values for version are: 'development', 'experimental', 'dolibarr' or version
58 $this->version = 'dolibarr';
59
60 $this->const_name = 'MAIN_MODULE_'.strtoupper($this->name);
61 $this->picto = "dolly";
62
63 // Data directories to create when module is enabled
64 $this->dirs = array("/expedition/temp",
65 "/expedition/sending",
66 "/expedition/sending/temp",
67 "/expedition/receipt",
68 "/expedition/receipt/temp",
69 "/doctemplates/shipments",
70 "/doctemplates/deliveries"
71 );
72
73 // Config pages
74 $this->config_page_url = array("expedition.php");
75
76 // Dependencies
77 $this->depends = array("modCommande");
78 $this->requiredby = array();
79 $this->conflictwith = array();
80 $this->langfiles = array('deliveries', 'sendings');
81
82 // Constants
83 $this->const = array();
84 $r = 0;
85
86 $this->const[$r][0] = "EXPEDITION_ADDON_PDF";
87 $this->const[$r][1] = "chaine";
88 $this->const[$r][2] = "espadon";
89 $this->const[$r][3] = 'Nom du gestionnaire de generation des bons expeditions en PDF';
90 $this->const[$r][4] = 0;
91 $r++;
92
93 $this->const[$r][0] = "EXPEDITION_ADDON_NUMBER";
94 $this->const[$r][1] = "chaine";
95 $this->const[$r][2] = "mod_expedition_safor";
96 $this->const[$r][3] = 'Name for numbering manager for shipments';
97 $this->const[$r][4] = 0;
98 $r++;
99
100 $this->const[$r][0] = "EXPEDITION_ADDON_PDF_ODT_PATH";
101 $this->const[$r][1] = "chaine";
102 $this->const[$r][2] = "DOL_DATA_ROOT/doctemplates/shipments";
103 $this->const[$r][3] = "";
104 $this->const[$r][4] = 0;
105 $r++;
106
107 $this->const[$r][0] = "DELIVERY_ADDON_PDF";
108 $this->const[$r][1] = "chaine";
109 $this->const[$r][2] = "storm";
110 $this->const[$r][3] = 'Nom du gestionnaire de generation des bons de reception en PDF';
111 $this->const[$r][4] = 0;
112 $r++;
113
114 $this->const[$r][0] = "DELIVERY_ADDON_NUMBER";
115 $this->const[$r][1] = "chaine";
116 $this->const[$r][2] = "mod_delivery_jade";
117 $this->const[$r][3] = 'Nom du gestionnaire de numerotation des bons de reception';
118 $this->const[$r][4] = 0;
119 $r++;
120
121 $this->const[$r][0] = "DELIVERY_ADDON_PDF_ODT_PATH";
122 $this->const[$r][1] = "chaine";
123 $this->const[$r][2] = "DOL_DATA_ROOT/doctemplates/deliveries";
124 $this->const[$r][3] = "";
125 $this->const[$r][4] = 0;
126 $r++;
127
128 $this->const[$r][0] = "MAIN_SUBMODULE_EXPEDITION";
129 $this->const[$r][1] = "chaine";
130 $this->const[$r][2] = "1";
131 $this->const[$r][3] = "Enable delivery receipts";
132 $this->const[$r][4] = 0;
133 $r++;
134
135 // Boxes
136 $this->boxes = array(
137 0=>array('file'=>'box_shipments.php', 'enabledbydefaulton'=>'Home'),
138 );
139
140 // Permissions
141 $this->rights = array();
142 $this->rights_class = 'expedition';
143 $r = 0;
144
145 $r++;
146 $this->rights[$r][0] = 101;
147 $this->rights[$r][1] = 'Read shipments';
148 $this->rights[$r][2] = 'r';
149 $this->rights[$r][3] = 0;
150 $this->rights[$r][4] = 'lire';
151
152 $r++;
153 $this->rights[$r][0] = 102;
154 $this->rights[$r][1] = 'Create/modify shipments';
155 $this->rights[$r][2] = 'w';
156 $this->rights[$r][3] = 0;
157 $this->rights[$r][4] = 'creer';
158
159 $r++;
160 $this->rights[$r][0] = 104;
161 $this->rights[$r][1] = 'Validate shipments';
162 $this->rights[$r][2] = 'd';
163 $this->rights[$r][3] = 0;
164 $this->rights[$r][4] = 'shipping_advance';
165 $this->rights[$r][5] = 'validate';
166
167 $r++;
168 $this->rights[$r][0] = 105; // id de la permission
169 $this->rights[$r][1] = 'Send shipments by email to customers'; // libelle de la permission
170 $this->rights[$r][2] = 'd'; // type de la permission (deprecated)
171 $this->rights[$r][3] = 0; // La permission est-elle une permission par default
172 $this->rights[$r][4] = 'shipping_advance';
173 $this->rights[$r][5] = 'send';
174
175 $r++;
176 $this->rights[$r][0] = 106;
177 $this->rights[$r][1] = 'Export shipments';
178 $this->rights[$r][2] = 'r';
179 $this->rights[$r][3] = 0;
180 $this->rights[$r][4] = 'shipment';
181 $this->rights[$r][5] = 'export';
182
183 $r++;
184 $this->rights[$r][0] = 109;
185 $this->rights[$r][1] = 'Delete shipments';
186 $this->rights[$r][2] = 'd';
187 $this->rights[$r][3] = 0;
188 $this->rights[$r][4] = 'supprimer';
189
190 $r++;
191 $this->rights[$r][0] = 1101;
192 $this->rights[$r][1] = 'Read delivery receipts';
193 $this->rights[$r][2] = 'r';
194 $this->rights[$r][3] = 0;
195 $this->rights[$r][4] = 'delivery';
196 $this->rights[$r][5] = 'lire';
197
198 $r++;
199 $this->rights[$r][0] = 1102;
200 $this->rights[$r][1] = 'Create/modify delivery receipts';
201 $this->rights[$r][2] = 'w';
202 $this->rights[$r][3] = 0;
203 $this->rights[$r][4] = 'delivery';
204 $this->rights[$r][5] = 'creer';
205
206 $r++;
207 $this->rights[$r][0] = 1104;
208 $this->rights[$r][1] = 'Validate delivery receipts';
209 $this->rights[$r][2] = 'd';
210 $this->rights[$r][3] = 0;
211 $this->rights[$r][4] = 'delivery_advance';
212 $this->rights[$r][5] = 'validate';
213
214 $r++;
215 $this->rights[$r][0] = 1109;
216 $this->rights[$r][1] = 'Delete delivery receipts';
217 $this->rights[$r][2] = 'd';
218 $this->rights[$r][3] = 0;
219 $this->rights[$r][4] = 'delivery';
220 $this->rights[$r][5] = 'supprimer';
221
222
223 // Menus
224 //-------
225 $this->menu = 1; // This module add menu entries. They are coded into menu manager.
226
227
228 // Exports
229 //--------
230 $r = 0;
231
232 include_once DOL_DOCUMENT_ROOT.'/commande/class/commande.class.php';
233 $shipment = new Commande($this->db);
234 $contact_arrays = $shipment->liste_type_contact('external', '', 0, 0, '');
235 if (is_array($contact_arrays) && count($contact_arrays) > 0) {
236 $idcontacts = implode(',', array_keys($shipment->liste_type_contact('external', '', 0, 0, '')));
237 } else {
238 $idcontacts = 0;
239 }
240
241
242 $r++;
243 $this->export_code[$r] = $this->rights_class.'_'.$r;
244 $this->export_label[$r] = 'Shipments'; // Translation key (used only if key ExportDataset_xxx_z not found)
245 $this->export_permission[$r] = array(array("expedition", "shipment", "export"));
246 $this->export_fields_array[$r] = array(
247 's.rowid'=>"IdCompany", 's.nom'=>'ThirdParty', 's.address'=>'Address', 's.zip'=>'Zip', 's.town'=>'Town', 'd.nom'=>'State', 'co.label'=>'Country',
248 'co.code'=>'CountryCode', 's.phone'=>'Phone', 's.siren'=>'ProfId1', 's.siret'=>'ProfId2', 's.ape'=>'ProfId3', 's.idprof4'=>'ProfId4', 's.idprof5'=>'ProfId5',
249 's.idprof6'=>'ProfId6', 'c.rowid'=>"Id", 'c.ref'=>"Ref", 'c.ref_customer'=>"RefCustomer", 'c.fk_soc'=>"IdCompany", 'c.date_creation'=>"DateCreation", 'c.date_valid'=>"DateValidation",
250 'c.date_delivery'=>"DateDeliveryPlanned", 'c.tracking_number'=>"TrackingNumber", 'c.height'=>"Height", 'c.width'=>"Width", 'c.size'=>"Depth",
251 'c.size_units'=>'SizeUnits', 'c.weight'=>"Weight", 'c.weight_units'=>"WeightUnits", 'c.fk_statut'=>'Status', 'c.note_public'=>"NotePublic",
252 'ed.rowid'=>'LineId', 'cd.description'=>'Description', 'ed.qty'=>"Qty", 'p.rowid'=>'ProductId', 'p.ref'=>'ProductRef', 'p.label'=>'ProductLabel',
253 'p.weight'=>'ProductWeight', 'p.weight_units'=>'WeightUnits', 'p.volume'=>'ProductVolume', 'p.volume_units'=>'VolumeUnits'
254 );
255 if ($idcontacts && getDolGlobalString('SHIPMENT_ADD_CONTACTS_IN_EXPORT')) {
256 $this->export_fields_array[$r] += array('sp.rowid'=>'IdContact', 'sp.lastname'=>'Lastname', 'sp.firstname'=>'Firstname', 'sp.note_public'=>'NotePublic');
257 }
258 //$this->export_TypeFields_array[$r]=array(
259 // 's.rowid'=>"Numeric",'s.nom'=>'Text','s.address'=>'Text','s.zip'=>'Text','s.town'=>'Text','co.label'=>'List:c_country:label:label',
260 // 'co.code'=>'Text','s.phone'=>'Text','s.siren'=>'Text','s.siret'=>'Text','s.ape'=>'Text','s.idprof4'=>'Text','c.ref'=>"Text",'c.ref_client'=>"Text",
261 // 'c.date_creation'=>"Date",'c.date_commande'=>"Date",'c.amount_ht'=>"Numeric",'c.remise_percent'=>"Numeric",'c.total_ht'=>"Numeric",
262 // 'c.total_ttc'=>"Numeric",'c.facture'=>"Boolean",'c.fk_statut'=>'Status','c.note_public'=>"Text",'c.date_livraison'=>'Date','ed.qty'=>"Text"
263 //);
264 $this->export_TypeFields_array[$r] = array(
265 's.nom'=>'Text', 's.address'=>'Text', 's.zip'=>'Text', 's.town'=>'Text', 'co.label'=>'List:c_country:label:label', 'co.code'=>'Text', 's.phone'=>'Text',
266 's.siren'=>'Text', 's.siret'=>'Text', 's.ape'=>'Text', 's.idprof4'=>'Text', 'c.ref'=>"Text", 'c.ref_customer'=>"Text", 'c.date_creation'=>"Date", 'c.date_valid'=>"Date",
267 'c.date_delivery'=>"Date", 'c.tracking_number'=>"Numeric", 'c.height'=>"Numeric", 'c.width'=>"Numeric", 'c.weight'=>"Numeric", 'c.fk_statut'=>'Status',
268 'c.note_public'=>"Text", 'ed.qty'=>"Numeric", 'd.nom'=>'Text'
269 );
270 $this->export_entities_array[$r] = array(
271 's.rowid'=>"company", 's.nom'=>'company', 's.address'=>'company', 's.zip'=>'company', 's.town'=>'company', 'd.nom'=>'company', 'co.label'=>'company',
272 'co.code'=>'company', 's.fk_pays'=>'company', 's.phone'=>'company', 's.siren'=>'company', 's.ape'=>'company', 's.siret'=>'company', 's.idprof4'=>'company',
273 's.idprof5'=>'company', 's.idprof6'=>'company', 'c.rowid'=>"shipment", 'c.ref'=>"shipment", 'c.ref_customer'=>"shipment", 'c.fk_soc'=>"shipment",
274 'c.date_creation'=>"shipment", 'c.date_valid'=>"shipment", 'c.date_delivery'=>"shipment", 'c.tracking_number'=>'shipment', 'c.height'=>"shipment", 'c.width'=>"shipment",
275 'c.size'=>'shipment', 'c.size_units'=>'shipment', 'c.weight'=>"shipment", 'c.weight_units'=>'shipment', 'c.fk_statut'=>"shipment", 'c.note_public'=>"shipment",
276 'ed.rowid'=>'shipment_line', 'cd.description'=>'shipment_line', 'ed.qty'=>"shipment_line", 'p.rowid'=>'product', 'p.ref'=>'product', 'p.label'=>'product',
277 'p.weight'=>'product', 'p.weight_units'=>'product', 'p.volume'=>'product', 'p.volume_units'=>'product'
278 );
279 if ($idcontacts && getDolGlobalString('SHIPMENT_ADD_CONTACTS_IN_EXPORT')) {
280 $this->export_entities_array[$r] += array('sp.rowid'=>'contact', 'sp.lastname'=>'contact', 'sp.firstname'=>'contact', 'sp.note_public'=>'contact');
281 }
282 $this->export_dependencies_array[$r] = array('shipment_line'=>'ed.rowid', 'product'=>'ed.rowid'); // To add unique key if we ask a field of a child to avoid the DISTINCT to discard them
283 if ($idcontacts && getDolGlobalString('SHIPMENT_ADD_CONTACTS_IN_EXPORT')) {
284 $keyforselect = 'socpeople';
285 $keyforelement = 'contact';
286 $keyforaliasextra = 'extra3';
287 include DOL_DOCUMENT_ROOT.'/core/extrafieldsinexport.inc.php';
288 }
289 $keyforselect = 'expedition';
290 $keyforelement = 'shipment';
291 $keyforaliasextra = 'extra';
292 include DOL_DOCUMENT_ROOT.'/core/extrafieldsinexport.inc.php';
293 $keyforselect = 'expeditiondet';
294 $keyforelement = 'shipment_line';
295 $keyforaliasextra = 'extra2';
296 include DOL_DOCUMENT_ROOT.'/core/extrafieldsinexport.inc.php';
297 $keyforselect = 'product';
298 $keyforelement = 'product';
299 $keyforaliasextra = 'extraprod';
300 include DOL_DOCUMENT_ROOT.'/core/extrafieldsinexport.inc.php';
301
302 $this->export_sql_start[$r] = 'SELECT DISTINCT ';
303 $this->export_sql_end[$r] = ' FROM '.MAIN_DB_PREFIX.'expedition as c';
304 $this->export_sql_end[$r] .= ' LEFT JOIN '.MAIN_DB_PREFIX.'expedition_extrafields as extra ON c.rowid = extra.fk_object,';
305 $this->export_sql_end[$r] .= ' '.MAIN_DB_PREFIX.'societe as s';
306 if (!empty($user) && !$user->hasRight('societe', 'client', 'voir')) {
307 $this->export_sql_end[$r] .= ' LEFT JOIN '.MAIN_DB_PREFIX.'societe_commerciaux as sc ON sc.fk_soc = s.rowid';
308 }
309 $this->export_sql_end[$r] .= ' LEFT JOIN '.MAIN_DB_PREFIX.'c_departements as d ON s.fk_departement = d.rowid';
310 $this->export_sql_end[$r] .= ' LEFT JOIN '.MAIN_DB_PREFIX.'c_country as co ON s.fk_pays = co.rowid,';
311 $this->export_sql_end[$r] .= ' '.MAIN_DB_PREFIX.'expeditiondet as ed';
312 $this->export_sql_end[$r] .= ' LEFT JOIN '.MAIN_DB_PREFIX.'expeditiondet_extrafields as extra2 ON ed.rowid = extra2.fk_object';
313 $this->export_sql_end[$r] .= ' , '.MAIN_DB_PREFIX.'commandedet as cd';
314 $this->export_sql_end[$r] .= ' LEFT JOIN '.MAIN_DB_PREFIX.'product as p on cd.fk_product = p.rowid';
315 $this->export_sql_end[$r] .= ' LEFT JOIN '.MAIN_DB_PREFIX.'product_extrafields as extraprod ON p.rowid = extraprod.fk_object';
316 if ($idcontacts && getDolGlobalString('SHIPMENT_ADD_CONTACTS_IN_EXPORT')) {
317 $this->export_sql_end[$r] .= ' LEFT JOIN '.MAIN_DB_PREFIX.'element_contact as ee ON ee.element_id = cd.fk_commande AND ee.fk_c_type_contact IN ('.$this->db->sanitize($idcontacts).')';
318 $this->export_sql_end[$r] .= ' LEFT JOIN '.MAIN_DB_PREFIX.'socpeople as sp ON sp.rowid = ee.fk_socpeople';
319 $this->export_sql_end[$r] .= ' LEFT JOIN '.MAIN_DB_PREFIX.'socpeople_extrafields as extra3 ON sp.rowid = extra3.fk_object';
320 }
321 $this->export_sql_end[$r] .= ' WHERE c.fk_soc = s.rowid AND c.rowid = ed.fk_expedition AND ed.fk_elementdet = cd.rowid';
322 $this->export_sql_end[$r] .= ' AND c.entity IN ('.getEntity('expedition').')';
323 if (!empty($user) && !$user->hasRight('societe', 'client', 'voir')) {
324 $this->export_sql_end[$r] .= ' AND sc.fk_user = '.(empty($user) ? 0 : $user->id);
325 }
326 }
327
328
337 public function init($options = '')
338 {
339 global $conf, $langs;
340
341 // Permissions
342 $this->remove($options);
343
344 //ODT template
345 $src = DOL_DOCUMENT_ROOT.'/install/doctemplates/shipments/template_shipment.odt';
346 $dirodt = DOL_DATA_ROOT.'/doctemplates/shipments';
347 $dest = $dirodt.'/template_shipment.odt';
348
349 if (file_exists($src) && !file_exists($dest)) {
350 require_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
351 dol_mkdir($dirodt);
352 $result = dol_copy($src, $dest, 0, 0);
353 if ($result < 0) {
354 $langs->load("errors");
355 $this->error = $langs->trans('ErrorFailToCopyFile', $src, $dest);
356 return 0;
357 }
358 }
359
360 $sql = array(
361 "DELETE FROM ".MAIN_DB_PREFIX."document_model WHERE nom = '".$this->db->escape($this->const[0][2])."' AND type = 'shipping' AND entity = ".((int) $conf->entity),
362 "INSERT INTO ".MAIN_DB_PREFIX."document_model (nom, type, entity) VALUES('".$this->db->escape($this->const[0][2])."', 'shipping', ".((int) $conf->entity).")",
363 "DELETE FROM ".MAIN_DB_PREFIX."document_model WHERE nom = '".$this->db->escape($this->const[3][2])."' AND type = 'delivery' AND entity = ".((int) $conf->entity),
364 "INSERT INTO ".MAIN_DB_PREFIX."document_model (nom, type, entity) VALUES('".$this->db->escape($this->const[3][2])."', 'delivery', ".((int) $conf->entity).")",
365 //"DELETE FROM ".MAIN_DB_PREFIX."const WHERE name IN ('STOCK_CALCULATE_ON_BILL', 'STOCK_CALCULATE_ON_VALIDATE_ORDER', 'STOCK_CALCULATE_ON_SHIPMENT', 'STOCK_CALCULATE_ON_SHIPMENT_CLOSE') AND entity = ".((int) $conf->entity),
366 //"INSERT INTO ".MAIN_DB_PREFIX."const (name, value, entity) VALUES ('STOCK_CALCULATE_ON_SHIPMENT_CLOSE', 1, ".((int) $conf->entity).")"
367 );
368
369 return $this->_init($sql, $options);
370 }
371}
Class to manage customers orders.
Class DolibarrModules.
_init($array_sql, $options='')
Enables a module.
Class to describe and enable module Expedition.
init($options='')
Function called when module is enabled.
__construct($db)
Constructor.
print $script_file $mode $langs defaultlang(is_numeric($duration_value) ? " delay=". $duration_value :"").(is_numeric($duration_value2) ? " after cd cd cd description as description
Only used if Module[ID]Desc translation string is not found.
dol_copy($srcfile, $destfile, $newmask='0', $overwriteifexists=1, $testvirus=0, $indexdatabase=0)
Copy a file to another file.
getDolGlobalString($key, $default='')
Return dolibarr global constant string value.
dol_mkdir($dir, $dataroot='', $newmask='')
Creation of a directory (this can create recursive subdir)
$conf db name
Only used if Module[ID]Name translation string is not found.
Definition repair.php:140