dolibarr  21.0.0-alpha
modReception.class.php
Go to the documentation of this file.
1 <?php
2 /* Copyright (C) 2018 Quentin Vial-Gouteyron <quentin.vial-gouteyron@atm-consulting.fr>
3  *
4  * This program is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License as published by
6  * the Free Software Foundation; either version 3 of the License, or
7  * (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program. If not, see <https://www.gnu.org/licenses/>.
16  */
17 
27 include_once DOL_DOCUMENT_ROOT.'/core/modules/DolibarrModules.class.php';
28 
29 
34 {
40  public function __construct($db)
41  {
42  global $conf, $user;
43 
44  $this->db = $db;
45  $this->numero = 94160;
46 
47  $this->family = "srm";
48  $this->module_position = '40';
49  // Module label (no space allowed), used if translation string 'ModuleXXXName' not found (where XXX is value of numeric property 'numero' of module)
50  $this->name = preg_replace('/^mod/i', '', get_class($this));
51  $this->description = "ReceptionDescription";
52 
53  // Possible values for version are: 'development', 'experimental', 'dolibarr' or version
54  $this->version = 'dolibarr';
55 
56  $this->const_name = 'MAIN_MODULE_'.strtoupper($this->name);
57  $this->picto = "dollyrevert";
58 
59  // Data directories to create when module is enabled
60  $this->dirs = array("/reception/receipt",
61  "/reception/receipt/temp",
62  "/doctemplates/receptions"
63  );
64 
65  // Config pages
66  $this->config_page_url = array("reception_setup.php");
67 
68  // Dependencies
69  $this->depends = array("modFournisseur");
70  $this->requiredby = array();
71  $this->conflictwith = array();
72  $this->langfiles = array('receptions');
73 
74  // Constants
75  $this->const = array();
76  $r = 0;
77 
78  $this->const[$r][0] = "RECEPTION_ADDON_PDF";
79  $this->const[$r][1] = "chaine";
80  $this->const[$r][2] = "squille";
81  $this->const[$r][3] = 'Nom du gestionnaire de generation des bons receptions en PDF';
82  $this->const[$r][4] = 0;
83  $r++;
84 
85  $this->const[$r][0] = "RECEPTION_ADDON_NUMBER";
86  $this->const[$r][1] = "chaine";
87  $this->const[$r][2] = "mod_reception_beryl";
88  $this->const[$r][3] = 'Name for numbering manager for receptions';
89  $this->const[$r][4] = 0;
90  $r++;
91 
92  $this->const[$r][0] = "RECEPTION_ADDON_PDF_ODT_PATH";
93  $this->const[$r][1] = "chaine";
94  $this->const[$r][2] = "DOL_DATA_ROOT/doctemplates/receptions";
95  $this->const[$r][3] = "";
96  $this->const[$r][4] = 0;
97  $r++;
98 
99  $this->const[$r][0] = "MAIN_SUBMODULE_RECEPTION";
100  $this->const[$r][1] = "chaine";
101  $this->const[$r][2] = "1";
102  $this->const[$r][3] = "Enable receptions";
103  $this->const[$r][4] = 0;
104  $r++;
105 
106  // Boxes
107  $this->boxes = array();
108 
109  // Permissions
110  $this->rights = array();
111  $this->rights_class = 'reception';
112  $r = 0;
113 
114  $r++;
115  $this->rights[$r][0] = $this->numero.$r;
116  $this->rights[$r][1] = 'Read receptions';
117  $this->rights[$r][2] = 'r';
118  $this->rights[$r][3] = 0;
119  $this->rights[$r][4] = 'lire';
120 
121  $r++;
122  $this->rights[$r][0] = $this->numero.$r;
123  $this->rights[$r][1] = 'Create receptions';
124  $this->rights[$r][2] = 'w';
125  $this->rights[$r][3] = 0;
126  $this->rights[$r][4] = 'creer';
127 
128  $r++;
129  $this->rights[$r][0] = $this->numero.$r;
130  $this->rights[$r][1] = 'Validate receptions';
131  $this->rights[$r][2] = 'd';
132  $this->rights[$r][3] = 0;
133  $this->rights[$r][4] = 'reception_advance';
134  $this->rights[$r][5] = 'validate';
135 
136  $r++;
137  $this->rights[$r][0] = $this->numero.$r; // id de la permission
138  $this->rights[$r][1] = 'Send receptions to customers'; // libelle de la permission
139  $this->rights[$r][2] = 'd'; // type de la permission (deprecated)
140  $this->rights[$r][3] = 0; // La permission est-elle une permission par default
141  $this->rights[$r][4] = 'reception_advance';
142  $this->rights[$r][5] = 'send';
143 
144  $r++;
145  $this->rights[$r][0] = $this->numero.$r;
146  $this->rights[$r][1] = 'Export receptions';
147  $this->rights[$r][2] = 'r';
148  $this->rights[$r][3] = 0;
149  $this->rights[$r][4] = 'reception';
150  $this->rights[$r][5] = 'export';
151 
152  $r++;
153  $this->rights[$r][0] = $this->numero.$r;
154  $this->rights[$r][1] = 'Delete receptions';
155  $this->rights[$r][2] = 'd';
156  $this->rights[$r][3] = 0;
157  $this->rights[$r][4] = 'supprimer';
158 
159 
160  // Menus
161  //-------
162  $this->menu = 1; // This module add menu entries. They are coded into menu manager.
163 
164 
165  // Exports
166  //--------
167  $r = 0;
168 
169  include_once DOL_DOCUMENT_ROOT.'/fourn/class/fournisseur.commande.class.php';
170  $shipment = new CommandeFournisseur($this->db);
171  $contact_arrays = $shipment->liste_type_contact('external', '', 0, 0, '');
172  if (is_array($contact_arrays) && count($contact_arrays) > 0) {
173  $idcontacts = implode(',', array_keys($shipment->liste_type_contact('external', '', 0, 0, '')));
174  } else {
175  $idcontacts = 0;
176  }
177 
178 
179  $r++;
180  $this->export_code[$r] = $this->rights_class.'_'.$r;
181  $this->export_label[$r] = 'Receptions'; // Translation key (used only if key ExportDataset_xxx_z not found)
182  $this->export_permission[$r] = array(array("reception", "reception", "export"));
183  $this->export_fields_array[$r] = array(
184  's.rowid'=>"IdCompany", 's.nom'=>'ThirdParty', 's.address'=>'Address', 's.zip'=>'Zip', 's.town'=>'Town',
185  'd.nom'=>'State', 'co.label'=>'Country', 'co.code'=>'CountryCode', 's.phone'=>'Phone', 's.siren'=>'ProfId1', 's.siret'=>'ProfId2', 's.ape'=>'ProfId3', 's.idprof4'=>'ProfId4', 's.idprof5'=>'ProfId5', 's.idprof6'=>'ProfId6',
186  'c.rowid'=>"Id", 'c.ref'=>"Ref", 'c.ref_supplier'=>"RefSupplier", 'c.fk_soc'=>"IdCompany", 'c.date_creation'=>"DateCreation", 'c.date_delivery'=>"DateDeliveryPlanned", 'c.tracking_number'=>"TrackingNumber", 'c.height'=>"Height", 'c.width'=>"Width", 'c.size'=>"Depth", 'c.size_units'=>'SizeUnits', 'c.weight'=>"Weight", 'c.weight_units'=>"WeightUnits", 'c.fk_statut'=>'Status', 'c.note_public'=>"NotePublic", 'ed.rowid'=>'LineId',
187  'ed.comment'=>'Description', 'ed.qty'=>"Qty",
188  'p.rowid'=>'ProductId', 'p.ref'=>'ProductRef', 'p.label'=>'ProductLabel', 'p.weight'=>'ProductWeight', 'p.weight_units'=>'WeightUnits', 'p.volume'=>'ProductVolume', 'p.volume_units'=>'VolumeUnits'
189  );
190  if ($idcontacts && getDolGlobalString('RECEPTION_ADD_CONTACTS_IN_EXPORT')) {
191  $this->export_fields_array[$r] += array('sp.rowid'=>'IdContact', 'sp.lastname'=>'Lastname', 'sp.firstname'=>'Firstname', 'sp.note_public'=>'NotePublic');
192  }
193  //$this->export_TypeFields_array[$r]=array('s.rowid'=>"Numeric",'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','s.siren'=>'Text','s.siret'=>'Text','s.ape'=>'Text','s.idprof4'=>'Text','c.ref'=>"Text",'c.ref_client'=>"Text",'c.date_creation'=>"Date",'c.date_commande'=>"Date",'c.amount_ht'=>"Numeric",'c.remise_percent'=>"Numeric",'c.total_ht'=>"Numeric",'c.total_ttc'=>"Numeric",'c.facture'=>"Boolean",'c.fk_statut'=>'Status','c.note_public'=>"Text",'c.date_livraison'=>'Date','ed.qty'=>"Text");
194  $this->export_TypeFields_array[$r] = array(
195  's.nom'=>'Text', 's.address'=>'Text', 's.zip'=>'Text', 's.town'=>'Text',
196  'co.label'=>'List:c_country:label:label', 'co.code'=>'Text', 's.phone'=>'Text', 's.siren'=>'Text', 's.siret'=>'Text', 's.ape'=>'Text', 's.idprof4'=>'Text',
197  'c.ref'=>"Text", 'c.ref_supplier'=>"Text", 'c.date_creation'=>"Date", 'c.date_delivery'=>"Date", 'c.tracking_number'=>"Numeric", 'c.height'=>"Numeric", 'c.width'=>"Numeric", 'c.weight'=>"Numeric", 'c.fk_statut'=>'Status', 'c.note_public'=>"Text",
198  'ed.qty'=>"Numeric", 'd.nom'=>'Text'
199  );
200  $this->export_entities_array[$r] = array(
201  's.rowid'=>"company", 's.nom'=>'company', 's.address'=>'company', 's.zip'=>'company', 's.town'=>'company',
202  'd.nom'=>'company', 'co.label'=>'company', 'co.code'=>'company', 's.fk_pays'=>'company', 's.phone'=>'company', 's.siren'=>'company', 's.ape'=>'company', 's.siret'=>'company', 's.idprof4'=>'company', 's.idprof5'=>'company', 's.idprof6'=>'company',
203  'c.rowid'=>"reception", 'c.ref'=>"reception", 'c.ref_supplier'=>"reception", 'c.fk_soc'=>"reception", 'c.date_creation'=>"reception", 'c.date_delivery'=>"reception", 'c.tracking_number'=>'reception', 'c.height'=>"reception", 'c.width'=>"reception", 'c.size'=>'reception', 'c.size_units'=>'reception', 'c.weight'=>"reception", 'c.weight_units'=>'reception', 'c.fk_statut'=>"reception", 'c.note_public'=>"reception",
204  'ed.rowid'=>'reception_line', 'ed.comment'=>'reception_line', 'ed.qty'=>"reception_line",
205  'p.rowid'=>'product', 'p.ref'=>'product', 'p.label'=>'product', 'p.weight'=>'product', 'p.weight_units'=>'product', 'p.volume'=>'product', 'p.volume_units'=>'product'
206  );
207  if ($idcontacts && getDolGlobalString('RECEPTION_ADD_CONTACTS_IN_EXPORT')) {
208  $this->export_entities_array[$r] += array('sp.rowid'=>'contact', 'sp.lastname'=>'contact', 'sp.firstname'=>'contact', 'sp.note_public'=>'contact');
209  }
210  $this->export_dependencies_array[$r] = array('reception_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
211  if ($idcontacts && getDolGlobalString('RECEPTION_ADD_CONTACTS_IN_EXPORT')) {
212  $keyforselect = 'socpeople';
213  $keyforelement = 'contact';
214  $keyforaliasextra = 'extra3';
215  include DOL_DOCUMENT_ROOT.'/core/extrafieldsinexport.inc.php';
216  }
217  $keyforselect = 'reception';
218  $keyforelement = 'reception';
219  $keyforaliasextra = 'extra';
220  include DOL_DOCUMENT_ROOT.'/core/extrafieldsinexport.inc.php';
221  $keyforselect = 'receptiondet_batch';
222  $keyforelement = 'reception_line';
223  $keyforaliasextra = 'extra2';
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.'reception as c';
228  $this->export_sql_end[$r] .= ' LEFT JOIN '.MAIN_DB_PREFIX.'reception_extrafields as extra ON c.rowid = extra.fk_object,';
229  $this->export_sql_end[$r] .= ' '.MAIN_DB_PREFIX.'societe as s';
230  if (!empty($user) && !$user->hasRight('societe', 'client', 'voir')) {
231  $this->export_sql_end[$r] .= ' LEFT JOIN '.MAIN_DB_PREFIX.'societe_commerciaux as sc ON sc.fk_soc = s.rowid';
232  }
233  $this->export_sql_end[$r] .= ' LEFT JOIN '.MAIN_DB_PREFIX.'c_departements as d ON s.fk_departement = d.rowid';
234  $this->export_sql_end[$r] .= ' LEFT JOIN '.MAIN_DB_PREFIX.'c_country as co ON s.fk_pays = co.rowid,';
235  $this->export_sql_end[$r] .= ' '.MAIN_DB_PREFIX.'receptiondet_batch as ed';
236  $this->export_sql_end[$r] .= ' LEFT JOIN '.MAIN_DB_PREFIX.'receptiondet_batch_extrafields as extra2 ON ed.rowid = extra2.fk_object';
237  $this->export_sql_end[$r] .= ' , '.MAIN_DB_PREFIX.'commande_fournisseurdet as cd';
238  $this->export_sql_end[$r] .= ' LEFT JOIN '.MAIN_DB_PREFIX.'product as p on cd.fk_product = p.rowid';
239  if ($idcontacts && getDolGlobalString('RECEPTION_ADD_CONTACTS_IN_EXPORT')) {
240  $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).')';
241  $this->export_sql_end[$r] .= ' LEFT JOIN '.MAIN_DB_PREFIX.'socpeople as sp ON sp.rowid = ee.fk_socpeople';
242  $this->export_sql_end[$r] .= ' LEFT JOIN '.MAIN_DB_PREFIX.'socpeople_extrafields as extra3 ON sp.rowid = extra3.fk_object';
243  }
244  $this->export_sql_end[$r] .= ' WHERE c.fk_soc = s.rowid AND c.rowid = ed.fk_reception AND ed.fk_elementdet = cd.rowid';
245  $this->export_sql_end[$r] .= ' AND c.entity IN ('.getEntity('reception').')';
246  if (!empty($user) && !$user->hasRight('societe', 'client', 'voir')) {
247  $this->export_sql_end[$r] .= ' AND sc.fk_user = '.(empty($user) ? 0 : $user->id);
248  }
249  }
250 
251 
260  public function init($options = '')
261  {
262  global $conf, $langs;
263 
264  // Permissions
265  $this->remove($options);
266 
267  //ODT template
268  $src = DOL_DOCUMENT_ROOT.'/install/doctemplates/reception/template_reception.odt';
269  $dirodt = DOL_DATA_ROOT.'/doctemplates/reception';
270  $dest = $dirodt.'/template_reception.odt';
271 
272  if (file_exists($src) && !file_exists($dest)) {
273  require_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
274  dol_mkdir($dirodt);
275  $result = dol_copy($src, $dest, 0, 0);
276  if ($result < 0) {
277  $langs->load("errors");
278  $this->error = $langs->trans('ErrorFailToCopyFile', $src, $dest);
279  return 0;
280  }
281  }
282 
283  $sql = array();
284 
285  $sql = array(
286  "DELETE FROM ".MAIN_DB_PREFIX."document_model WHERE nom = '".$this->db->escape($this->const[0][2])."' AND type = 'reception' AND entity = ".((int) $conf->entity),
287  "INSERT INTO ".MAIN_DB_PREFIX."document_model (nom, type, entity) VALUES('".$this->db->escape($this->const[0][2])."','reception',".((int) $conf->entity).")",
288  //"DELETE FROM ".MAIN_DB_PREFIX."const WHERE name IN ('STOCK_CALCULATE_ON_SUPPLIER_BILL', 'STOCK_CALCULATE_ON_SUPPLIER_VALIDATE_ORDER', 'STOCK_CALCULATE_ON_SUPPLIER_DISPATCH_ORDER', 'STOCK_CALCULATE_ON_RECEPTION', 'STOCK_CALCULATE_ON_RECEPTION_CLOSE') AND entity = ".((int) $conf->entity),
289  //"INSERT INTO ".MAIN_DB_PREFIX."const (name, value, entity) VALUES ('STOCK_CALCULATE_ON_RECEPTION_CLOSE', 1, ".((int) $conf->entity).")"
290  );
291 
292  return $this->_init($sql, $options);
293  }
294 }
Class to manage predefined suppliers products.
Class DolibarrModules.
_init($array_sql, $options='')
Enables a module.
Class to describe and enable module Reception.
init($options='')
Function called when module is enabled.
__construct($db)
Constructor.
if(isModEnabled('invoice') && $user->hasRight('facture', 'lire')) if((isModEnabled('fournisseur') &&!getDolGlobalString('MAIN_USE_NEW_SUPPLIERMOD') && $user->hasRight("fournisseur", "facture", "lire"))||(isModEnabled('supplier_invoice') && $user->hasRight("supplier_invoice", "lire"))) if(isModEnabled('don') && $user->hasRight('don', 'lire')) if(isModEnabled('tax') && $user->hasRight('tax', 'charges', 'lire')) if(isModEnabled('invoice') &&isModEnabled('order') && $user->hasRight("commande", "lire") &&!getDolGlobalString('WORKFLOW_DISABLE_CREATE_INVOICE_FROM_ORDER')) $sql
Social contributions to pay.
Definition: index.php:751
print *****$script_file(".$version.") pid 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.
Definition: files.lib.php:767
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:142