dolibarr  9.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 <http://www.gnu.org/licenses/>.
20  */
21 
30 include_once DOL_DOCUMENT_ROOT .'/core/modules/DolibarrModules.class.php';
31 
32 
37 {
38 
44  function __construct($db)
45  {
46  global $conf, $user;
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 = "sending";
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/shipment",
70  "/doctemplates/delivery"
71  );
72 
73  // Config pages
74  $this->config_page_url = array("confexped.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] = "rouget";
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/shipment";
103  $this->const[$r][3] = "";
104  $this->const[$r][4] = 0;
105  $r++;
106 
107  $this->const[$r][0] = "LIVRAISON_ADDON_PDF";
108  $this->const[$r][1] = "chaine";
109  $this->const[$r][2] = "typhon";
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] = "LIVRAISON_ADDON_NUMBER";
115  $this->const[$r][1] = "chaine";
116  $this->const[$r][2] = "mod_livraison_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] = "LIVRAISON_ADDON_PDF_ODT_PATH";
122  $this->const[$r][1] = "chaine";
123  $this->const[$r][2] = "DOL_DATA_ROOT/doctemplates/delivery";
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 shipments";
132  $this->const[$r][4] = 0;
133  $r++;
134 
135  // Boxes
136  $this->boxes = array();
137 
138  // Permissions
139  $this->rights = array();
140  $this->rights_class = 'expedition';
141  $r=0;
142 
143  $r++;
144  $this->rights[$r][0] = 101;
145  $this->rights[$r][1] = 'Lire les expeditions';
146  $this->rights[$r][2] = 'r';
147  $this->rights[$r][3] = 0;
148  $this->rights[$r][4] = 'lire';
149 
150  $r++;
151  $this->rights[$r][0] = 102;
152  $this->rights[$r][1] = 'Creer modifier les expeditions';
153  $this->rights[$r][2] = 'w';
154  $this->rights[$r][3] = 0;
155  $this->rights[$r][4] = 'creer';
156 
157  $r++;
158  $this->rights[$r][0] = 104;
159  $this->rights[$r][1] = 'Valider les expeditions';
160  $this->rights[$r][2] = 'd';
161  $this->rights[$r][3] = 0;
162  $this->rights[$r][4] = 'shipping_advance';
163  $this->rights[$r][5] = 'validate';
164 
165  $r++;
166  $this->rights[$r][0] = 105; // id de la permission
167  $this->rights[$r][1] = 'Envoyer les expeditions aux clients'; // libelle de la permission
168  $this->rights[$r][2] = 'd'; // type de la permission (deprecie a ce jour)
169  $this->rights[$r][3] = 0; // La permission est-elle une permission par defaut
170  $this->rights[$r][4] = 'shipping_advance';
171  $this->rights[$r][5] = 'send';
172 
173  $r++;
174  $this->rights[$r][0] = 106;
175  $this->rights[$r][1] = 'Exporter les expeditions';
176  $this->rights[$r][2] = 'r';
177  $this->rights[$r][3] = 0;
178  $this->rights[$r][4] = 'shipment';
179  $this->rights[$r][5] = 'export';
180 
181  $r++;
182  $this->rights[$r][0] = 109;
183  $this->rights[$r][1] = 'Supprimer les expeditions';
184  $this->rights[$r][2] = 'd';
185  $this->rights[$r][3] = 0;
186  $this->rights[$r][4] = 'supprimer';
187 
188  $r++;
189  $this->rights[$r][0] = 1101;
190  $this->rights[$r][1] = 'Lire les bons de livraison';
191  $this->rights[$r][2] = 'r';
192  $this->rights[$r][3] = 0;
193  $this->rights[$r][4] = 'livraison';
194  $this->rights[$r][5] = 'lire';
195 
196  $r++;
197  $this->rights[$r][0] = 1102;
198  $this->rights[$r][1] = 'Creer modifier les bons de livraison';
199  $this->rights[$r][2] = 'w';
200  $this->rights[$r][3] = 0;
201  $this->rights[$r][4] = 'livraison';
202  $this->rights[$r][5] = 'creer';
203 
204  $r++;
205  $this->rights[$r][0] = 1104;
206  $this->rights[$r][1] = 'Valider les bons de livraison';
207  $this->rights[$r][2] = 'd';
208  $this->rights[$r][3] = 0;
209  $this->rights[$r][4] = 'livraison_advance';
210  $this->rights[$r][5] = 'validate';
211 
212  $r++;
213  $this->rights[$r][0] = 1109;
214  $this->rights[$r][1] = 'Supprimer les bons de livraison';
215  $this->rights[$r][2] = 'd';
216  $this->rights[$r][3] = 0;
217  $this->rights[$r][4] = 'livraison';
218  $this->rights[$r][5] = 'supprimer';
219 
220 
221  // Menus
222  //-------
223  $this->menu = 1; // This module add menu entries. They are coded into menu manager.
224 
225 
226  // Exports
227  //--------
228  $r=0;
229 
230  include_once DOL_DOCUMENT_ROOT.'/commande/class/commande.class.php';
231  $shipment=new Commande($this->db);
232  $contact_arrays=$shipment->liste_type_contact('external','',0,0,'');
233  if (is_array($contact_arrays) && count($contact_arrays)>0){
234  $idcontacts=join(',',array_keys($shipment->liste_type_contact('external','',0,0,'')));
235  } else {
236  $idcontacts=0;
237  }
238 
239 
240  $r++;
241  $this->export_code[$r]=$this->rights_class.'_'.$r;
242  $this->export_label[$r]='Shipments'; // Translation key (used only if key ExportDataset_xxx_z not found)
243  $this->export_permission[$r]=array(array("expedition","shipment","export"));
244  $this->export_fields_array[$r]=array(
245  's.rowid'=>"IdCompany",'s.nom'=>'ThirdParty','s.address'=>'Address','s.zip'=>'Zip','s.town'=>'Town','d.nom'=>'State','co.label'=>'Country',
246  'co.code'=>'CountryCode','s.phone'=>'Phone','s.siren'=>'ProfId1','s.siret'=>'ProfId2','s.ape'=>'ProfId3','s.idprof4'=>'ProfId4','s.idprof5'=>'ProfId5',
247  's.idprof6'=>'ProfId6','c.rowid'=>"Id",'c.ref'=>"Ref",'c.ref_customer'=>"RefCustomer",'c.fk_soc'=>"IdCompany",'c.date_creation'=>"DateCreation",
248  'c.date_delivery'=>"DateDeliveryPlanned",'c.tracking_number'=>"TrackingNumber",'c.height'=>"Height",'c.width'=>"Width",'c.size'=>"Depth",
249  'c.size_units'=>'SizeUnits','c.weight'=>"Weight",'c.weight_units'=>"WeightUnits",'c.fk_statut'=>'Status','c.note_public'=>"NotePublic",
250  'ed.rowid'=>'LineId','cd.description'=>'Description','ed.qty'=>"Qty",'p.rowid'=>'ProductId','p.ref'=>'ProductRef','p.label'=>'ProductLabel',
251  'p.weight'=>'ProductWeight','p.weight_units'=>'WeightUnits','p.volume'=>'ProductVolume','p.volume_units'=>'VolumeUnits'
252  );
253  if ($idcontacts && ! empty($conf->global->SHIPMENT_ADD_CONTACTS_IN_EXPORT)) $this->export_fields_array[$r]+=array('sp.rowid'=>'IdContact','sp.lastname'=>'Lastname','sp.firstname'=>'Firstname','sp.note_public'=>'NotePublic');
254  //$this->export_TypeFields_array[$r]=array(
255  // 's.rowid'=>"List:societe:nom",'s.nom'=>'Text','s.address'=>'Text','s.zip'=>'Text','s.town'=>'Text','co.label'=>'List:c_country:label:label',
256  // '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",
257  // 'c.date_creation'=>"Date",'c.date_commande'=>"Date",'c.amount_ht'=>"Numeric",'c.remise_percent'=>"Numeric",'c.total_ht'=>"Numeric",
258  // 'c.total_ttc'=>"Numeric",'c.facture'=>"Boolean",'c.fk_statut'=>'Status','c.note_public'=>"Text",'c.date_livraison'=>'Date','ed.qty'=>"Text"
259  //);
260  $this->export_TypeFields_array[$r]=array(
261  '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',
262  's.siren'=>'Text','s.siret'=>'Text','s.ape'=>'Text','s.idprof4'=>'Text','c.ref'=>"Text",'c.ref_customer'=>"Text",'c.date_creation'=>"Date",
263  'c.date_delivery'=>"Date",'c.tracking_number'=>"Numeric",'c.height'=>"Numeric",'c.width'=>"Numeric",'c.weight'=>"Numeric",'c.fk_statut'=>'Status',
264  'c.note_public'=>"Text",'ed.qty'=>"Numeric",'d.nom'=>'Text'
265  );
266  $this->export_entities_array[$r]=array(
267  's.rowid'=>"company",'s.nom'=>'company','s.address'=>'company','s.zip'=>'company','s.town'=>'company','d.nom'=>'company','co.label'=>'company',
268  'co.code'=>'company','s.fk_pays'=>'company','s.phone'=>'company','s.siren'=>'company','s.ape'=>'company','s.siret'=>'company','s.idprof4'=>'company',
269  's.idprof5'=>'company','s.idprof6'=>'company','c.rowid'=>"shipment",'c.ref'=>"shipment",'c.ref_customer'=>"shipment",'c.fk_soc'=>"shipment",
270  'c.date_creation'=>"shipment",'c.date_delivery'=>"shipment",'c.tracking_number'=>'shipment','c.height'=>"shipment",'c.width'=>"shipment",
271  'c.size'=>'shipment','c.size_units'=>'shipment','c.weight'=>"shipment",'c.weight_units'=>'shipment','c.fk_statut'=>"shipment",'c.note_public'=>"shipment",
272  'ed.rowid'=>'shipment_line','cd.description'=>'shipment_line','ed.qty'=>"shipment_line",'p.rowid'=>'product','p.ref'=>'product','p.label'=>'product',
273  'p.weight'=>'product','p.weight_units'=>'product','p.volume'=>'product','p.volume_units'=>'product'
274  );
275  if ($idcontacts && ! empty($conf->global->SHIPMENT_ADD_CONTACTS_IN_EXPORT)) $this->export_entities_array[$r]+=array('sp.rowid'=>'contact','sp.lastname'=>'contact','sp.firstname'=>'contact','sp.note_public'=>'contact');
276  $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
277  if ($idcontacts && ! empty($conf->global->SHIPMENT_ADD_CONTACTS_IN_EXPORT))
278  {
279  $keyforselect='socpeople'; $keyforelement='contact'; $keyforaliasextra='extra3';
280  include DOL_DOCUMENT_ROOT.'/core/extrafieldsinexport.inc.php';
281  }
282  $keyforselect='expedition'; $keyforelement='shipment'; $keyforaliasextra='extra';
283  include DOL_DOCUMENT_ROOT.'/core/extrafieldsinexport.inc.php';
284  $keyforselect='expeditiondet'; $keyforelement='shipment_line'; $keyforaliasextra='extra2';
285  include DOL_DOCUMENT_ROOT.'/core/extrafieldsinexport.inc.php';
286 
287  $this->export_sql_start[$r]='SELECT DISTINCT ';
288  $this->export_sql_end[$r] =' FROM '.MAIN_DB_PREFIX.'expedition as c';
289  $this->export_sql_end[$r] .=' LEFT JOIN '.MAIN_DB_PREFIX.'expedition_extrafields as extra ON c.rowid = extra.fk_object,';
290  $this->export_sql_end[$r] .=' '.MAIN_DB_PREFIX.'societe as s';
291  if(!$user->rights->societe->client->voir) $this->export_sql_end[$r] .=' LEFT JOIN '.MAIN_DB_PREFIX.'societe_commerciaux as sc ON sc.fk_soc = s.rowid';
292  $this->export_sql_end[$r] .=' LEFT JOIN '.MAIN_DB_PREFIX.'c_departements as d ON s.fk_departement = d.rowid';
293  $this->export_sql_end[$r] .=' LEFT JOIN '.MAIN_DB_PREFIX.'c_country as co ON s.fk_pays = co.rowid,';
294  $this->export_sql_end[$r] .=' '.MAIN_DB_PREFIX.'expeditiondet as ed';
295  $this->export_sql_end[$r] .=' LEFT JOIN '.MAIN_DB_PREFIX.'expeditiondet_extrafields as extra2 ON ed.rowid = extra2.fk_object';
296  $this->export_sql_end[$r] .=' , '.MAIN_DB_PREFIX.'commandedet as cd';
297  $this->export_sql_end[$r] .=' LEFT JOIN '.MAIN_DB_PREFIX.'product as p on cd.fk_product = p.rowid';
298  if ($idcontacts && ! empty($conf->global->SHIPMENT_ADD_CONTACTS_IN_EXPORT))
299  {
300  $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 ('.$idcontacts.')';
301  $this->export_sql_end[$r] .=' LEFT JOIN '.MAIN_DB_PREFIX.'socpeople as sp ON sp.rowid = ee.fk_socpeople';
302  $this->export_sql_end[$r] .=' LEFT JOIN '.MAIN_DB_PREFIX.'socpeople_extrafields as extra3 ON sp.rowid = extra3.fk_object';
303  }
304  $this->export_sql_end[$r] .=' WHERE c.fk_soc = s.rowid AND c.rowid = ed.fk_expedition AND ed.fk_origin_line = cd.rowid';
305  $this->export_sql_end[$r] .=' AND c.entity IN ('.getEntity('expedition').')';
306  if(!$user->rights->societe->client->voir) $this->export_sql_end[$r] .=' AND sc.fk_user = '.$user->id;
307  }
308 
309 
318  function init($options='')
319  {
320  global $conf,$langs;
321 
322  // Permissions
323  $this->remove($options);
324 
325  //ODT template
326  $src=DOL_DOCUMENT_ROOT.'/install/doctemplates/shipment/template_shipment.odt';
327  $dirodt=DOL_DATA_ROOT.'/doctemplates/shipment';
328  $dest=$dirodt.'/template_shipment.odt';
329 
330  if (file_exists($src) && ! file_exists($dest))
331  {
332  require_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
333  dol_mkdir($dirodt);
334  $result=dol_copy($src,$dest,0,0);
335  if ($result < 0)
336  {
337  $langs->load("errors");
338  $this->error=$langs->trans('ErrorFailToCopyFile',$src,$dest);
339  return 0;
340  }
341  }
342 
343  $sql = array();
344 
345  $sql = array(
346  "DELETE FROM ".MAIN_DB_PREFIX."document_model WHERE nom = '".$this->db->escape($this->const[0][2])."' AND type = 'shipping' AND entity = ".$conf->entity,
347  "INSERT INTO ".MAIN_DB_PREFIX."document_model (nom, type, entity) VALUES('".$this->db->escape($this->const[0][2])."','shipping',".$conf->entity.")",
348  "DELETE FROM ".MAIN_DB_PREFIX."document_model WHERE nom = '".$this->db->escape($this->const[3][2])."' AND type = 'delivery' AND entity = ".$conf->entity,
349  "INSERT INTO ".MAIN_DB_PREFIX."document_model (nom, type, entity) VALUES('".$this->db->escape($this->const[3][2])."','delivery',".$conf->entity.")",
350  );
351 
352  return $this->_init($sql,$options);
353  }
354 }
dol_copy($srcfile, $destfile, $newmask=0, $overwriteifexists=1)
Copy a file to another file.
Definition: files.lib.php:666
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
init($options='')
Function called when module is enabled.
$conf db name
Only used if Module[ID]Name translation string is not found.
Definition: repair.php:103
Class to manage customers orders.
Class to describe and enable module Expedition.
_init($array_sql, $options='')
Enables a module.
dol_mkdir($dir, $dataroot='', $newmask=null)
Creation of a directory (this can create recursive subdir)
__construct($db)
Constructor.