dolibarr 21.0.0-beta
commonobject.class.php
Go to the documentation of this file.
1<?php
2/* Copyright (C) 2006-2015 Laurent Destailleur <eldy@users.sourceforge.net>
3 * Copyright (C) 2005-2013 Regis Houssin <regis.houssin@inodbox.com>
4 * Copyright (C) 2010-2020 Juanjo Menent <jmenent@2byte.es>
5 * Copyright (C) 2012-2013 Christophe Battarel <christophe.battarel@altairis.fr>
6 * Copyright (C) 2011-2022 Philippe Grand <philippe.grand@atoo-net.com>
7 * Copyright (C) 2012-2015 Marcos García <marcosgdf@gmail.com>
8 * Copyright (C) 2012-2015 Raphaël Doursenaud <rdoursenaud@gpcsolutions.fr>
9 * Copyright (C) 2012 Cedric Salvador <csalvador@gpcsolutions.fr>
10 * Copyright (C) 2015-2022 Alexandre Spangaro <aspangaro@open-dsi.fr>
11 * Copyright (C) 2016 Bahfir abbes <bafbes@gmail.com>
12 * Copyright (C) 2017 ATM Consulting <support@atm-consulting.fr>
13 * Copyright (C) 2017-2019 Nicolas ZABOURI <info@inovea-conseil.com>
14 * Copyright (C) 2017 Rui Strecht <rui.strecht@aliartalentos.com>
15 * Copyright (C) 2018-2024 Frédéric France <frederic.france@free.fr>
16 * Copyright (C) 2018 Josep Lluís Amador <joseplluis@lliuretic.cat>
17 * Copyright (C) 2023 Gauthier VERDOL <gauthier.verdol@atm-consulting.fr>
18 * Copyright (C) 2021 Grégory Blémand <gregory.blemand@atm-consulting.fr>
19 * Copyright (C) 2023 Lenin Rivas <lenin.rivas777@gmail.com>
20 * Copyright (C) 2024 MDW <mdeweerd@users.noreply.github.com>
21 * Copyright (C) 2024 William Mead <william.mead@manchenumerique.fr>
22 *
23 * This program is free software; you can redistribute it and/or modify
24 * it under the terms of the GNU General Public License as published by
25 * the Free Software Foundation; either version 3 of the License, or
26 * (at your option) any later version.
27 *
28 * This program is distributed in the hope that it will be useful,
29 * but WITHOUT ANY WARRANTY; without even the implied warranty of
30 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
31 * GNU General Public License for more details.
32 *
33 * You should have received a copy of the GNU General Public License
34 * along with this program. If not, see <https://www.gnu.org/licenses/>.
35 */
36
43require_once DOL_DOCUMENT_ROOT.'/core/class/doldeprecationhandler.class.php';
44
50abstract class CommonObject
51{
52 use DolDeprecationHandler;
53
54 const TRIGGER_PREFIX = ''; // to be overridden in child class implementations, i.e. 'BILL', 'TASK', 'PROPAL', etc.
55
59 public $module;
60
64 public $db;
65
69 public $id;
70
74 public $entity;
75
80 public $error;
81
85 public $errorhidden;
86
90 public $errors = array();
91
95 private $validateFieldsErrors = array();
96
100 public $element;
101
106 public $fk_element;
107
113 public $element_for_permission;
114
118 public $table_element;
119
123 public $table_element_line = '';
124
129 public $ismultientitymanaged;
130
134 public $import_key;
135
139 public $array_options = array();
140
141
145 public $fields = array();
146
152 public $array_languages = null; // Value is array() when load already tried
153
157 public $contacts_ids;
158
162 public $linked_objects;
163
167 public $linkedObjectsIds;
168
172 public $linkedObjects;
173
177 private $linkedObjectsFullLoaded = array();
178
182 public $oldcopy;
183
187 public $oldref;
188
192 protected $table_ref_field = '';
193
197 public $restrictiononfksoc = 0;
198
199
200 // The following vars are used by some objects only.
201 // We keep these properties in CommonObject in order to provide common methods using them.
202
206 public $context = array();
207
211 public $actionmsg;
215 public $actionmsg2;
216
220 public $canvas;
221
226 public $project;
227
232 public $fk_project;
233
239 private $projet;
240
246 public $fk_projet;
247
252 public $contact;
253
258 public $contact_id;
259
264 public $thirdparty;
265
270 public $user;
271
276 public $origin_type;
277
282 public $origin_id;
283
288
294 public $origin;
295
304 private $expedition;
305
311 private $livraison;
312
318 private $commandeFournisseur;
319
320
324 public $ref;
325
329 public $ref_ext;
330
334 public $ref_previous;
335
339 public $ref_next;
340
344 public $newref;
345
352 public $statut;
353
362 public $status;
363
364
369 public $country;
370
375 public $country_id;
376
381 public $country_code;
382
387 public $state;
388
393 public $state_id;
394
399 public $fk_departement;
400
405 public $state_code;
406
411 public $region_id;
412
417 public $region_code;
418
423 public $region;
424
425
430 public $barcode_type;
431
436 public $barcode_type_code;
437
442 public $barcode_type_label;
443
448 public $barcode_type_coder;
449
454 public $mode_reglement_id;
455
460 public $cond_reglement_id;
461
465 public $demand_reason_id;
466
471 public $transport_mode_id;
472
480 private $cond_reglement; // Private to call DolDeprecationHandler
484 protected $depr_cond_reglement; // Internal value for deprecation
485
491 public $fk_delivery_address;
492
497 public $shipping_method_id;
498
503 public $shipping_method;
504
505 // Multicurrency
509 public $fk_multicurrency;
510
515 public $multicurrency_code;
516
521 public $multicurrency_tx;
522
526 public $multicurrency_total_ht;
527
531 public $multicurrency_total_tva;
532
536 public $multicurrency_total_ttc;
537
541 public $multicurrency_total_localtax1; // not in database
542
546 public $multicurrency_total_localtax2; // not in database
547
552 public $model_pdf;
553
558 public $last_main_doc;
559
565 public $fk_bank;
566
571 public $fk_account;
572
577 public $note_public;
578
583 public $note_private;
584
590 public $note;
591
596 public $total_ht;
597
602 public $total_tva;
603
608 public $total_localtax1;
609
614 public $total_localtax2;
615
620 public $total_ttc;
621
622
626 public $lines;
627
631 public $actiontypecode;
632
637 public $comments = array();
638
642 public $name;
643
647 public $lastname;
648
652 public $firstname;
653
657 public $civility_id;
658
659 // Dates
663 public $date_creation;
664
668 public $date_validation;
669
673 public $date_modification;
674
680 public $tms;
681
687 private $date_update;
688
692 public $date_cloture;
693
698 public $user_author;
699
704 public $user_creation;
705
709 public $user_creation_id;
710
715 public $user_valid;
716
721 public $user_validation;
722
726 public $user_validation_id;
727
731 public $user_closing_id;
732
737 public $user_modification;
738
742 public $user_modification_id;
743
748 public $fk_user_creat;
749
754 public $fk_user_modif;
755
756
760 public $next_prev_filter;
761
765 public $specimen = 0;
766
770 public $sendtoid;
771
776 public $alreadypaid;
777
782 public $totalpaid;
783
787 public $labelStatus = array();
788
792 public $labelStatusShort = array();
793
797 public $tpl;
798
799
803 public $showphoto_on_popup;
804
808 public $nb = array();
809
813 public $nbphoto;
814
818 public $output;
819
823 public $extraparams = array();
824
828 protected $childtables = array();
829
835 protected $childtablesoncascade = array();
836
840 public $product;
841
845 public $cond_reglement_supplier_id;
846
852 public $deposit_percent;
853
854
858 public $retained_warranty_fk_cond_reglement;
859
863 public $warehouse_id;
864
868 public $isextrafieldmanaged = 0;
869
870
871 // No constructor as it is an abstract class
872
878 protected function deprecatedProperties()
879 {
880 return array(
881 'alreadypaid' => 'totalpaid',
882 'cond_reglement' => 'depr_cond_reglement',
883 //'note' => 'note_private', // Some classes needs ->note and others need ->note_public/private so we can't manage deprecation for this field with dolDeprecationHandler
884 'commandeFournisseur' => 'origin_object',
885 'expedition' => 'origin_object',
886 'fk_project' => 'fk_project',
887 'livraison' => 'origin_object',
888 'projet' => 'project',
889 'statut' => 'status',
890 );
891 }
892
893
904 public static function isExistingObject($element, $id, $ref = '', $ref_ext = '')
905 {
906 global $db, $conf;
907
908 $sql = "SELECT rowid, ref, ref_ext";
909 $sql .= " FROM ".$db->prefix().$element;
910 $sql .= " WHERE entity IN (".getEntity($element).")";
911
912 if ($id > 0) {
913 $sql .= " AND rowid = ".((int) $id);
914 } elseif ($ref) {
915 $sql .= " AND ref = '".$db->escape($ref)."'";
916 } elseif ($ref_ext) {
917 $sql .= " AND ref_ext = '".$db->escape($ref_ext)."'";
918 } else {
919 $error = 'ErrorWrongParameters';
920 dol_syslog(get_class()."::isExistingObject ".$error, LOG_ERR);
921 return -1;
922 }
923 if ($ref || $ref_ext) { // Because the same ref can exists in 2 different entities, we force the current one in priority
924 $sql .= " AND entity = ".((int) $conf->entity);
925 }
926
927 dol_syslog(get_class()."::isExistingObject", LOG_DEBUG);
928 $resql = $db->query($sql);
929 if ($resql) {
930 $num = $db->num_rows($resql);
931 if ($num > 0) {
932 return 1;
933 } else {
934 return 0;
935 }
936 }
937 return -1;
938 }
939
945 public function isEmpty()
946 {
947 return (empty($this->id));
948 }
949
957 {
958 if (!empty($object->error)) {
959 $this->error = $object->error;
960 }
961 if (!empty($object->errors)) {
962 $this->errors = array_merge($this->errors, $object->errors);
963 }
964 }
965
973 public function getTooltipContentArray($params)
974 {
975 return [];
976 }
977
985 public function getTooltipContent($params)
986 {
987 global $action, $extrafields, $langs, $hookmanager;
988
989 // If there is too much extrafields, we do not include them into tooltip
990 $MAX_EXTRAFIELDS_TO_SHOW_IN_TOOLTIP = getDolGlobalInt('MAX_EXTRAFIELDS_TO_SHOW_IN_TOOLTIP', 3);
991
992 $data = $this->getTooltipContentArray($params);
993 $count = 0;
994
995 // Add extrafields
996 if (!empty($extrafields->attributes[$this->table_element]['label'])) {
997 $data['opendivextra'] = '<div class="centpercent wordbreak divtooltipextra">';
998 foreach ($extrafields->attributes[$this->table_element]['label'] as $key => $val) {
999 if ($extrafields->attributes[$this->table_element]['type'][$key] == 'separate') {
1000 continue;
1001 }
1002 if ($count >= abs($MAX_EXTRAFIELDS_TO_SHOW_IN_TOOLTIP)) {
1003 $data['more_extrafields'] = '<br>...';
1004 break;
1005 }
1006 $enabled = 1;
1007 if ($enabled && isset($extrafields->attributes[$this->table_element]['enabled'][$key])) {
1008 $enabled = (int) dol_eval((string) $extrafields->attributes[$this->table_element]['enabled'][$key], 1, 1, '2');
1009 }
1010 if ($enabled && isset($extrafields->attributes[$this->table_element]['list'][$key])) {
1011 $enabled = (int) dol_eval($extrafields->attributes[$this->table_element]['list'][$key], 1, 1, '2');
1012 }
1013 $perms = 1;
1014 if ($perms && isset($extrafields->attributes[$this->table_element]['perms'][$key])) {
1015 $perms = (int) dol_eval($extrafields->attributes[$this->table_element]['perms'][$key], 1, 1, '2');
1016 }
1017 if (empty($enabled)) {
1018 continue; // 0 = Never visible field
1019 }
1020 if (abs($enabled) != 1 && abs($enabled) != 3 && abs($enabled) != 5 && abs($enabled) != 4) {
1021 continue; // <> -1 and <> 1 and <> 3 = not visible on forms, only on list <> 4 = not visible at the creation
1022 }
1023 if (empty($perms)) {
1024 continue; // 0 = Not visible
1025 }
1026 if (!empty($extrafields->attributes[$this->table_element]['langfile'][$key])) {
1027 $langs->load($extrafields->attributes[$this->table_element]['langfile'][$key]);
1028 }
1029 $labelextra = $langs->trans((string) $extrafields->attributes[$this->table_element]['label'][$key]);
1030 if ($extrafields->attributes[$this->table_element]['type'][$key] == 'separate') {
1031 $data[$key] = '<br><b><u>'. $labelextra . '</u></b>';
1032 } else {
1033 $value = (empty($this->array_options['options_' . $key]) ? '' : $this->array_options['options_' . $key]);
1034 $data[$key] = '<br><b>'. $labelextra . ':</b> ' . $extrafields->showOutputField($key, $value, '', $this->table_element);
1035 $count++;
1036 }
1037 }
1038 $data['closedivextra'] = '</div>';
1039 }
1040
1041 $hookmanager->initHooks(array($this->element . 'dao'));
1042 $parameters = array(
1043 'tooltipcontentarray' => &$data,
1044 'params' => $params,
1045 );
1046 // Note that $action and $object may have been modified by some hooks
1047 $hookmanager->executeHooks('getTooltipContent', $parameters, $this, $action);
1048
1049 //var_dump($data);
1050 $label = implode($data);
1051
1052 return $label;
1053 }
1054
1055
1061 public function errorsToString()
1062 {
1063 return $this->error.(is_array($this->errors) ? (($this->error != '' ? ', ' : '').implode(', ', $this->errors)) : '');
1064 }
1065
1066
1073 public function getFormatedCustomerRef($objref)
1074 {
1075 global $hookmanager;
1076
1077 $parameters = array('objref' => $objref);
1078 $action = '';
1079 $reshook = $hookmanager->executeHooks('getFormatedCustomerRef', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
1080 if ($reshook > 0) {
1081 return $hookmanager->resArray['objref'];
1082 }
1083 return $objref.(isset($hookmanager->resArray['objref']) ? $hookmanager->resArray['objref'] : '');
1084 }
1085
1092 public function getFormatedSupplierRef($objref)
1093 {
1094 global $hookmanager;
1095
1096 $parameters = array('objref' => $objref);
1097 $action = '';
1098 $reshook = $hookmanager->executeHooks('getFormatedSupplierRef', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
1099 if ($reshook > 0) {
1100 return $hookmanager->resArray['objref'];
1101 }
1102 return $objref.(isset($hookmanager->resArray['objref']) ? $hookmanager->resArray['objref'] : '');
1103 }
1104
1114 public function getFullAddress($withcountry = 0, $sep = "\n", $withregion = 0, $extralangcode = '')
1115 {
1116 if ($withcountry && $this->country_id && (empty($this->country_code) || empty($this->country))) {
1117 require_once DOL_DOCUMENT_ROOT.'/core/lib/company.lib.php';
1118 $tmparray = getCountry($this->country_id, 'all');
1119 $this->country_code = $tmparray['code'];
1120 $this->country = $tmparray['label'];
1121 }
1122
1123 if ($withregion && $this->state_id && (empty($this->state_code) || empty($this->state) || empty($this->region) || empty($this->region_code))) {
1124 require_once DOL_DOCUMENT_ROOT.'/core/lib/company.lib.php';
1125 $tmparray = getState($this->state_id, 'all', null, 1);
1126 $this->state_code = $tmparray['code'];
1127 $this->state = $tmparray['label'];
1128 $this->region_code = $tmparray['region_code'];
1129 $this->region = $tmparray['region'];
1130 }
1131
1132 return dol_format_address($this, $withcountry, $sep, null, 0, $extralangcode);
1133 }
1134
1135
1144 public function getLastMainDocLink($modulepart, $initsharekey = 0, $relativelink = 0)
1145 {
1146 global $user, $dolibarr_main_url_root;
1147
1148 if (empty($this->last_main_doc)) {
1149 return ''; // No way to known which document name to use
1150 }
1151
1152 include_once DOL_DOCUMENT_ROOT.'/ecm/class/ecmfiles.class.php';
1153 $ecmfile = new EcmFiles($this->db);
1154 $result = $ecmfile->fetch(0, '', $this->last_main_doc);
1155 if ($result < 0) {
1156 $this->error = $ecmfile->error;
1157 $this->errors = $ecmfile->errors;
1158 return -1;
1159 }
1160
1161 if (empty($ecmfile->id)) { // No entry into file index already exists, we should initialize the shared key manually.
1162 // Add entry into index
1163 if ($initsharekey) {
1164 require_once DOL_DOCUMENT_ROOT.'/core/lib/security2.lib.php';
1165
1166 // TODO We can't, we don't have full path of file, only last_main_doc and ->element, so we must first rebuild full path $destfull
1167 /*
1168 $ecmfile->filepath = $rel_dir;
1169 $ecmfile->filename = $filename;
1170 $ecmfile->label = md5_file(dol_osencode($destfull)); // hash of file content
1171 $ecmfile->fullpath_orig = '';
1172 $ecmfile->gen_or_uploaded = 'generated';
1173 $ecmfile->description = ''; // indexed content
1174 $ecmfile->keywords = ''; // keyword content
1175 $ecmfile->share = getRandomPassword(true);
1176 $result = $ecmfile->create($user);
1177 if ($result < 0)
1178 {
1179 $this->error = $ecmfile->error;
1180 $this->errors = $ecmfile->errors;
1181 }
1182 */
1183 } else {
1184 return '';
1185 }
1186 } elseif (empty($ecmfile->share)) { // Entry into file index already exists but no share key is defined.
1187 // Add entry into index
1188 if ($initsharekey) {
1189 require_once DOL_DOCUMENT_ROOT.'/core/lib/security2.lib.php';
1190 $ecmfile->share = getRandomPassword(true);
1191 $ecmfile->update($user);
1192 } else {
1193 return '';
1194 }
1195 }
1196 // Define $urlwithroot
1197 $urlwithouturlroot = preg_replace('/'.preg_quote(DOL_URL_ROOT, '/').'$/i', '', trim($dolibarr_main_url_root));
1198 // This is to use external domain name found into config file
1199 //if (DOL_URL_ROOT && ! preg_match('/\/$/', $urlwithouturlroot) && ! preg_match('/^\//', DOL_URL_ROOT)) $urlwithroot=$urlwithouturlroot.'/'.DOL_URL_ROOT;
1200 //else
1201 $urlwithroot = $urlwithouturlroot.DOL_URL_ROOT;
1202 //$urlwithroot=DOL_MAIN_URL_ROOT; // This is to use same domain name than current
1203
1204 $forcedownload = 0;
1205
1206 $paramlink = '';
1207 //if (!empty($modulepart)) $paramlink.=($paramlink?'&':'').'modulepart='.$modulepart; // For sharing with hash (so public files), modulepart is not required.
1208 //if (!empty($ecmfile->entity)) $paramlink.='&entity='.$ecmfile->entity; // For sharing with hash (so public files), entity is not required.
1209 //$paramlink.=($paramlink?'&':'').'file='.urlencode($filepath); // No need of name of file for public link, we will use the hash
1210 if (!empty($ecmfile->share)) {
1211 $paramlink .= ($paramlink ? '&' : '').'hashp='.$ecmfile->share; // Hash for public share
1212 }
1213 if ($forcedownload) {
1214 $paramlink .= ($paramlink ? '&' : '').'attachment=1';
1215 }
1216
1217 if ($relativelink) {
1218 $linktoreturn = 'document.php'.($paramlink ? '?'.$paramlink : '');
1219 } else {
1220 $linktoreturn = $urlwithroot.'/document.php'.($paramlink ? '?'.$paramlink : '');
1221 }
1222
1223 // Here $ecmfile->share is defined
1224 return $linktoreturn;
1225 }
1226
1227
1228 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
1238 public function add_contact($fk_socpeople, $type_contact, $source = 'external', $notrigger = 0)
1239 {
1240 // phpcs:enable
1241 global $user, $langs;
1242
1243
1244 dol_syslog(get_class($this)."::add_contact $fk_socpeople, $type_contact, $source, $notrigger");
1245
1246 // Check parameters
1247 if ($fk_socpeople <= 0) {
1248 $langs->load("errors");
1249 $this->error = $langs->trans("ErrorWrongValueForParameterX", "1");
1250 dol_syslog(get_class($this)."::add_contact ".$this->error, LOG_ERR);
1251 return -1;
1252 }
1253 if (!$type_contact) {
1254 $langs->load("errors");
1255 $this->error = $langs->trans("ErrorWrongValueForParameterX", "2");
1256 dol_syslog(get_class($this)."::add_contact ".$this->error, LOG_ERR);
1257 return -2;
1258 }
1259
1260 $id_type_contact = 0;
1261 if (is_numeric($type_contact)) {
1262 $id_type_contact = $type_contact;
1263 } else {
1264 // We look for id type_contact
1265 $sql = "SELECT tc.rowid";
1266 $sql .= " FROM ".$this->db->prefix()."c_type_contact as tc";
1267 $sql .= " WHERE tc.element='".$this->db->escape($this->element)."'";
1268 $sql .= " AND tc.source='".$this->db->escape($source)."'";
1269 $sql .= " AND tc.code='".$this->db->escape($type_contact)."' AND tc.active=1";
1270 //print $sql;
1271 $resql = $this->db->query($sql);
1272 if ($resql) {
1273 $obj = $this->db->fetch_object($resql);
1274 if ($obj) {
1275 $id_type_contact = $obj->rowid;
1276 }
1277 }
1278 }
1279
1280 if ($id_type_contact == 0) {
1281 dol_syslog("CODE_NOT_VALID_FOR_THIS_ELEMENT: Code type of contact '".$type_contact."' does not exists or is not active for element ".$this->element.", we can ignore it");
1282 return 0;
1283 }
1284
1285 $datecreate = dol_now();
1286
1287 // Socpeople must have already been added by some trigger, then we have to check it to avoid DB_ERROR_RECORD_ALREADY_EXISTS error
1288 $TListeContacts = $this->liste_contact(-1, $source);
1289 $already_added = false;
1290 if (is_array($TListeContacts) && !empty($TListeContacts)) {
1291 foreach ($TListeContacts as $array_contact) {
1292 if ($array_contact['status'] == 4 && $array_contact['id'] == $fk_socpeople && $array_contact['fk_c_type_contact'] == $id_type_contact) {
1293 $already_added = true;
1294 break;
1295 }
1296 }
1297 }
1298
1299 if (!$already_added) {
1300 $this->db->begin();
1301
1302 // Insert into database
1303 $sql = "INSERT INTO ".$this->db->prefix()."element_contact";
1304 $sql .= " (element_id, fk_socpeople, datecreate, statut, fk_c_type_contact) ";
1305 $sql .= " VALUES (".$this->id.", ".((int) $fk_socpeople)." , ";
1306 $sql .= "'".$this->db->idate($datecreate)."'";
1307 $sql .= ", 4, ".((int) $id_type_contact);
1308 $sql .= ")";
1309
1310 $resql = $this->db->query($sql);
1311 if ($resql) {
1312 if (!$notrigger) {
1313 $result = $this->call_trigger(strtoupper($this->element).'_ADD_CONTACT', $user);
1314 if ($result < 0) {
1315 $this->db->rollback();
1316 return -1;
1317 }
1318 }
1319
1320 $this->db->commit();
1321 return 1;
1322 } else {
1323 if ($this->db->errno() == 'DB_ERROR_RECORD_ALREADY_EXISTS') {
1324 $this->error = $this->db->errno();
1325 $this->db->rollback();
1326 return -2;
1327 } else {
1328 $this->error = $this->db->lasterror();
1329 $this->db->rollback();
1330 return -1;
1331 }
1332 }
1333 } else {
1334 return 0;
1335 }
1336 }
1337
1338 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
1346 public function copy_linked_contact($objFrom, $source = 'internal')
1347 {
1348 // phpcs:enable
1349 $contacts = $objFrom->liste_contact(-1, $source);
1350 foreach ($contacts as $contact) {
1351 if ($this->add_contact($contact['id'], $contact['fk_c_type_contact'], $contact['source']) < 0) {
1352 return -1;
1353 }
1354 }
1355 return 1;
1356 }
1357
1358 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
1368 public function update_contact($rowid, $statut, $type_contact_id = 0, $fk_socpeople = 0)
1369 {
1370 // phpcs:enable
1371 // Insert into database
1372 $sql = "UPDATE ".$this->db->prefix()."element_contact set";
1373 $sql .= " statut = ".((int) $statut);
1374 if ($type_contact_id) {
1375 $sql .= ", fk_c_type_contact = ".((int) $type_contact_id);
1376 }
1377 if ($fk_socpeople) {
1378 $sql .= ", fk_socpeople = ".((int) $fk_socpeople);
1379 }
1380 $sql .= " where rowid = ".((int) $rowid);
1381
1382 $resql = $this->db->query($sql);
1383 if ($resql) {
1384 return 0;
1385 } else {
1386 $this->error = $this->db->lasterror();
1387 return -1;
1388 }
1389 }
1390
1391 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
1399 public function delete_contact($rowid, $notrigger = 0)
1400 {
1401 // phpcs:enable
1402 global $user;
1403
1404 $error = 0;
1405
1406 $this->db->begin();
1407
1408 if (!$error && empty($notrigger)) {
1409 // Call trigger
1410 $this->context['contact_id'] = ((int) $rowid);
1411 $result = $this->call_trigger(strtoupper($this->element).'_DELETE_CONTACT', $user);
1412 if ($result < 0) {
1413 $error++;
1414 }
1415 // End call triggers
1416 }
1417
1418 if (!$error) {
1419 dol_syslog(get_class($this)."::delete_contact", LOG_DEBUG);
1420
1421 $sql = "DELETE FROM ".MAIN_DB_PREFIX."element_contact";
1422 $sql .= " WHERE rowid = ".((int) $rowid);
1423
1424 $result = $this->db->query($sql);
1425 if (!$result) {
1426 $error++;
1427 $this->errors[] = $this->db->lasterror();
1428 }
1429 }
1430
1431 if (!$error) {
1432 $this->db->commit();
1433 return 1;
1434 } else {
1435 $this->error = $this->db->lasterror();
1436 $this->db->rollback();
1437 return -1;
1438 }
1439 }
1440
1441 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
1449 public function delete_linked_contact($source = '', $code = '')
1450 {
1451 // phpcs:enable
1452 $listId = '';
1453 $temp = array();
1454 $typeContact = $this->liste_type_contact($source, '', 0, 0, $code);
1455
1456 if (!empty($typeContact)) {
1457 foreach ($typeContact as $key => $value) {
1458 array_push($temp, $key);
1459 }
1460 $listId = implode(",", $temp);
1461 }
1462
1463 // If $listId is empty, we have not criteria on fk_c_type_contact so we will delete record on element_id for
1464 // any type or record instead of only the ones of the current object. So we do nothing in such a case.
1465 if (empty($listId)) {
1466 return 0;
1467 }
1468
1469 $sql = "DELETE FROM ".$this->db->prefix()."element_contact";
1470 $sql .= " WHERE element_id = ".((int) $this->id);
1471 $sql .= " AND fk_c_type_contact IN (".$this->db->sanitize($listId).")";
1472
1473 dol_syslog(get_class($this)."::delete_linked_contact", LOG_DEBUG);
1474 if ($this->db->query($sql)) {
1475 return 1;
1476 } else {
1477 $this->error = $this->db->lasterror();
1478 return -1;
1479 }
1480 }
1481
1482 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
1494 public function liste_contact($statusoflink = -1, $source = 'external', $list = 0, $code = '', $status = -1, $arrayoftcids = array())
1495 {
1496 // phpcs:enable
1497 global $langs;
1498
1499 $tab = array();
1500
1501 $sql = "SELECT ec.rowid, ec.statut as statuslink, ec.fk_socpeople as id, ec.fk_c_type_contact"; // This field contains id of llx_socpeople or id of llx_user
1502 if ($source == 'internal') {
1503 $sql .= ", '-1' as socid, t.statut as statuscontact, t.login, t.photo, t.gender";
1504 }
1505 if ($source == 'external' || $source == 'thirdparty') {
1506 $sql .= ", t.fk_soc as socid, t.statut as statuscontact";
1507 }
1508 $sql .= ", t.civility as civility, t.lastname as lastname, t.firstname, t.email";
1509 if (empty($arrayoftcids)) {
1510 $sql .= ", tc.source, tc.element, tc.code, tc.libelle as type_label";
1511 }
1512 $sql .= " FROM";
1513 if (empty($arrayoftcids)) {
1514 $sql .= " ".$this->db->prefix()."c_type_contact as tc,";
1515 }
1516 $sql .= " ".$this->db->prefix()."element_contact as ec";
1517 if ($source == 'internal') { // internal contact (user)
1518 $sql .= " LEFT JOIN ".$this->db->prefix()."user as t on ec.fk_socpeople = t.rowid";
1519 }
1520 if ($source == 'external' || $source == 'thirdparty') { // external contact (socpeople)
1521 $sql .= " LEFT JOIN ".$this->db->prefix()."socpeople as t on ec.fk_socpeople = t.rowid";
1522 }
1523 $sql .= " WHERE ec.element_id = ".((int) $this->id);
1524 if (empty($arrayoftcids)) {
1525 $sql .= " AND ec.fk_c_type_contact = tc.rowid";
1526 $sql .= " AND tc.element = '".$this->db->escape($this->element)."'";
1527 if ($code) {
1528 $sql .= " AND tc.code = '".$this->db->escape($code)."'";
1529 }
1530 if ($source == 'internal') {
1531 $sql .= " AND tc.source = 'internal'";
1532 }
1533 if ($source == 'external' || $source == 'thirdparty') {
1534 $sql .= " AND tc.source = 'external'";
1535 }
1536 $sql .= " AND tc.active = 1";
1537 } else {
1538 $sql .= " AND ec.fk_c_type_contact IN (".$this->db->sanitize(implode(',', $arrayoftcids)).")";
1539 }
1540 if ($status >= 0) {
1541 $sql .= " AND t.statut = ".((int) $status); // t is llx_user or llx_socpeople
1542 }
1543 if ($statusoflink >= 0) {
1544 $sql .= " AND ec.statut = ".((int) $statusoflink);
1545 }
1546 $sql .= " ORDER BY t.lastname ASC";
1547
1548 dol_syslog(get_class($this)."::liste_contact", LOG_DEBUG);
1549 $resql = $this->db->query($sql);
1550 if ($resql) {
1551 $num = $this->db->num_rows($resql);
1552 $i = 0;
1553 while ($i < $num) {
1554 $obj = $this->db->fetch_object($resql);
1555
1556 if (!$list) {
1557 $transkey = "TypeContact_".$obj->element."_".$obj->source."_".$obj->code;
1558 $libelle_type = ($langs->trans($transkey) != $transkey ? $langs->trans($transkey) : $obj->type_label);
1559 $tab[$i] = array(
1560 'parentId' => $this->id,
1561 'source' => $obj->source,
1562 'socid' => $obj->socid,
1563 'id' => $obj->id,
1564 'nom' => $obj->lastname, // For backward compatibility
1565 'civility' => $obj->civility,
1566 'lastname' => $obj->lastname,
1567 'firstname' => $obj->firstname,
1568 'email' => $obj->email,
1569 'login' => (empty($obj->login) ? '' : $obj->login),
1570 'photo' => (empty($obj->photo) ? '' : $obj->photo),
1571 'gender' => (empty($obj->gender) ? '' : $obj->gender),
1572 'statuscontact' => $obj->statuscontact,
1573 'rowid' => $obj->rowid,
1574 'code' => $obj->code,
1575 'libelle' => $libelle_type,
1576 'status' => $obj->statuslink,
1577 'fk_c_type_contact' => $obj->fk_c_type_contact
1578 );
1579 } else {
1580 $tab[$i] = $obj->id;
1581 }
1582
1583 $i++;
1584 }
1585
1586 return $tab;
1587 } else {
1588 $this->error = $this->db->lasterror();
1589 dol_print_error($this->db);
1590 return -1;
1591 }
1592 }
1593
1594
1601 public function swapContactStatus($rowid)
1602 {
1603 $sql = "SELECT ec.datecreate, ec.statut, ec.fk_socpeople, ec.fk_c_type_contact,";
1604 $sql .= " tc.code, tc.libelle as type_label";
1605 $sql .= " FROM (".$this->db->prefix()."element_contact as ec, ".$this->db->prefix()."c_type_contact as tc)";
1606 $sql .= " WHERE ec.rowid =".((int) $rowid);
1607 $sql .= " AND ec.fk_c_type_contact = tc.rowid";
1608 $sql .= " AND tc.element = '".$this->db->escape($this->element)."'";
1609
1610 dol_syslog(get_class($this)."::swapContactStatus", LOG_DEBUG);
1611 $resql = $this->db->query($sql);
1612 if ($resql) {
1613 $obj = $this->db->fetch_object($resql);
1614 $newstatut = ($obj->statut == 4) ? 5 : 4;
1615 $result = $this->update_contact($rowid, $newstatut);
1616 $this->db->free($resql);
1617 return $result;
1618 } else {
1619 $this->error = $this->db->error();
1620 dol_print_error($this->db);
1621 return -1;
1622 }
1623 }
1624
1625 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
1636 public function liste_type_contact($source = 'internal', $order = 'position', $option = 0, $activeonly = 0, $code = '')
1637 {
1638 // phpcs:enable
1639 global $langs;
1640
1641 if (empty($order)) {
1642 $order = 'position';
1643 }
1644 if ($order == 'position') {
1645 $order .= ',code';
1646 }
1647
1648 $tab = array();
1649
1650 $sql = "SELECT DISTINCT tc.rowid, tc.code, tc.libelle as type_label, tc.position";
1651 $sql .= " FROM ".$this->db->prefix()."c_type_contact as tc";
1652 $sql .= " WHERE tc.element = '".$this->db->escape($this->element)."'";
1653 if ($activeonly == 1) {
1654 $sql .= " AND tc.active = 1"; // only the active types
1655 }
1656 if (!empty($source) && $source != 'all') {
1657 $sql .= " AND tc.source = '".$this->db->escape($source)."'";
1658 }
1659 if (!empty($code)) {
1660 $sql .= " AND tc.code = '".$this->db->escape($code)."'";
1661 }
1662 $sql .= $this->db->order($order, 'ASC');
1663
1664 //print "sql=".$sql;
1665 $resql = $this->db->query($sql);
1666 if (!$resql) {
1667 $this->error = $this->db->lasterror();
1668 //dol_print_error($this->db);
1669 return null;
1670 }
1671
1672 $num = $this->db->num_rows($resql);
1673 $i = 0;
1674 while ($i < $num) {
1675 $obj = $this->db->fetch_object($resql);
1676
1677 $transkey = "TypeContact_".$this->element."_".$source."_".$obj->code;
1678 $libelle_type = ($langs->trans($transkey) != $transkey ? $langs->trans($transkey) : $obj->type_label);
1679 if (empty($option)) {
1680 $tab[$obj->rowid] = $libelle_type;
1681 } elseif ($option == 1) {
1682 $tab[$obj->code] = $libelle_type;
1683 } else {
1684 $tab[$obj->rowid] = array('id' => $obj->rowid, 'code' => $obj->code, 'label' => $libelle_type);
1685 }
1686 $i++;
1687 }
1688
1689 return $tab;
1690 }
1691
1703 public function listeTypeContacts($source = 'internal', $option = 0, $activeonly = 0, $code = '', $element = '', $excludeelement = '')
1704 {
1705 global $langs;
1706
1707 $langs->loadLangs(array('bills', 'contracts', 'interventions', 'orders', 'projects', 'propal', 'ticket', 'agenda'));
1708
1709 $tab = array();
1710
1711 $sql = "SELECT DISTINCT tc.rowid, tc.code, tc.libelle as type_label, tc.position, tc.element, tc.module";
1712 $sql .= " FROM ".$this->db->prefix()."c_type_contact as tc";
1713
1714 $sqlWhere = array();
1715 if (!empty($element)) {
1716 $sqlWhere[] = " tc.element='".$this->db->escape($element)."'";
1717 }
1718 if (!empty($excludeelement)) {
1719 $sqlWhere[] = " tc.element <> '".$this->db->escape($excludeelement)."'";
1720 }
1721
1722 if ($activeonly == 1) {
1723 $sqlWhere[] = " tc.active=1"; // only the active types
1724 }
1725
1726 if (!empty($source) && $source != 'all') {
1727 $sqlWhere[] = " tc.source='".$this->db->escape($source)."'";
1728 }
1729
1730 if (!empty($code)) {
1731 $sqlWhere[] = " tc.code='".$this->db->escape($code)."'";
1732 }
1733
1734 if (count($sqlWhere) > 0) {
1735 $sql .= " WHERE ".implode(' AND ', $sqlWhere);
1736 }
1737
1738 $sql .= $this->db->order('tc.element, tc.position', 'ASC');
1739
1740 dol_syslog(__METHOD__, LOG_DEBUG);
1741 $resql = $this->db->query($sql);
1742 if ($resql) {
1743 $num = $this->db->num_rows($resql);
1744 if ($num > 0) {
1745 $langs->loadLangs(array("propal", "orders", "bills", "suppliers", "contracts", "supplier_proposal"));
1746
1747 while ($obj = $this->db->fetch_object($resql)) {
1748 $modulename = $obj->module ?? $obj->element;
1749 if (strpos($obj->element, 'project') !== false) {
1750 $modulename = 'projet';
1751 } elseif ($obj->element == 'contrat') {
1752 $element = 'contract';
1753 } elseif ($obj->element == 'action') {
1754 $modulename = 'agenda';
1755 } elseif (strpos($obj->element, 'supplier') !== false && $obj->element != 'supplier_proposal') {
1756 $modulename = 'fournisseur';
1757 }
1758 if (isModEnabled($modulename)) {
1759 $libelle_element = $langs->trans('ContactDefault_'.$obj->element);
1760 $tmpelement = $obj->element;
1761 $transkey = "TypeContact_".$tmpelement."_".$source."_".$obj->code;
1762 $libelle_type = ($langs->trans($transkey) != $transkey ? $langs->trans($transkey) : $obj->type_label);
1763 $tab[$obj->rowid] = $libelle_element.' - '.$libelle_type;
1764 }
1765 }
1766 }
1767 return $tab;
1768 } else {
1769 $this->error = $this->db->lasterror();
1770 return null;
1771 }
1772 }
1773
1785 public function getIdContact($source, $code, $status = 0)
1786 {
1787 $result = array();
1788 $i = 0;
1789 // Particular case for shipping
1790 if ($this->element == 'shipping' && $this->origin_id != 0) {
1791 $id = $this->origin_id;
1792 $element = 'commande';
1793 } elseif ($this->element == 'reception' && $this->origin_id != 0) {
1794 $id = $this->origin_id;
1795 $element = 'order_supplier';
1796 } else {
1797 $id = $this->id;
1798 $element = $this->element;
1799 }
1800
1801 $sql = "SELECT ec.fk_socpeople";
1802 $sql .= " FROM ".$this->db->prefix()."element_contact as ec,";
1803 if ($source == 'internal') {
1804 $sql .= " ".$this->db->prefix()."user as c,";
1805 }
1806 if ($source == 'external') {
1807 $sql .= " ".$this->db->prefix()."socpeople as c,";
1808 }
1809 $sql .= " ".$this->db->prefix()."c_type_contact as tc";
1810 $sql .= " WHERE ec.element_id = ".((int) $id);
1811 $sql .= " AND ec.fk_socpeople = c.rowid";
1812 if ($source == 'internal') {
1813 $sql .= " AND c.entity IN (".getEntity('user').")";
1814 }
1815 if ($source == 'external') {
1816 $sql .= " AND c.entity IN (".getEntity('societe').")";
1817 }
1818 $sql .= " AND ec.fk_c_type_contact = tc.rowid";
1819 $sql .= " AND tc.element = '".$this->db->escape($element)."'";
1820 $sql .= " AND tc.source = '".$this->db->escape($source)."'";
1821 if ($code) {
1822 $sql .= " AND tc.code = '".$this->db->escape($code)."'";
1823 }
1824 $sql .= " AND tc.active = 1";
1825 if ($status) {
1826 $sql .= " AND ec.statut = ".((int) $status);
1827 }
1828
1829 dol_syslog(get_class($this)."::getIdContact", LOG_DEBUG);
1830 $resql = $this->db->query($sql);
1831 if ($resql) {
1832 while ($obj = $this->db->fetch_object($resql)) {
1833 $result[$i] = $obj->fk_socpeople;
1834 $i++;
1835 }
1836 } else {
1837 $this->error = $this->db->error();
1838 return null;
1839 }
1840
1841 return $result;
1842 }
1843
1844 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
1851 public function fetch_contact($contactid = null)
1852 {
1853 // phpcs:enable
1854 if (empty($contactid)) {
1855 $contactid = $this->contact_id;
1856 }
1857
1858 if (empty($contactid)) {
1859 return 0;
1860 }
1861
1862 require_once DOL_DOCUMENT_ROOT.'/contact/class/contact.class.php';
1863 $contact = new Contact($this->db);
1864 $result = $contact->fetch($contactid);
1865 $this->contact = $contact;
1866 return $result;
1867 }
1868
1869 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
1877 public function fetch_thirdparty($force_thirdparty_id = 0)
1878 {
1879 // phpcs:enable
1880 if (empty($this->socid) && empty($this->fk_soc) && empty($force_thirdparty_id)) {
1881 return 0;
1882 }
1883
1884 require_once DOL_DOCUMENT_ROOT.'/societe/class/societe.class.php';
1885
1886 $idtofetch = isset($this->socid) ? $this->socid : (isset($this->fk_soc) ? $this->fk_soc : 0);
1887 if ($force_thirdparty_id) {
1888 $idtofetch = $force_thirdparty_id;
1889 }
1890
1891 if ($idtofetch) {
1892 $thirdparty = new Societe($this->db);
1893 $result = $thirdparty->fetch($idtofetch);
1894 if ($result < 0) {
1895 $this->errors = array_merge($this->errors, $thirdparty->errors);
1896 }
1897 $this->thirdparty = $thirdparty;
1898
1899 // Use first price level if level not defined for third party
1900 if ((getDolGlobalString('PRODUIT_MULTIPRICES') || getDolGlobalString('PRODUIT_CUSTOMER_PRICES_AND_MULTIPRICES')) && empty($this->thirdparty->price_level)) {
1901 $this->thirdparty->price_level = 1;
1902 }
1903
1904 return $result;
1905 } else {
1906 return -1;
1907 }
1908 }
1909
1910
1918 public function fetchOneLike($ref)
1919 {
1920 if (!$this->table_ref_field) {
1921 return 0;
1922 }
1923
1924 $sql = "SELECT rowid FROM ".$this->db->prefix().$this->table_element;
1925 $sql .= " WHERE ".$this->table_ref_field." LIKE '".$this->db->escape($ref)."'"; // no escapeforlike here
1926 $sql .= " LIMIT 1";
1927
1928 $query = $this->db->query($sql);
1929
1930 if (!$this->db->num_rows($query)) {
1931 return 0;
1932 }
1933
1934 $result = $this->db->fetch_object($query);
1935
1936 if (method_exists($this, 'fetch')) {
1937 return $this->fetch($result->rowid);
1938 } else {
1939 $this->error = 'Fetch method not implemented on '.get_class($this);
1940 dol_syslog(get_class($this).'::fetchOneLike Error='.$this->error, LOG_ERR);
1941 array_push($this->errors, $this->error);
1942 return -1;
1943 }
1944 }
1945
1946 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
1955 public function fetch_barcode()
1956 {
1957 // phpcs:enable
1958 return $this->fetchBarCode();
1959 }
1960
1968 public function fetchBarCode()
1969 {
1970 dol_syslog(get_class($this).'::fetchBarCode this->element='.$this->element.' this->barcode_type='.$this->barcode_type);
1971
1972 $idtype = $this->barcode_type;
1973 if (empty($idtype) && $idtype != '0') { // If type of barcode no set, we try to guess. If set to '0' it means we forced to have type remain not defined
1974 if ($this->element == 'product' && getDolGlobalString('PRODUIT_DEFAULT_BARCODE_TYPE')) {
1975 $idtype = getDolGlobalString('PRODUIT_DEFAULT_BARCODE_TYPE');
1976 } elseif ($this->element == 'societe') {
1977 $idtype = getDolGlobalString('GENBARCODE_BARCODETYPE_THIRDPARTY');
1978 } else {
1979 dol_syslog('Call fetchBarCode with barcode_type not defined and cannot be guessed', LOG_WARNING);
1980 }
1981 }
1982
1983 if ($idtype > 0) {
1984 if (empty($this->barcode_type) || empty($this->barcode_type_code) || empty($this->barcode_type_label) || empty($this->barcode_type_coder)) { // If data not already loaded
1985 $sql = "SELECT rowid, code, libelle as label, coder";
1986 $sql .= " FROM ".$this->db->prefix()."c_barcode_type";
1987 $sql .= " WHERE rowid = ".((int) $idtype);
1988
1989 $resql = $this->db->query($sql);
1990 if ($resql) {
1991 $obj = $this->db->fetch_object($resql);
1992
1993 $this->barcode_type = $obj->rowid;
1994 $this->barcode_type_code = $obj->code;
1995 $this->barcode_type_label = $obj->label;
1996 $this->barcode_type_coder = $obj->coder;
1997 return 1;
1998 } else {
1999 dol_print_error($this->db);
2000 return -1;
2001 }
2002 }
2003 }
2004 return 0;
2005 }
2006
2012 public function fetchProject()
2013 {
2014 include_once DOL_DOCUMENT_ROOT.'/projet/class/project.class.php';
2015
2016 if (empty($this->fk_project) && !empty($this->fk_projet)) {
2017 $this->fk_project = $this->fk_projet; // For backward compatibility
2018 }
2019 if (empty($this->fk_project)) {
2020 return 0;
2021 }
2022
2023 $project = new Project($this->db);
2024 $result = $project->fetch($this->fk_project);
2025
2026 $this->projet = $project; // deprecated
2027 $this->project = $project;
2028
2029 return $result;
2030 }
2031
2032 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
2040 public function fetch_project()
2041 {
2042 // phpcs:enable
2043 return $this->fetchProject();
2044 }
2045
2046 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
2054 public function fetch_projet()
2055 {
2056 // phpcs:enable
2057 return $this->fetchProject();
2058 }
2059
2060 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
2066 public function fetch_product()
2067 {
2068 // phpcs:enable
2069 include_once DOL_DOCUMENT_ROOT.'/product/class/product.class.php';
2070
2071 // @phan-suppress-next-line PhanUndeclaredProperty
2072 if (empty($this->fk_product)) {
2073 return 0;
2074 }
2075
2076 $product = new Product($this->db);
2077 // @phan-suppress-next-line PhanUndeclaredProperty
2078 $result = $product->fetch($this->fk_product);
2079
2080 $this->product = $product;
2081 return $result;
2082 }
2083
2084 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
2091 public function fetch_user($userid)
2092 {
2093 // phpcs:enable
2094 $user = new User($this->db);
2095 $result = $user->fetch($userid);
2096 $this->user = $user;
2097 return $result;
2098 }
2099
2100 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
2107 public function fetch_origin()
2108 {
2109 // phpcs:enable
2110 $origin = $this->origin ? $this->origin : $this->origin_type;
2111
2112 // Manage classes with non standard name
2113 if ($origin == 'shipping') {
2114 $origin = 'expedition';
2115 }
2116 if ($origin == 'delivery') {
2117 $origin = 'livraison';
2118 }
2119 if ($origin == 'order_supplier' || $origin == 'supplier_order') {
2120 $origin = 'commandeFournisseur';
2121 }
2122
2123 $classname = ucfirst($origin);
2124 $this->origin_object = new $classname($this->db);
2125 // @phan-suppress-next-line PhanPluginUnknownObjectMethodCall
2126 $this->origin_object->fetch($this->origin_id);
2127 }
2128
2138 public function fetchObjectFrom($table, $field, $key, $element = null)
2139 {
2140 global $conf;
2141
2142 $result = false;
2143
2144 $sql = "SELECT rowid FROM ".$this->db->prefix().$table;
2145 $sql .= " WHERE ".$field." = '".$this->db->escape($key)."'";
2146 if (!empty($element)) {
2147 $sql .= " AND entity IN (".getEntity($element).")";
2148 } else {
2149 $sql .= " AND entity = ".((int) $conf->entity);
2150 }
2151
2152 dol_syslog(get_class($this).'::fetchObjectFrom', LOG_DEBUG);
2153 $resql = $this->db->query($sql);
2154 if ($resql) {
2155 $obj = $this->db->fetch_object($resql);
2156 // Test for avoid error -1
2157 if ($obj) {
2158 if (method_exists($this, 'fetch')) {
2159 $result = $this->fetch($obj->rowid);
2160 } else {
2161 $this->error = 'fetch() method not implemented on '.get_class($this);
2162 dol_syslog(get_class($this).'::fetchOneLike Error='.$this->error, LOG_ERR);
2163 array_push($this->errors, $this->error);
2164 $result = -1;
2165 }
2166 }
2167 }
2168
2169 return $result;
2170 }
2171
2180 public function getValueFrom($table, $id, $field)
2181 {
2182 $result = false;
2183 if (!empty($id) && !empty($field) && !empty($table)) {
2184 $sql = "SELECT ".$field." FROM ".$this->db->prefix().$table;
2185 $sql .= " WHERE rowid = ".((int) $id);
2186
2187 dol_syslog(get_class($this).'::getValueFrom', LOG_DEBUG);
2188 $resql = $this->db->query($sql);
2189 if ($resql) {
2190 $row = $this->db->fetch_row($resql);
2191 $result = $row[0];
2192 }
2193 }
2194 return $result;
2195 }
2196
2213 public function setValueFrom($field, $value, $table = '', $id = null, $format = '', $id_field = '', $fuser = null, $trigkey = '', $fk_user_field = 'fk_user_modif')
2214 {
2215 global $user;
2216
2217 if (empty($table)) {
2218 $table = $this->table_element;
2219 }
2220 if (empty($id)) {
2221 $id = $this->id;
2222 }
2223 if (empty($format)) {
2224 $format = 'text';
2225 }
2226 if (empty($id_field)) {
2227 $id_field = 'rowid';
2228 }
2229
2230 // Special case
2231 if ($table == 'product' && $field == 'note_private') {
2232 $field = 'note';
2233 }
2234
2235 if (in_array($table, array('actioncomm', 'adherent', 'advtargetemailing', 'cronjob', 'establishment'))) {
2236 $fk_user_field = 'fk_user_mod';
2237 }
2238 if (in_array($table, array('prelevement_bons'))) { // TODO Add a field fk_user_modif into llx_prelevement_bons
2239 $fk_user_field = '';
2240 }
2241
2242 $oldvalue = null;
2243 if ($trigkey) {
2244 $sql = "SELECT " . $field;
2245 $sql .= " FROM " . MAIN_DB_PREFIX . $table;
2246 $sql .= " WHERE " . $id_field . " = " . ((int) $id);
2247
2248 $resql = $this->db->query($sql);
2249 if ($resql) {
2250 if ($obj = $this->db->fetch_object($resql)) {
2251 if ($format == 'date') {
2252 $oldvalue = $this->db->jdate($obj->$field);
2253 } else {
2254 $oldvalue = $obj->$field;
2255 }
2256 }
2257 } else {
2258 $this->error = $this->db->lasterror();
2259 return -1;
2260 }
2261 }
2262
2263 $error = 0;
2264
2265 dol_syslog(__METHOD__, LOG_DEBUG);
2266
2267 $this->db->begin();
2268
2269 $sql = "UPDATE ".$this->db->prefix().$table." SET ";
2270
2271 if ($format == 'text') {
2272 $sql .= $field." = '".$this->db->escape($value)."'";
2273 } elseif ($format == 'int') {
2274 $sql .= $field." = ".((int) $value);
2275 } elseif ($format == 'date') {
2276 $sql .= $field." = ".($value ? "'".$this->db->idate($value)."'" : "null");
2277 } elseif ($format == 'dategmt') {
2278 $sql .= $field." = ".($value ? "'".$this->db->idate($value, 'gmt')."'" : "null");
2279 }
2280
2281 if ($fk_user_field) {
2282 if (!empty($fuser) && is_object($fuser)) {
2283 $sql .= ", ".$fk_user_field." = ".((int) $fuser->id);
2284 } elseif (empty($fuser) || $fuser != 'none') {
2285 $sql .= ", ".$fk_user_field." = ".((int) $user->id);
2286 }
2287 }
2288
2289 $sql .= " WHERE ".$id_field." = ".((int) $id);
2290
2291 $resql = $this->db->query($sql);
2292 if ($resql) {
2293 if ($trigkey) {
2294 // call trigger with updated object values
2295 if (method_exists($this, 'fetch')) {
2296 $result = $this->fetch($id);
2297 } else {
2298 $result = $this->fetchCommon($id);
2299 }
2300 $this->oldcopy = clone $this;
2301 if (property_exists($this->oldcopy, $field)) {
2302 $this->oldcopy->$field = $oldvalue;
2303 }
2304
2305 if ($result >= 0) {
2306 $result = $this->call_trigger($trigkey, (!empty($fuser) && is_object($fuser)) ? $fuser : $user); // This may set this->errors
2307 }
2308 if ($result < 0) {
2309 $error++;
2310 }
2311 }
2312
2313 if (!$error) {
2314 if (property_exists($this, $field)) {
2315 $this->$field = $value;
2316 }
2317 $this->db->commit();
2318 return 1;
2319 } else {
2320 $this->db->rollback();
2321 return -2;
2322 }
2323 } else {
2324 if ($this->db->lasterrno() == 'DB_ERROR_RECORD_ALREADY_EXISTS') {
2325 $this->error = 'DB_ERROR_RECORD_ALREADY_EXISTS';
2326 } else {
2327 $this->error = $this->db->lasterror();
2328 }
2329 $this->db->rollback();
2330 return -1;
2331 }
2332 }
2333
2334 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
2345 public function load_previous_next_ref($filter, $fieldid, $nodbprefix = 0)
2346 {
2347 // phpcs:enable
2348 global $conf, $user;
2349
2350 if (!$this->table_element) {
2351 dol_print_error(null, get_class($this)."::load_previous_next_ref was called on object with property table_element not defined");
2352 return -1;
2353 }
2354 if ($fieldid == 'none') {
2355 return 1;
2356 }
2357
2358 // For backward compatibility
2359 if (in_array($this->table_element, array('facture_rec', 'facture_fourn_rec')) && $fieldid == 'title') {
2360 $fieldid = 'titre';
2361 }
2362
2363 // Security on socid
2364 $socid = 0;
2365 if ($user->socid > 0) {
2366 $socid = $user->socid;
2367 }
2368
2369 // this->ismultientitymanaged contains
2370 // 0=No test on entity, 1=Test with field entity, 'field@table'=Test with link by field@table
2371 $aliastablesociete = 's';
2372 if ($this->element == 'societe') {
2373 $aliastablesociete = 'te'; // te as table_element
2374 }
2375 $restrictiononfksoc = empty($this->restrictiononfksoc) ? 0 : $this->restrictiononfksoc;
2376 $sql = "SELECT MAX(te.".$fieldid.")";
2377 $sql .= " FROM ".(empty($nodbprefix) ? $this->db->prefix() : '').$this->table_element." as te";
2378 if (isset($this->ismultientitymanaged) && !is_numeric($this->ismultientitymanaged)) {
2379 $tmparray = explode('@', $this->ismultientitymanaged);
2380 $sql .= ", ".$this->db->prefix().$tmparray[1]." as ".($tmparray[1] == 'societe' ? 's' : 'parenttable'); // If we need to link to this table to limit select to entity
2381 } elseif ($restrictiononfksoc == 1 && $this->element != 'societe' && !$user->hasRight('societe', 'client', 'voir') && !$socid) {
2382 $sql .= ", ".$this->db->prefix()."societe as s"; // If we need to link to societe to limit select to socid
2383 } elseif ($restrictiononfksoc == 2 && $this->element != 'societe' && !$user->hasRight('societe', 'client', 'voir') && !$socid) {
2384 $sql .= " LEFT JOIN ".$this->db->prefix()."societe as s ON te.fk_soc = s.rowid"; // If we need to link to societe to limit select to socid
2385 }
2386 if ($restrictiononfksoc && !$user->hasRight('societe', 'client', 'voir') && !$socid) {
2387 $sql .= " LEFT JOIN ".$this->db->prefix()."societe_commerciaux as sc ON ".$aliastablesociete.".rowid = sc.fk_soc";
2388 }
2389 if ($fieldid == 'rowid') {
2390 $sql .= " WHERE te.".$fieldid." < ".((int) $this->id);
2391 } else {
2392 $sql .= " WHERE te.".$fieldid." < '".$this->db->escape($this->ref)."'"; // ->ref must always be defined (set to id if field does not exists)
2393 }
2394 if ($restrictiononfksoc == 1 && !$user->hasRight('societe', 'client', 'voir') && !$socid) {
2395 $sql .= " AND sc.fk_user = ".((int) $user->id);
2396 }
2397 if ($restrictiononfksoc == 2 && !$user->hasRight('societe', 'client', 'voir') && !$socid) {
2398 $sql .= " AND (sc.fk_user = ".((int) $user->id).' OR te.fk_soc IS NULL)';
2399 }
2400
2401 $filtermax = $filter;
2402
2403 // Manage filter
2404 $errormessage = '';
2405 $tmpsql = forgeSQLFromUniversalSearchCriteria($filtermax, $errormessage);
2406 if ($errormessage) {
2407 if (!preg_match('/^\s*AND/i', $filtermax)) {
2408 $sql .= " AND ";
2409 }
2410 $sql .= $filtermax;
2411 } else {
2412 $sql .= $tmpsql;
2413 }
2414
2415 if (isset($this->ismultientitymanaged) && !is_numeric($this->ismultientitymanaged)) {
2416 $tmparray = explode('@', $this->ismultientitymanaged);
2417 $sql .= " AND te.".$tmparray[0]." = ".($tmparray[1] == "societe" ? "s" : "parenttable").".rowid"; // If we need to link to this table to limit select to entity
2418 } elseif ($restrictiononfksoc == 1 && $this->element != 'societe' && !$user->hasRight('societe', 'client', 'voir') && !$socid) {
2419 $sql .= ' AND te.fk_soc = s.rowid'; // If we need to link to societe to limit select to socid
2420 }
2421 if (isset($this->ismultientitymanaged) && $this->ismultientitymanaged == 1) {
2422 if ($this->element == 'user' && getDolGlobalInt('MULTICOMPANY_TRANSVERSE_MODE')) {
2423 if (!empty($user->admin) && empty($user->entity) && $conf->entity == 1) {
2424 $sql .= " AND te.entity IS NOT NULL"; // Show all users
2425 } else {
2426 $sql .= " AND te.rowid IN (SELECT ug.fk_user FROM ".$this->db->prefix()."usergroup_user as ug WHERE ug.entity IN (".getEntity('usergroup')."))";
2427 }
2428 } else {
2429 $sql .= ' AND te.entity IN ('.getEntity($this->element).')';
2430 }
2431 }
2432 if (isset($this->ismultientitymanaged) && !is_numeric($this->ismultientitymanaged) && $this->element != 'societe') {
2433 $tmparray = explode('@', $this->ismultientitymanaged);
2434 $sql .= ' AND parenttable.entity IN ('.getEntity($tmparray[1]).')';
2435 }
2436 if ($restrictiononfksoc == 1 && $socid && $this->element != 'societe') {
2437 $sql .= ' AND te.fk_soc = '.((int) $socid);
2438 }
2439 if ($restrictiononfksoc == 2 && $socid && $this->element != 'societe') {
2440 $sql .= ' AND (te.fk_soc = '.((int) $socid).' OR te.fk_soc IS NULL)';
2441 }
2442 if ($restrictiononfksoc && $socid && $this->element == 'societe') {
2443 $sql .= ' AND te.rowid = '.((int) $socid);
2444 }
2445 //print 'socid='.$socid.' restrictiononfksoc='.$restrictiononfksoc.' ismultientitymanaged = '.$this->ismultientitymanaged.' filter = '.$filter.' -> '.$sql."<br>";
2446
2447 $result = $this->db->query($sql);
2448 if (!$result) {
2449 $this->error = $this->db->lasterror();
2450 return -1;
2451 }
2452 $row = $this->db->fetch_row($result);
2453 $this->ref_previous = $row[0];
2454
2455 $sql = "SELECT MIN(te.".$fieldid.")";
2456 $sql .= " FROM ".(empty($nodbprefix) ? $this->db->prefix() : '').$this->table_element." as te";
2457 if (isset($this->ismultientitymanaged) && !is_numeric($this->ismultientitymanaged)) {
2458 $tmparray = explode('@', $this->ismultientitymanaged);
2459 $sql .= ", ".$this->db->prefix().$tmparray[1]." as ".($tmparray[1] == 'societe' ? 's' : 'parenttable'); // If we need to link to this table to limit select to entity
2460 } elseif ($restrictiononfksoc == 1 && $this->element != 'societe' && !$user->hasRight('societe', 'client', 'voir') && !$socid) {
2461 $sql .= ", ".$this->db->prefix()."societe as s"; // If we need to link to societe to limit select to socid
2462 } elseif ($restrictiononfksoc == 2 && $this->element != 'societe' && !$user->hasRight('societe', 'client', 'voir') && !$socid) {
2463 $sql .= " LEFT JOIN ".$this->db->prefix()."societe as s ON te.fk_soc = s.rowid"; // If we need to link to societe to limit select to socid
2464 }
2465 if ($restrictiononfksoc && !$user->hasRight('societe', 'client', 'voir') && !$socid) {
2466 $sql .= " LEFT JOIN ".$this->db->prefix()."societe_commerciaux as sc ON ".$aliastablesociete.".rowid = sc.fk_soc";
2467 }
2468 if ($fieldid == 'rowid') {
2469 $sql .= " WHERE te.".$fieldid." > ".((int) $this->id);
2470 } else {
2471 $sql .= " WHERE te.".$fieldid." > '".$this->db->escape($this->ref)."'"; // ->ref must always be defined (set to id if field does not exists)
2472 }
2473 if ($restrictiononfksoc == 1 && !$user->hasRight('societe', 'client', 'voir') && !$socid) {
2474 $sql .= " AND (sc.fk_user = ".((int) $user->id);
2475 if (getDolGlobalInt('MAIN_SEE_SUBORDINATES')) {
2476 $userschilds = $user->getAllChildIds();
2477 $sql .= " OR sc.fk_user IN (".$this->db->sanitize(implode(',', $userschilds)).")";
2478 }
2479 $sql .= ')';
2480 }
2481 if ($restrictiononfksoc == 2 && !$user->hasRight('societe', 'client', 'voir') && !$socid) {
2482 $sql .= " AND (sc.fk_user = ".((int) $user->id).' OR te.fk_soc IS NULL)';
2483 }
2484
2485 $filtermin = $filter;
2486
2487 // Manage filter
2488 $errormessage = '';
2489 $tmpsql = forgeSQLFromUniversalSearchCriteria($filtermin, $errormessage);
2490 if ($errormessage) {
2491 if (!preg_match('/^\s*AND/i', $filtermin)) {
2492 $sql .= " AND ";
2493 }
2494 $sql .= $filtermin;
2495
2496 $filtermin = '';
2497 } else {
2498 $sql .= $tmpsql;
2499 }
2500
2501 if (isset($this->ismultientitymanaged) && !is_numeric($this->ismultientitymanaged)) {
2502 $tmparray = explode('@', $this->ismultientitymanaged);
2503 $sql .= " AND te.".$tmparray[0]." = ".($tmparray[1] == "societe" ? "s" : "parenttable").".rowid"; // If we need to link to this table to limit select to entity
2504 } elseif ($restrictiononfksoc == 1 && $this->element != 'societe' && !$user->hasRight('societe', 'client', 'voir') && !$socid) {
2505 $sql .= ' AND te.fk_soc = s.rowid'; // If we need to link to societe to limit select to socid
2506 }
2507 if (isset($this->ismultientitymanaged) && $this->ismultientitymanaged == 1) {
2508 if ($this->element == 'user' && getDolGlobalInt('MULTICOMPANY_TRANSVERSE_MODE')) {
2509 if (!empty($user->admin) && empty($user->entity) && $conf->entity == 1) {
2510 $sql .= " AND te.entity IS NOT NULL"; // Show all users
2511 } else {
2512 $sql .= " AND te.rowid IN (SELECT ug.fk_user FROM ".$this->db->prefix()."usergroup_user as ug WHERE ug.entity IN (".getEntity('usergroup')."))";
2513 }
2514 } else {
2515 $sql .= ' AND te.entity IN ('.getEntity($this->element).')';
2516 }
2517 }
2518 if (isset($this->ismultientitymanaged) && !is_numeric($this->ismultientitymanaged) && $this->element != 'societe') {
2519 $tmparray = explode('@', $this->ismultientitymanaged);
2520 $sql .= ' AND parenttable.entity IN ('.getEntity($tmparray[1]).')';
2521 }
2522 if ($restrictiononfksoc == 1 && $socid && $this->element != 'societe') {
2523 $sql .= ' AND te.fk_soc = '.((int) $socid);
2524 }
2525 if ($restrictiononfksoc == 2 && $socid && $this->element != 'societe') {
2526 $sql .= ' AND (te.fk_soc = '.((int) $socid).' OR te.fk_soc IS NULL)';
2527 }
2528 if ($restrictiononfksoc && $socid && $this->element == 'societe') {
2529 $sql .= ' AND te.rowid = '.((int) $socid);
2530 }
2531 //print 'socid='.$socid.' restrictiononfksoc='.$restrictiononfksoc.' ismultientitymanaged = '.$this->ismultientitymanaged.' filter = '.$filter.' -> '.$sql."<br>";
2532 // Rem: Bug in some mysql version: SELECT MIN(rowid) FROM llx_socpeople WHERE rowid > 1 when one row in database with rowid=1, returns 1 instead of null
2533
2534 $result = $this->db->query($sql);
2535 if (!$result) {
2536 $this->error = $this->db->lasterror();
2537 return -2;
2538 }
2539 $row = $this->db->fetch_row($result);
2540 $this->ref_next = $row[0];
2541
2542 return 1;
2543 }
2544
2545
2553 public function getListContactId($source = 'external')
2554 {
2555 $contactAlreadySelected = array();
2556 $tab = $this->liste_contact(-1, $source);
2557 $num = count($tab);
2558 $i = 0;
2559 while ($i < $num) {
2560 if ($source == 'thirdparty') {
2561 $contactAlreadySelected[$i] = $tab[$i]['socid'];
2562 } else {
2563 $contactAlreadySelected[$i] = $tab[$i]['id'];
2564 }
2565 $i++;
2566 }
2567 return $contactAlreadySelected;
2568 }
2569
2570
2578 public function setProject($projectid, $notrigger = 0)
2579 {
2580 global $user;
2581 $error = 0;
2582
2583 if (!$this->table_element) {
2584 dol_syslog(get_class($this)."::setProject was called on object with property table_element not defined", LOG_ERR);
2585 return -1;
2586 }
2587
2588 $sql = "UPDATE ".$this->db->prefix().$this->table_element;
2589 // @phan-suppress-next-line PhanTypeMismatchProperty
2590 if (!empty($this->fields['fk_project'])) { // Common case
2591 if ($projectid) {
2592 $sql .= " SET fk_project = ".((int) $projectid);
2593 } else {
2594 $sql .= " SET fk_project = NULL";
2595 }
2596 $sql .= ' WHERE rowid = '.((int) $this->id);
2597 } elseif ($this->table_element == 'actioncomm') { // Special case for actioncomm
2598 if ($projectid) {
2599 $sql .= " SET fk_project = ".((int) $projectid);
2600 } else {
2601 $sql .= " SET fk_project = NULL";
2602 }
2603 $sql .= ' WHERE id = '.((int) $this->id);
2604 } else { // Special case for old architecture objects
2605 if ($projectid) {
2606 $sql .= ' SET fk_projet = '.((int) $projectid);
2607 } else {
2608 $sql .= ' SET fk_projet = NULL';
2609 }
2610 $sql .= " WHERE rowid = ".((int) $this->id);
2611 }
2612
2613 $this->db->begin();
2614
2615 dol_syslog(get_class($this)."::setProject", LOG_DEBUG);
2616 if ($this->db->query($sql)) {
2617 $this->fk_project = ((int) $projectid);
2618 } else {
2619 dol_print_error($this->db);
2620 $error++;
2621 }
2622
2623 // Triggers
2624 if (!$error && !$notrigger) {
2625 // Call triggers
2626 $result = $this->call_trigger(strtoupper($this->element) . '_MODIFY', $user);
2627 if ($result < 0) {
2628 $error++;
2629 } //Do also here what you must do to rollback action if trigger fail
2630 // End call triggers
2631 }
2632
2633 // Commit or rollback
2634 if ($error) {
2635 $this->db->rollback();
2636 return -1;
2637 } else {
2638 $this->db->commit();
2639 return 1;
2640 }
2641 }
2642
2649 public function setPaymentMethods($id)
2650 {
2651 global $user;
2652
2653 $error = 0;
2654 $notrigger = 0;
2655
2656 dol_syslog(get_class($this).'::setPaymentMethods('.$id.')');
2657
2658 if ($this->status >= 0 || $this->element == 'societe') {
2659 // TODO uniformize field name
2660 $fieldname = 'fk_mode_reglement';
2661 if ($this->element == 'societe') {
2662 $fieldname = 'mode_reglement';
2663 }
2664 if (get_class($this) == 'Fournisseur') {
2665 $fieldname = 'mode_reglement_supplier';
2666 }
2667 if (get_class($this) == 'Tva') {
2668 $fieldname = 'fk_typepayment';
2669 }
2670 if (get_class($this) == 'Salary') {
2671 $fieldname = 'fk_typepayment';
2672 }
2673
2674 $sql = "UPDATE ".$this->db->prefix().$this->table_element;
2675 $sql .= " SET ".$fieldname." = ".(($id > 0 || $id == '0') ? ((int) $id) : 'NULL');
2676 $sql .= ' WHERE rowid='.((int) $this->id);
2677
2678 if ($this->db->query($sql)) {
2679 $this->mode_reglement_id = $id;
2680 // for supplier
2681 if (get_class($this) == 'Fournisseur') {
2682 $this->mode_reglement_supplier_id = $id;
2683 }
2684 // Triggers
2685 if (!$error && !$notrigger) {
2686 // Call triggers
2687 if (get_class($this) == 'Commande') {
2688 $result = $this->call_trigger('ORDER_MODIFY', $user);
2689 } else {
2690 $result = $this->call_trigger(strtoupper(get_class($this)).'_MODIFY', $user);
2691 }
2692 if ($result < 0) {
2693 $error++;
2694 }
2695 // End call triggers
2696 }
2697 return 1;
2698 } else {
2699 dol_syslog(get_class($this).'::setPaymentMethods Error '.$this->db->error());
2700 $this->error = $this->db->error();
2701 return -1;
2702 }
2703 } else {
2704 dol_syslog(get_class($this).'::setPaymentMethods, status of the object is incompatible');
2705 $this->error = 'Status of the object is incompatible '.$this->status;
2706 return -2;
2707 }
2708 }
2709
2716 public function setMulticurrencyCode($code)
2717 {
2718 dol_syslog(get_class($this).'::setMulticurrencyCode('.$code.')');
2719 if ($this->status >= 0 || $this->element == 'societe') {
2720 $fieldname = 'multicurrency_code';
2721
2722 $sql = 'UPDATE '.$this->db->prefix().$this->table_element;
2723 $sql .= " SET ".$fieldname." = '".$this->db->escape($code)."'";
2724 $sql .= ' WHERE rowid='.((int) $this->id);
2725
2726 if ($this->db->query($sql)) {
2727 $this->multicurrency_code = $code;
2728
2729 list($fk_multicurrency, $rate) = MultiCurrency::getIdAndTxFromCode($this->db, $code);
2730 if ($rate) {
2731 $this->setMulticurrencyRate($rate, 2);
2732 }
2733
2734 return 1;
2735 } else {
2736 dol_syslog(get_class($this).'::setMulticurrencyCode Error '.$sql.' - '.$this->db->error());
2737 $this->error = $this->db->error();
2738 return -1;
2739 }
2740 } else {
2741 dol_syslog(get_class($this).'::setMulticurrencyCode, status of the object is incompatible');
2742 $this->error = 'Status of the object is incompatible '.$this->status;
2743 return -2;
2744 }
2745 }
2746
2754 public function setMulticurrencyRate($rate, $mode = 1)
2755 {
2756 dol_syslog(get_class($this).'::setMulticurrencyRate('.$rate.', '.$mode.')');
2757 if ($this->status >= 0 || $this->element == 'societe') {
2758 $fieldname = 'multicurrency_tx';
2759
2760 $sql = 'UPDATE '.$this->db->prefix().$this->table_element;
2761 $sql .= " SET ".$fieldname." = ".((float) $rate);
2762 $sql .= ' WHERE rowid='.((int) $this->id);
2763
2764 if ($this->db->query($sql)) {
2765 $this->multicurrency_tx = $rate;
2766
2767 // Update line price
2768 if (!empty($this->lines)) {
2769 foreach ($this->lines as &$line) {
2770 // Amounts in company currency will be recalculated
2771 if ($mode == 1) {
2772 $line->subprice = 0;
2773 }
2774
2775 // Amounts in foreign currency will be recalculated
2776 if ($mode == 2) {
2777 $line->multicurrency_subprice = 0;
2778 }
2779
2780 switch ($this->element) {
2781 case 'propal':
2784 '@phan-var-force Propal $this';
2785 '@phan-var-force PropaleLigne $line';
2786 $this->updateline(
2787 $line->id,
2788 $line->subprice,
2789 $line->qty,
2790 $line->remise_percent,
2791 $line->tva_tx,
2792 $line->localtax1_tx,
2793 $line->localtax2_tx,
2794 ($line->description ? $line->description : $line->desc),
2795 'HT',
2796 $line->info_bits,
2797 $line->special_code,
2798 $line->fk_parent_line,
2799 $line->skip_update_total,
2800 $line->fk_fournprice,
2801 $line->pa_ht,
2802 $line->label,
2803 $line->product_type,
2804 $line->date_start,
2805 $line->date_end,
2806 $line->array_options,
2807 $line->fk_unit,
2808 $line->multicurrency_subprice
2809 );
2810 break;
2811 case 'commande':
2814 '@phan-var-force Commande $this';
2815 '@phan-var-force OrderLine $line';
2816 $this->updateline(
2817 $line->id,
2818 ($line->description ? $line->description : $line->desc),
2819 $line->subprice,
2820 $line->qty,
2821 $line->remise_percent,
2822 $line->tva_tx,
2823 $line->localtax1_tx,
2824 $line->localtax2_tx,
2825 'HT',
2826 $line->info_bits,
2827 $line->date_start,
2828 $line->date_end,
2829 $line->product_type,
2830 $line->fk_parent_line,
2831 $line->skip_update_total,
2832 $line->fk_fournprice,
2833 $line->pa_ht,
2834 $line->label,
2835 $line->special_code,
2836 $line->array_options,
2837 $line->fk_unit,
2838 $line->multicurrency_subprice
2839 );
2840 break;
2841 case 'facture':
2844 '@phan-var-force Facture $this';
2845 '@phan-var-force FactureLigne $line';
2846 $this->updateline(
2847 $line->id,
2848 ($line->description ? $line->description : $line->desc),
2849 $line->subprice,
2850 $line->qty,
2851 $line->remise_percent,
2852 $line->date_start,
2853 $line->date_end,
2854 $line->tva_tx,
2855 $line->localtax1_tx,
2856 $line->localtax2_tx,
2857 'HT',
2858 $line->info_bits,
2859 $line->product_type,
2860 $line->fk_parent_line,
2861 $line->skip_update_total,
2862 $line->fk_fournprice,
2863 $line->pa_ht,
2864 $line->label,
2865 $line->special_code,
2866 $line->array_options,
2867 $line->situation_percent,
2868 $line->fk_unit,
2869 $line->multicurrency_subprice
2870 );
2871 break;
2872 case 'supplier_proposal':
2875 '@phan-var-force SupplierProposal $this';
2876 '@phan-var-force SupplierProposalLine $line';
2877 $this->updateline(
2878 $line->id,
2879 $line->subprice,
2880 $line->qty,
2881 $line->remise_percent,
2882 $line->tva_tx,
2883 $line->localtax1_tx,
2884 $line->localtax2_tx,
2885 ($line->description ? $line->description : $line->desc),
2886 'HT',
2887 $line->info_bits,
2888 $line->special_code,
2889 $line->fk_parent_line,
2890 $line->skip_update_total,
2891 $line->fk_fournprice,
2892 $line->pa_ht,
2893 $line->label,
2894 $line->product_type,
2895 $line->array_options,
2896 $line->ref_fourn,
2897 $line->multicurrency_subprice
2898 );
2899 break;
2900 case 'order_supplier':
2903 '@phan-var-force CommandeFournisseur $this';
2904 '@phan-var-force CommandeFournisseurLigne $line';
2905 $this->updateline(
2906 $line->id,
2907 ($line->description ? $line->description : $line->desc),
2908 $line->subprice,
2909 $line->qty,
2910 $line->remise_percent,
2911 $line->tva_tx,
2912 $line->localtax1_tx,
2913 $line->localtax2_tx,
2914 'HT',
2915 $line->info_bits,
2916 $line->product_type,
2917 0,
2918 $line->date_start,
2919 $line->date_end,
2920 $line->array_options,
2921 $line->fk_unit,
2922 $line->multicurrency_subprice,
2923 $line->ref_supplier
2924 );
2925 break;
2926 case 'invoice_supplier':
2929 '@phan-var-force FactureFournisseur $this';
2930 '@phan-var-force SupplierInvoiceLIne $line';
2931 $this->updateline(
2932 $line->id,
2933 ($line->description ? $line->description : $line->desc),
2934 $line->subprice,
2935 $line->tva_tx,
2936 $line->localtax1_tx,
2937 $line->localtax2_tx,
2938 $line->qty,
2939 0,
2940 'HT',
2941 $line->info_bits,
2942 $line->product_type,
2943 $line->remise_percent,
2944 0,
2945 $line->date_start,
2946 $line->date_end,
2947 $line->array_options,
2948 $line->fk_unit,
2949 $line->multicurrency_subprice,
2950 $line->ref_supplier
2951 );
2952 break;
2953 default:
2954 dol_syslog(get_class($this).'::setMulticurrencyRate no updateline defined', LOG_DEBUG);
2955 break;
2956 }
2957 }
2958 }
2959
2960 return 1;
2961 } else {
2962 dol_syslog(get_class($this).'::setMulticurrencyRate Error '.$sql.' - '.$this->db->error());
2963 $this->error = $this->db->error();
2964 return -1;
2965 }
2966 } else {
2967 dol_syslog(get_class($this).'::setMulticurrencyRate, status of the object is incompatible');
2968 $this->error = 'Status of the object is incompatible '.$this->status;
2969 return -2;
2970 }
2971 }
2972
2980 public function setPaymentTerms($id, $deposit_percent = null)
2981 {
2982 dol_syslog(get_class($this).'::setPaymentTerms('.$id.', '.var_export($deposit_percent, true).')');
2983 if ($this->status >= 0 || $this->element == 'societe') {
2984 // TODO uniformize field name
2985 $fieldname = 'fk_cond_reglement';
2986 if ($this->element == 'societe') {
2987 $fieldname = 'cond_reglement';
2988 }
2989 if (get_class($this) == 'Fournisseur') {
2990 $fieldname = 'cond_reglement_supplier';
2991 }
2992
2993 if (empty($deposit_percent) || $deposit_percent < 0) {
2994 $deposit_percent = (float) getDictionaryValue('c_payment_term', 'deposit_percent', $id);
2995 }
2996
2997 if ($deposit_percent > 100) {
2998 $deposit_percent = 100;
2999 }
3000
3001 $sql = 'UPDATE '.$this->db->prefix().$this->table_element;
3002 $sql .= " SET ".$fieldname." = ".(($id > 0 || $id == '0') ? ((int) $id) : 'NULL');
3003 if (in_array($this->table_element, array('propal', 'commande', 'societe'))) {
3004 $sql .= " , deposit_percent = " . (empty($deposit_percent) ? 'NULL' : "'".$this->db->escape($deposit_percent)."'");
3005 }
3006 $sql .= ' WHERE rowid='.((int) $this->id);
3007
3008 if ($this->db->query($sql)) {
3009 $this->cond_reglement_id = $id;
3010 // for supplier
3011 if (get_class($this) == 'Fournisseur') {
3012 $this->cond_reglement_supplier_id = $id;
3013 }
3014 $this->cond_reglement = $id; // for compatibility
3015 $this->deposit_percent = $deposit_percent;
3016 return 1;
3017 } else {
3018 dol_syslog(get_class($this).'::setPaymentTerms Error '.$sql.' - '.$this->db->error());
3019 $this->error = $this->db->error();
3020 return -1;
3021 }
3022 } else {
3023 dol_syslog(get_class($this).'::setPaymentTerms, status of the object is incompatible');
3024 $this->error = 'Status of the object is incompatible '.$this->status;
3025 return -2;
3026 }
3027 }
3028
3035 public function setTransportMode($id)
3036 {
3037 dol_syslog(get_class($this).'::setTransportMode('.$id.')');
3038 if ($this->status >= 0 || $this->element == 'societe') {
3039 $fieldname = 'fk_transport_mode';
3040 if ($this->element == 'societe') {
3041 $fieldname = 'transport_mode';
3042 }
3043 if (get_class($this) == 'Fournisseur') {
3044 $fieldname = 'transport_mode_supplier';
3045 }
3046
3047 $sql = 'UPDATE '.$this->db->prefix().$this->table_element;
3048 $sql .= " SET ".$fieldname." = ".(($id > 0 || $id == '0') ? ((int) $id) : 'NULL');
3049 $sql .= ' WHERE rowid='.((int) $this->id);
3050
3051 if ($this->db->query($sql)) {
3052 $this->transport_mode_id = $id;
3053 // for supplier
3054 if (get_class($this) == 'Fournisseur') {
3055 $this->transport_mode_supplier_id = $id;
3056 }
3057 return 1;
3058 } else {
3059 dol_syslog(get_class($this).'::setTransportMode Error '.$sql.' - '.$this->db->error());
3060 $this->error = $this->db->error();
3061 return -1;
3062 }
3063 } else {
3064 dol_syslog(get_class($this).'::setTransportMode, status of the object is incompatible');
3065 $this->error = 'Status of the object is incompatible '.$this->status;
3066 return -2;
3067 }
3068 }
3069
3077 {
3078 dol_syslog(get_class($this).'::setRetainedWarrantyPaymentTerms('.$id.')');
3079 if ($this->status >= 0 || $this->element == 'societe') {
3080 $fieldname = 'retained_warranty_fk_cond_reglement';
3081
3082 $sql = 'UPDATE '.$this->db->prefix().$this->table_element;
3083 $sql .= " SET ".$fieldname." = ".((int) $id);
3084 $sql .= ' WHERE rowid='.((int) $this->id);
3085
3086 if ($this->db->query($sql)) {
3087 $this->retained_warranty_fk_cond_reglement = $id;
3088 return 1;
3089 } else {
3090 dol_syslog(get_class($this).'::setRetainedWarrantyPaymentTerms Error '.$sql.' - '.$this->db->error());
3091 $this->error = $this->db->error();
3092 return -1;
3093 }
3094 } else {
3095 dol_syslog(get_class($this).'::setRetainedWarrantyPaymentTerms, status of the object is incompatible');
3096 $this->error = 'Status of the object is incompatible '.$this->status;
3097 return -2;
3098 }
3099 }
3100
3108 public function setDeliveryAddress($id)
3109 {
3110 $fieldname = 'fk_delivery_address';
3111 if ($this->element == 'delivery' || $this->element == 'shipping') {
3112 $fieldname = 'fk_address';
3113 }
3114
3115 $sql = "UPDATE ".$this->db->prefix().$this->table_element." SET ".$fieldname." = ".((int) $id);
3116 $sql .= " WHERE rowid = ".((int) $this->id)." AND fk_statut = 0";
3117
3118 if ($this->db->query($sql)) {
3119 $this->fk_delivery_address = $id;
3120 return 1;
3121 } else {
3122 $this->error = $this->db->error();
3123 dol_syslog(get_class($this).'::setDeliveryAddress Error '.$this->error);
3124 return -1;
3125 }
3126 }
3127
3128
3137 public function setShippingMethod($shipping_method_id, $notrigger = 0, $userused = null)
3138 {
3139 global $user;
3140
3141 if (empty($userused)) {
3142 $userused = $user;
3143 }
3144
3145 $error = 0;
3146
3147 if (!$this->table_element) {
3148 dol_syslog(get_class($this)."::setShippingMethod was called on object with property table_element not defined", LOG_ERR);
3149 return -1;
3150 }
3151
3152 $this->db->begin();
3153
3154 if ($shipping_method_id < 0) {
3155 $shipping_method_id = 'NULL';
3156 }
3157 dol_syslog(get_class($this).'::setShippingMethod('.$shipping_method_id.')');
3158
3159 $sql = "UPDATE ".$this->db->prefix().$this->table_element;
3160 $sql .= " SET fk_shipping_method = ".((int) $shipping_method_id);
3161 $sql .= " WHERE rowid=".((int) $this->id);
3162 $resql = $this->db->query($sql);
3163 if (!$resql) {
3164 dol_syslog(get_class($this).'::setShippingMethod Error ', LOG_DEBUG);
3165 $this->error = $this->db->lasterror();
3166 $error++;
3167 } else {
3168 if (!$notrigger) {
3169 // Call trigger
3170 $this->context = array('shippingmethodupdate' => 1);
3171 $result = $this->call_trigger(strtoupper(get_class($this)).'_MODIFY', $userused);
3172 if ($result < 0) {
3173 $error++;
3174 }
3175 // End call trigger
3176 }
3177 }
3178 if ($error) {
3179 $this->db->rollback();
3180 return -1;
3181 } else {
3182 $this->shipping_method_id = ($shipping_method_id == 'NULL') ? null : $shipping_method_id;
3183 $this->db->commit();
3184 return 1;
3185 }
3186 }
3187
3188
3195 public function setWarehouse($warehouse_id)
3196 {
3197 if (!$this->table_element) {
3198 dol_syslog(get_class($this)."::setWarehouse was called on object with property table_element not defined", LOG_ERR);
3199 return -1;
3200 }
3201 if ($warehouse_id < 0) {
3202 $warehouse_id = 'NULL';
3203 }
3204 dol_syslog(get_class($this).'::setWarehouse('.$warehouse_id.')');
3205
3206 $sql = "UPDATE ".$this->db->prefix().$this->table_element;
3207 $sql .= " SET fk_warehouse = ".((int) $warehouse_id);
3208 $sql .= " WHERE rowid=".((int) $this->id);
3209
3210 if ($this->db->query($sql)) {
3211 $this->warehouse_id = ($warehouse_id == 'NULL') ? null : $warehouse_id;
3212 return 1;
3213 } else {
3214 dol_syslog(get_class($this).'::setWarehouse Error ', LOG_DEBUG);
3215 $this->error = $this->db->error();
3216 return 0;
3217 }
3218 }
3219
3220
3228 public function setDocModel($user, $modelpdf)
3229 {
3230 if (!$this->table_element) {
3231 dol_syslog(get_class($this)."::setDocModel was called on object with property table_element not defined", LOG_ERR);
3232 return -1;
3233 }
3234
3235 $newmodelpdf = dol_trunc($modelpdf, 255);
3236
3237 $sql = "UPDATE ".$this->db->prefix().$this->table_element;
3238 $sql .= " SET model_pdf = '".$this->db->escape($newmodelpdf)."'";
3239 $sql .= " WHERE rowid = ".((int) $this->id);
3240
3241 dol_syslog(get_class($this)."::setDocModel", LOG_DEBUG);
3242 $resql = $this->db->query($sql);
3243 if ($resql) {
3244 $this->model_pdf = $modelpdf;
3245 return 1;
3246 } else {
3247 dol_print_error($this->db);
3248 return 0;
3249 }
3250 }
3251
3252
3261 public function setBankAccount($fk_account, $notrigger = 0, $userused = null)
3262 {
3263 global $user;
3264
3265 if (empty($userused)) {
3266 $userused = $user;
3267 }
3268
3269 $error = 0;
3270
3271 if (!$this->table_element) {
3272 dol_syslog(get_class($this)."::setBankAccount was called on object with property table_element not defined", LOG_ERR);
3273 return -1;
3274 }
3275 $this->db->begin();
3276
3277 if ($fk_account < 0) {
3278 $fk_account = 'NULL';
3279 }
3280 dol_syslog(get_class($this).'::setBankAccount('.$fk_account.')');
3281
3282 $sql = "UPDATE ".$this->db->prefix().$this->table_element;
3283 $sql .= " SET fk_account = ".((int) $fk_account);
3284 $sql .= " WHERE rowid=".((int) $this->id);
3285
3286 $resql = $this->db->query($sql);
3287 if (!$resql) {
3288 dol_syslog(get_class($this).'::setBankAccount Error '.$sql.' - '.$this->db->error());
3289 $this->error = $this->db->lasterror();
3290 $error++;
3291 } else {
3292 if (!$notrigger) {
3293 // Call trigger
3294 $this->context['bankaccountupdate'] = 1;
3295 $triggerName = strtoupper(get_class($this)).'_MODIFY';
3296 // Special cases
3297 if ($triggerName == 'FACTUREREC_MODIFY') {
3298 $triggerName = 'BILLREC_MODIFY';
3299 }
3300 $result = $this->call_trigger($triggerName, $userused);
3301 if ($result < 0) {
3302 $error++;
3303 }
3304 // End call trigger
3305 }
3306 }
3307 if ($error) {
3308 $this->db->rollback();
3309 return -1;
3310 } else {
3311 $this->fk_account = ($fk_account == 'NULL') ? null : $fk_account;
3312 $this->db->commit();
3313 return 1;
3314 }
3315 }
3316
3317
3318 // TODO: Move line related operations to CommonObjectLine?
3319
3320 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
3330 public function line_order($renum = false, $rowidorder = 'ASC', $fk_parent_line = true)
3331 {
3332 // phpcs:enable
3333 if (!$this->table_element_line) {
3334 dol_syslog(get_class($this)."::line_order was called on object with property table_element_line not defined", LOG_ERR);
3335 return -1;
3336 }
3337 if (!$this->fk_element) {
3338 dol_syslog(get_class($this)."::line_order was called on object with property fk_element not defined", LOG_ERR);
3339 return -1;
3340 }
3341
3342 $fieldposition = 'rang'; // @todo Rename 'rang' into 'position'
3343 if (in_array($this->table_element_line, array('bom_bomline', 'ecm_files', 'emailcollector_emailcollectoraction', 'product_attribute_value'))) {
3344 $fieldposition = 'position';
3345 }
3346
3347 // Count number of lines to reorder (according to choice $renum)
3348 $nl = 0;
3349 $sql = "SELECT count(rowid) FROM ".$this->db->prefix().$this->table_element_line;
3350 $sql .= " WHERE ".$this->fk_element." = ".((int) $this->id);
3351 if (!$renum) {
3352 $sql .= " AND " . $fieldposition . " = 0";
3353 }
3354 if ($renum) {
3355 $sql .= " AND " . $fieldposition . " <> 0";
3356 }
3357
3358 dol_syslog(get_class($this)."::line_order", LOG_DEBUG);
3359 $resql = $this->db->query($sql);
3360 if ($resql) {
3361 $row = $this->db->fetch_row($resql);
3362 $nl = $row[0];
3363 } else {
3364 dol_print_error($this->db);
3365 }
3366 if ($nl > 0) {
3367 // The goal of this part is to reorder all lines, with all children lines sharing the same counter that parents.
3368 $rows = array();
3369
3370 // We first search all lines that are parent lines (for multilevel details lines)
3371 $sql = "SELECT rowid FROM ".$this->db->prefix().$this->table_element_line;
3372 $sql .= " WHERE ".$this->fk_element." = ".((int) $this->id);
3373 if ($fk_parent_line) {
3374 $sql .= ' AND fk_parent_line IS NULL';
3375 }
3376 $sql .= " ORDER BY " . $fieldposition . " ASC, rowid " . $rowidorder;
3377
3378 dol_syslog(get_class($this)."::line_order search all parent lines", LOG_DEBUG);
3379 $resql = $this->db->query($sql);
3380 if ($resql) {
3381 $i = 0;
3382 $num = $this->db->num_rows($resql);
3383 $grandchild = getDolGlobalInt('MAIN_CARE_GRANDCHILD');
3384 while ($i < $num) {
3385 $row = $this->db->fetch_row($resql);
3386 $rows[] = $row[0]; // Add parent line into array rows
3387 $children = $this->getChildrenOfLine($row[0], $grandchild);
3388 if (!empty($children)) {
3389 foreach ($children as $child) {
3390 array_push($rows, $child);
3391 }
3392 }
3393 $i++;
3394 }
3395
3396 // Now we set a new number for each lines (parent and children with children included into parent tree)
3397 if (!empty($rows)) {
3398 foreach ($rows as $key => $row) {
3399 $this->updateRangOfLine($row, ($key + 1));
3400 }
3401 }
3402 } else {
3403 dol_print_error($this->db);
3404 }
3405 }
3406 return 1;
3407 }
3408
3416 public function getChildrenOfLine($id, $includealltree = 0)
3417 {
3418 $fieldposition = 'rang'; // @todo Rename 'rang' into 'position'
3419 if (in_array($this->table_element_line, array('bom_bomline', 'ecm_files', 'emailcollector_emailcollectoraction', 'product_attribute_value'))) {
3420 $fieldposition = 'position';
3421 }
3422
3423 $rows = array();
3424
3425 $sql = "SELECT rowid FROM ".$this->db->prefix().$this->table_element_line;
3426 $sql .= " WHERE ".$this->fk_element." = ".((int) $this->id);
3427 $sql .= ' AND fk_parent_line = '.((int) $id);
3428 $sql .= " ORDER BY " . $fieldposition . " ASC";
3429
3430 dol_syslog(get_class($this)."::getChildrenOfLine search children lines for line ".$id, LOG_DEBUG);
3431
3432 $resql = $this->db->query($sql);
3433 if ($resql) {
3434 if ($this->db->num_rows($resql) > 0) {
3435 while ($row = $this->db->fetch_row($resql)) {
3436 $rows[] = $row[0];
3437 if (!empty($includealltree) && $includealltree <= 1000) { // Test <= 1000 is a protection in depth of recursive call to avoid infinite loop
3438 $rows = array_merge($rows, $this->getChildrenOfLine($row[0], $includealltree + 1));
3439 }
3440 }
3441 }
3442 }
3443 return $rows;
3444 }
3445
3446 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
3454 public function line_up($rowid, $fk_parent_line = true)
3455 {
3456 // phpcs:enable
3457 $this->line_order(false, 'ASC', $fk_parent_line);
3458
3459 // Get rang of line
3460 $rang = $this->getRangOfLine($rowid);
3461
3462 // Update position of line
3463 $this->updateLineUp($rowid, $rang);
3464 }
3465
3466 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
3474 public function line_down($rowid, $fk_parent_line = true)
3475 {
3476 // phpcs:enable
3477 $this->line_order(false, 'ASC', $fk_parent_line);
3478
3479 // Get rang of line
3480 $rang = $this->getRangOfLine($rowid);
3481
3482 // Get max value for rang
3483 $max = $this->line_max();
3484
3485 // Update position of line
3486 $this->updateLineDown($rowid, $rang, $max);
3487 }
3488
3496 public function updateRangOfLine($rowid, $rang)
3497 {
3498 global $hookmanager;
3499 $fieldposition = 'rang'; // @todo Rename 'rang' into 'position'
3500 if (in_array($this->table_element_line, array('bom_bomline', 'ecm_files', 'emailcollector_emailcollectoraction', 'product_attribute_value'))) {
3501 $fieldposition = 'position';
3502 }
3503
3504 $sql = "UPDATE ".$this->db->prefix().$this->table_element_line." SET ".$fieldposition." = ".((int) $rang);
3505 $sql .= ' WHERE rowid = '.((int) $rowid);
3506
3507 dol_syslog(get_class($this)."::updateRangOfLine", LOG_DEBUG);
3508 if (!$this->db->query($sql)) {
3509 dol_print_error($this->db);
3510 return -1;
3511 } else {
3512 $parameters = array('rowid' => $rowid, 'rang' => $rang, 'fieldposition' => $fieldposition);
3513 $action = '';
3514 $reshook = $hookmanager->executeHooks('afterRankOfLineUpdate', $parameters, $this, $action);
3515 return 1;
3516 }
3517 }
3518
3519 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
3526 public function line_ajaxorder($rows)
3527 {
3528 // phpcs:enable
3529 $num = count($rows);
3530 for ($i = 0; $i < $num; $i++) {
3531 $this->updateRangOfLine($rows[$i], ($i + 1));
3532 }
3533 }
3534
3542 public function updateLineUp($rowid, $rang)
3543 {
3544 if ($rang > 1) {
3545 $fieldposition = 'rang';
3546 if (in_array($this->table_element_line, array('ecm_files', 'emailcollector_emailcollectoraction', 'product_attribute_value'))) {
3547 $fieldposition = 'position';
3548 }
3549
3550 $sql = "UPDATE ".$this->db->prefix().$this->table_element_line." SET ".$fieldposition." = ".((int) $rang);
3551 $sql .= " WHERE ".$this->fk_element." = ".((int) $this->id);
3552 $sql .= " AND " . $fieldposition . " = " . ((int) ($rang - 1));
3553 if ($this->db->query($sql)) {
3554 $sql = "UPDATE ".$this->db->prefix().$this->table_element_line." SET ".$fieldposition." = ".((int) ($rang - 1));
3555 $sql .= ' WHERE rowid = '.((int) $rowid);
3556 if (!$this->db->query($sql)) {
3557 dol_print_error($this->db);
3558 }
3559 } else {
3560 dol_print_error($this->db);
3561 }
3562 }
3563 }
3564
3573 public function updateLineDown($rowid, $rang, $max)
3574 {
3575 if ($rang < $max) {
3576 $fieldposition = 'rang';
3577 if (in_array($this->table_element_line, array('ecm_files', 'emailcollector_emailcollectoraction', 'product_attribute_value'))) {
3578 $fieldposition = 'position';
3579 }
3580
3581 $sql = "UPDATE ".$this->db->prefix().$this->table_element_line." SET ".$fieldposition." = ".((int) $rang);
3582 $sql .= " WHERE ".$this->fk_element." = ".((int) $this->id);
3583 $sql .= " AND " . $fieldposition . " = " . ((int) ($rang + 1));
3584 if ($this->db->query($sql)) {
3585 $sql = "UPDATE ".$this->db->prefix().$this->table_element_line." SET ".$fieldposition." = ".((int) ($rang + 1));
3586 $sql .= ' WHERE rowid = '.((int) $rowid);
3587 if (!$this->db->query($sql)) {
3588 dol_print_error($this->db);
3589 }
3590 } else {
3591 dol_print_error($this->db);
3592 }
3593 }
3594 }
3595
3602 public function getRangOfLine($rowid)
3603 {
3604 $fieldposition = 'rang';
3605 if (in_array($this->table_element_line, array('ecm_files', 'emailcollector_emailcollectoraction', 'product_attribute_value'))) {
3606 $fieldposition = 'position';
3607 }
3608
3609 $sql = "SELECT " . $fieldposition . " FROM ".$this->db->prefix().$this->table_element_line;
3610 $sql .= " WHERE rowid = ".((int) $rowid);
3611
3612 dol_syslog(get_class($this)."::getRangOfLine", LOG_DEBUG);
3613 $resql = $this->db->query($sql);
3614 if ($resql) {
3615 $row = $this->db->fetch_row($resql);
3616 return $row[0];
3617 }
3618
3619 return 0;
3620 }
3621
3628 public function getIdOfLine($rang)
3629 {
3630 $fieldposition = 'rang';
3631 if (in_array($this->table_element_line, array('ecm_files', 'emailcollector_emailcollectoraction', 'product_attribute_value'))) {
3632 $fieldposition = 'position';
3633 }
3634
3635 $sql = "SELECT rowid FROM ".$this->db->prefix().$this->table_element_line;
3636 $sql .= " WHERE ".$this->fk_element." = ".((int) $this->id);
3637 $sql .= " AND " . $fieldposition . " = ".((int) $rang);
3638 $resql = $this->db->query($sql);
3639 if ($resql) {
3640 $row = $this->db->fetch_row($resql);
3641 return $row[0];
3642 }
3643
3644 return 0;
3645 }
3646
3647 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
3654 public function line_max($fk_parent_line = 0)
3655 {
3656 // phpcs:enable
3657 $positionfield = 'rang';
3658 if (in_array($this->table_element, array('bom_bom', 'product_attribute'))) {
3659 $positionfield = 'position';
3660 }
3661
3662 // Search the last rang with fk_parent_line
3663 if ($fk_parent_line) {
3664 $sql = "SELECT max(".$positionfield.") FROM ".$this->db->prefix().$this->table_element_line;
3665 $sql .= " WHERE ".$this->fk_element." = ".((int) $this->id);
3666 $sql .= " AND fk_parent_line = ".((int) $fk_parent_line);
3667
3668 dol_syslog(get_class($this)."::line_max", LOG_DEBUG);
3669 $resql = $this->db->query($sql);
3670 if ($resql) {
3671 $row = $this->db->fetch_row($resql);
3672 if (!empty($row[0])) {
3673 return $row[0];
3674 } else {
3675 return $this->getRangOfLine($fk_parent_line);
3676 }
3677 }
3678 } else {
3679 // If not, search the last rang of element
3680 $sql = "SELECT max(".$positionfield.") FROM ".$this->db->prefix().$this->table_element_line;
3681 $sql .= " WHERE ".$this->fk_element." = ".((int) $this->id);
3682
3683 dol_syslog(get_class($this)."::line_max", LOG_DEBUG);
3684 $resql = $this->db->query($sql);
3685 if ($resql) {
3686 $row = $this->db->fetch_row($resql);
3687 return $row[0];
3688 }
3689 }
3690
3691 return 0;
3692 }
3693
3694 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
3701 public function update_ref_ext($ref_ext)
3702 {
3703 // phpcs:enable
3704 if (!$this->table_element) {
3705 dol_syslog(get_class($this)."::update_ref_ext was called on object with property table_element not defined", LOG_ERR);
3706 return -1;
3707 }
3708
3709 $sql = "UPDATE ".$this->db->prefix().$this->table_element;
3710 $sql .= " SET ref_ext = '".$this->db->escape($ref_ext)."'";
3711 // @phan-suppress-next-line PhanUndeclaredProperty
3712 $sql .= " WHERE ".(isset($this->table_rowid) ? $this->table_rowid : 'rowid')." = ".((int) $this->id);
3713
3714 dol_syslog(get_class($this)."::update_ref_ext", LOG_DEBUG);
3715 if ($this->db->query($sql)) {
3716 $this->ref_ext = $ref_ext;
3717 return 1;
3718 } else {
3719 $this->error = $this->db->error();
3720 return -1;
3721 }
3722 }
3723
3724 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
3733 public function update_note($note, $suffix = '', $notrigger = 0)
3734 {
3735 // phpcs:enable
3736 global $user;
3737
3738 if (!$this->table_element) {
3739 $this->error = 'update_note was called on object with property table_element not defined';
3740 dol_syslog(get_class($this)."::update_note was called on object with property table_element not defined", LOG_ERR);
3741 return -1;
3742 }
3743 if (!in_array($suffix, array('', '_public', '_private'))) {
3744 $this->error = 'update_note Parameter suffix must be empty, \'_private\' or \'_public\'';
3745 dol_syslog(get_class($this)."::update_note Parameter suffix must be empty, '_private' or '_public'", LOG_ERR);
3746 return -2;
3747 }
3748
3749 $newsuffix = $suffix;
3750
3751 // Special case
3752 if ($this->table_element == 'product' && $newsuffix == '_private') {
3753 $newsuffix = '';
3754 }
3755 if (in_array($this->table_element, array('actioncomm', 'adherent', 'advtargetemailing', 'cronjob', 'establishment'))) {
3756 $fieldusermod = "fk_user_mod";
3757 } elseif ($this->table_element == 'ecm_files') {
3758 $fieldusermod = "fk_user_m";
3759 } else {
3760 $fieldusermod = "fk_user_modif";
3761 }
3762 $sql = "UPDATE ".$this->db->prefix().$this->table_element;
3763 $sql .= " SET note".$newsuffix." = ".(!empty($note) ? ("'".$this->db->escape($note)."'") : "NULL");
3764 $sql .= ", ".$fieldusermod." = ".((int) $user->id);
3765 $sql .= " WHERE rowid = ".((int) $this->id);
3766
3767 dol_syslog(get_class($this)."::update_note", LOG_DEBUG);
3768 if ($this->db->query($sql)) {
3769 if ($suffix == '_public') {
3770 $this->note_public = $note;
3771 } elseif ($suffix == '_private') {
3772 $this->note_private = $note;
3773 } else {
3774 $this->note = $note; // deprecated
3775 $this->note_private = $note;
3776 }
3777 if (empty($notrigger)) {
3778 switch ($this->element) {
3779 case 'societe':
3780 $trigger_name = 'COMPANY_MODIFY';
3781 break;
3782 case 'commande':
3783 $trigger_name = 'ORDER_MODIFY';
3784 break;
3785 case 'facture':
3786 $trigger_name = 'BILL_MODIFY';
3787 break;
3788 case 'invoice_supplier':
3789 $trigger_name = 'BILL_SUPPLIER_MODIFY';
3790 break;
3791 case 'facturerec':
3792 $trigger_name = 'BILLREC_MODIFIY';
3793 break;
3794 case 'expensereport':
3795 $trigger_name = 'EXPENSE_REPORT_MODIFY';
3796 break;
3797 default:
3798 $trigger_name = strtoupper($this->element) . '_MODIFY';
3799 }
3800 $ret = $this->call_trigger($trigger_name, $user);
3801 if ($ret < 0) {
3802 return -1;
3803 }
3804 }
3805 return 1;
3806 } else {
3807 $this->error = $this->db->lasterror();
3808 return -1;
3809 }
3810 }
3811
3812 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
3821 public function update_note_public($note)
3822 {
3823 // phpcs:enable
3824 return $this->update_note($note, '_public');
3825 }
3826
3827 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
3838 public function update_price($exclspec = 0, $roundingadjust = 'auto', $nodatabaseupdate = 0, $seller = null)
3839 {
3840 // phpcs:enable
3841 global $conf, $hookmanager, $action;
3842
3843 $parameters = array('exclspec' => $exclspec, 'roundingadjust' => $roundingadjust, 'nodatabaseupdate' => $nodatabaseupdate, 'seller' => $seller);
3844 $reshook = $hookmanager->executeHooks('updateTotalPrice', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
3845 if ($reshook > 0) {
3846 return 1; // replacement code
3847 } elseif ($reshook < 0) {
3848 return -1; // failure
3849 } // reshook = 0 => execute normal code
3850
3851 // Some external module want no update price after a trigger because they have another method to calculate the total (ex: with an extrafield)
3852 $isElementForSupplier = false;
3853 $roundTotalConstName = 'MAIN_ROUNDOFTOTAL_NOT_TOTALOFROUND'; // const for customer by default
3854 $MODULE = "";
3855 if ($this->element == 'propal') {
3856 $MODULE = "MODULE_DISALLOW_UPDATE_PRICE_PROPOSAL";
3857 } elseif ($this->element == 'commande' || $this->element == 'order') {
3858 $MODULE = "MODULE_DISALLOW_UPDATE_PRICE_ORDER";
3859 } elseif ($this->element == 'facture' || $this->element == 'invoice') {
3860 $MODULE = "MODULE_DISALLOW_UPDATE_PRICE_INVOICE";
3861 } elseif ($this->element == 'facture_fourn' || $this->element == 'supplier_invoice' || $this->element == 'invoice_supplier' || $this->element == 'invoice_supplier_rec') {
3862 $isElementForSupplier = true;
3863 $MODULE = "MODULE_DISALLOW_UPDATE_PRICE_SUPPLIER_INVOICE";
3864 } elseif ($this->element == 'order_supplier' || $this->element == 'supplier_order') {
3865 $isElementForSupplier = true;
3866 $MODULE = "MODULE_DISALLOW_UPDATE_PRICE_SUPPLIER_ORDER";
3867 } elseif ($this->element == 'supplier_proposal') {
3868 $isElementForSupplier = true;
3869 $MODULE = "MODULE_DISALLOW_UPDATE_PRICE_SUPPLIER_PROPOSAL";
3870 }
3871 if ($isElementForSupplier) {
3872 $roundTotalConstName = 'MAIN_ROUNDOFTOTAL_NOT_TOTALOFROUND_SUPPLIER'; // const for supplier
3873 }
3874
3875 if (!empty($MODULE)) {
3876 if (getDolGlobalString($MODULE)) {
3877 $modsactivated = explode(',', getDolGlobalString($MODULE));
3878 foreach ($modsactivated as $mod) {
3879 if (isModEnabled($mod)) {
3880 return 1; // update was disabled by specific setup
3881 }
3882 }
3883 }
3884 }
3885
3886 include_once DOL_DOCUMENT_ROOT.'/core/lib/price.lib.php';
3887
3888 $forcedroundingmode = $roundingadjust;
3889 if ($forcedroundingmode == 'auto' && isset($conf->global->{$roundTotalConstName})) {
3890 $forcedroundingmode = getDolGlobalString($roundTotalConstName);
3891 } elseif ($forcedroundingmode == 'auto') {
3892 $forcedroundingmode = '0';
3893 }
3894
3895 $error = 0;
3896
3897 $multicurrency_tx = !empty($this->multicurrency_tx) ? $this->multicurrency_tx : 1;
3898
3899 // Define constants to find lines to sum (field name int the table_element_line not into table_element)
3900 $fieldtva = 'total_tva';
3901 $fieldlocaltax1 = 'total_localtax1';
3902 $fieldlocaltax2 = 'total_localtax2';
3903 $fieldup = 'subprice';
3904 $base_price_type = 'HT';
3905 if ($this->element == 'facture_fourn' || $this->element == 'invoice_supplier') {
3906 $fieldtva = 'tva';
3907 $fieldup = 'pu_ht';
3908 }
3909 if ($this->element == 'invoice_supplier_rec') {
3910 $fieldup = 'pu_ht';
3911 }
3912 if ($this->element == 'expensereport') {
3913 // Force rounding mode to '0', otherwise when you set MAIN_ROUNDOFTOTAL_NOT_TOTALOFROUND to 1, you may have lines with different totals.
3914 // For example, if you have 2 lines with same TTC amounts (6,2 Unit price TTC and VAT rate 20%), on the first line you got 5,17 on HT total
3915 // and 5,16 on HT total and 1,04 on VAT total to get 6,20 on TTT total on second line (see #30051).
3916 $forcedroundingmode = '0';
3917 $fieldup = 'value_unit';
3918 $base_price_type = 'TTC';
3919 }
3920
3921 $sql = "SELECT rowid, qty, ".$fieldup." as up, remise_percent, total_ht, ".$fieldtva." as total_tva, total_ttc, ".$fieldlocaltax1." as total_localtax1, ".$fieldlocaltax2." as total_localtax2,";
3922 $sql .= ' tva_tx as vatrate, localtax1_tx, localtax2_tx, localtax1_type, localtax2_type, info_bits, product_type';
3923 if ($this->table_element_line == 'facturedet') {
3924 $sql .= ', situation_percent';
3925 }
3926 $sql .= ', multicurrency_total_ht, multicurrency_total_tva, multicurrency_total_ttc';
3927 $sql .= " FROM ".$this->db->prefix().$this->table_element_line;
3928 $sql .= " WHERE ".$this->fk_element." = ".((int) $this->id);
3929 if ($exclspec) {
3930 $product_field = 'product_type';
3931 if ($this->table_element_line == 'contratdet') {
3932 $product_field = ''; // contratdet table has no product_type field
3933 }
3934 if ($product_field) {
3935 $sql .= " AND ".$product_field." <> 9";
3936 }
3937 }
3938 $sql .= ' ORDER by rowid'; // We want to be certain to always use same order of line to not change lines differently when option MAIN_ROUNDOFTOTAL_NOT_TOTALOFROUND is used
3939
3940 dol_syslog(get_class($this)."::update_price", LOG_DEBUG);
3941
3942 $resql = $this->db->query($sql);
3943 if ($resql) {
3944 $this->total_ht = 0;
3945 $this->total_tva = 0;
3946 $this->total_localtax1 = 0;
3947 $this->total_localtax2 = 0;
3948 $this->total_ttc = 0;
3949 $total_ht_by_vats = array();
3950 $total_tva_by_vats = array();
3951 $total_ttc_by_vats = array();
3952 $this->multicurrency_total_ht = 0;
3953 $this->multicurrency_total_tva = 0;
3954 $this->multicurrency_total_ttc = 0;
3955
3956 $this->db->begin();
3957
3958 $num = $this->db->num_rows($resql);
3959 $i = 0;
3960 while ($i < $num) {
3961 $obj = $this->db->fetch_object($resql);
3962
3963 // Note: There is no check on detail line and no check on total, if $forcedroundingmode = '0'
3964 $parameters = array('fk_element' => $obj->rowid);
3965 $reshook = $hookmanager->executeHooks('changeRoundingMode', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
3966
3967 if (empty($reshook) && $forcedroundingmode == '0') { // Check if data on line are consistent. This may solve lines that were not consistent because set with $forcedroundingmode='auto'
3968 // This part of code is to fix data. We should not call it too often.
3969 $localtax_array = array($obj->localtax1_type, $obj->localtax1_tx, $obj->localtax2_type, $obj->localtax2_tx);
3970 $tmpcal = calcul_price_total($obj->qty, $obj->up, $obj->remise_percent, $obj->vatrate, $obj->localtax1_tx, $obj->localtax2_tx, 0, $base_price_type, $obj->info_bits, $obj->product_type, $seller, $localtax_array, (isset($obj->situation_percent) ? $obj->situation_percent : 100), $multicurrency_tx);
3971
3972 $diff_when_using_price_ht = price2num((float) $tmpcal[1] - $obj->total_tva, 'MT', 1); // If price was set with tax price and unit price HT has a low number of digits, then we may have a diff on recalculation from unit price HT.
3973 $diff_on_current_total = price2num($obj->total_ttc - $obj->total_ht - $obj->total_tva - $obj->total_localtax1 - $obj->total_localtax2, 'MT', 1);
3974 //var_dump($obj->total_ht.' '.$obj->total_tva.' '.$obj->total_localtax1.' '.$obj->total_localtax2.' => '.$obj->total_ttc);
3975 //var_dump($diff_when_using_price_ht.' '.$diff_on_current_total);
3976
3977 if ($diff_on_current_total) {
3978 // This should not happen, we should always have in table: total_ttc = total_ht + total_vat + total_localtax1 + total_localtax2
3979 $sqlfix = "UPDATE ".$this->db->prefix().$this->table_element_line;
3980 $sqlfix .= " SET ".$fieldtva." = ".price2num((float) $tmpcal[1]).", total_ttc = ".price2num((float) $tmpcal[2]);
3981 $sqlfix .= ", multicurrency_total_tva = ".price2num((float) $tmpcal[17]).", multicurrency_total_ttc = ".price2num((float) $tmpcal[18]);
3982 $sqlfix .= " WHERE rowid = ".((int) $obj->rowid);
3983 dol_syslog('Warn1: We found inconsistent data into detailed line (diff_on_current_total = '.$diff_on_current_total.') for line rowid = '.$obj->rowid." (ht=".$obj->total_ht." vat=".$obj->total_tva." tax1=".$obj->total_localtax1." tax2=".$obj->total_localtax2." ttc=".$obj->total_ttc."). We fix the total_vat and total_ttc of line by running sqlfix = ".$sqlfix, LOG_WARNING);
3984 $resqlfix = $this->db->query($sqlfix);
3985 if (!$resqlfix) {
3986 dol_print_error($this->db, 'Failed to update line');
3987 }
3988 $obj->total_tva = $tmpcal[1];
3989 $obj->total_ttc = $tmpcal[2];
3990 $obj->multicurrency_total_tva = $tmpcal[17];
3991 $obj->multicurrency_total_ttc = $tmpcal[18];
3992 } elseif ($diff_when_using_price_ht) {
3993 // If total_ht calculated from unit price is different than the one in database, we do nothing, this may be a regular case to have also a different VAT, that can be explained
3994 // because price was entered included tax and we round the unit price without tax to store it in database (so recalculation will give different results).
3995 if ((float) $tmpcal[0] == (float) $obj->total_ht) {
3996 // After calculation from HT, total is consistent and total_ht is same, but we have found a difference between VAT part calculated from unit price and the VAT part into database,
3997 // and we ask to force the use of rounding on line (like done on calculation) so this should not happen, so we force the update of line to fix.
3998
3999 // This part of code must be called only to fix corrupted data due to the use of the feature to round total instead of rounding lines.
4000 $sqlfix = "UPDATE ".$this->db->prefix().$this->table_element_line;
4001 $sqlfix .= " SET ".$fieldtva." = ".price2num((float) $tmpcal[1]).", total_ttc = ".price2num((float) $tmpcal[2]);
4002 $sqlfix .= ", multicurrency_total_tva = ".price2num((float) $tmpcal[17]).", multicurrency_total_ttc = ".price2num((float) $tmpcal[18]);
4003 $sqlfix .= " WHERE rowid = ".((int) $obj->rowid);
4004 dol_syslog('Warn2: We found a line with different rounding data into detailed line (diff_when_using_price_ht = '.$diff_when_using_price_ht.' and diff_on_current_total = '.$diff_on_current_total.') for line rowid = '.$obj->rowid." (total vat of line calculated=".$tmpcal[1].", database=".$obj->total_tva."). We fix the total_vat and total_ttc of line by running sqlfix = ".$sqlfix);
4005 $resqlfix = $this->db->query($sqlfix);
4006 if (!$resqlfix) {
4007 dol_print_error($this->db, 'Failed to update line');
4008 }
4009 $obj->total_tva = $tmpcal[1];
4010 $obj->total_ttc = $tmpcal[2];
4011 $obj->multicurrency_total_tva = $tmpcal[17];
4012 $obj->multicurrency_total_ttc = $tmpcal[18];
4013 }
4014 }
4015 }
4016
4017 $this->total_ht += $obj->total_ht; // The field visible at end of line detail
4018 $this->total_tva += $obj->total_tva;
4019 $this->total_localtax1 += $obj->total_localtax1;
4020 $this->total_localtax2 += $obj->total_localtax2;
4021 $this->total_ttc += $obj->total_ttc;
4022 $this->multicurrency_total_ht += $obj->multicurrency_total_ht; // The field visible at end of line detail
4023 $this->multicurrency_total_tva += $obj->multicurrency_total_tva;
4024 $this->multicurrency_total_ttc += $obj->multicurrency_total_ttc;
4025
4026 if (!isset($total_ht_by_vats[$obj->vatrate])) {
4027 $total_ht_by_vats[$obj->vatrate] = 0;
4028 }
4029 if (!isset($total_tva_by_vats[$obj->vatrate])) {
4030 $total_tva_by_vats[$obj->vatrate] = 0;
4031 }
4032 if (!isset($total_ttc_by_vats[$obj->vatrate])) {
4033 $total_ttc_by_vats[$obj->vatrate] = 0;
4034 }
4035 $total_ht_by_vats[$obj->vatrate] += $obj->total_ht;
4036 $total_tva_by_vats[$obj->vatrate] += $obj->total_tva;
4037 $total_ttc_by_vats[$obj->vatrate] += $obj->total_ttc;
4038
4039 if ($forcedroundingmode == '1') { // Check if we need adjustment onto line for vat. TODO This works on the company currency but not on foreign currency
4040 if ($base_price_type == 'TTC') {
4041 $tmpvat = price2num($total_ttc_by_vats[$obj->vatrate] * $obj->vatrate / (100 + $obj->vatrate), 'MT', 1);
4042 } else {
4043 $tmpvat = price2num($total_ht_by_vats[$obj->vatrate] * $obj->vatrate / 100, 'MT', 1);
4044 }
4045 $diff = price2num($total_tva_by_vats[$obj->vatrate] - (float) $tmpvat, 'MT', 1);
4046 //print 'Line '.$i.' rowid='.$obj->rowid.' vat_rate='.$obj->vatrate.' total_ht='.$obj->total_ht.' total_tva='.$obj->total_tva.' total_ttc='.$obj->total_ttc.' total_ht_by_vats='.$total_ht_by_vats[$obj->vatrate].' total_tva_by_vats='.$total_tva_by_vats[$obj->vatrate].' (new calculation = '.$tmpvat.') total_ttc_by_vats='.$total_ttc_by_vats[$obj->vatrate].($diff?" => DIFF":"")."<br>\n";
4047 if ($diff) {
4048 $maxdiff = (10 * pow(10, -1 * getDolGlobalInt('MAIN_MAX_DECIMALS_TOT', 0)));
4049 if (abs((float) $diff) > $maxdiff) {
4050 // If error is more than 10 times the accuracy of rounding. This should not happen.
4051 $errmsg = 'We found a rounding difference after line '.($obj->rowid).' between HT*VAT='.$tmpvat.' and total in database='.$total_tva_by_vats[$obj->vatrate].' (calculated with UP*qty) but diff='.$diff.' is too high (> '.$maxdiff.') to be corrected. Some data in your lines may be corrupted. Try to edit each line manually to fix this before restarting.';
4052 dol_syslog($errmsg, LOG_WARNING);
4053 $this->error = $errmsg;
4054 $error++;
4055 break;
4056 }
4057
4058 if ($base_price_type == 'TTC') {
4059 $sqlfix = "UPDATE ".$this->db->prefix().$this->table_element_line." SET ".$fieldtva." = ".price2num($obj->total_tva - (float) $diff).", total_ht = ".price2num($obj->total_ht + (float) $diff)." WHERE rowid = ".((int) $obj->rowid);
4060 dol_syslog('We found a difference of '.$diff.' for line rowid = '.$obj->rowid.' between TotalHT('.$total_ht_by_vats[$obj->vatrate].')*VATrate('.$obj->vatrate.')='.$tmpvat.' and total in database='.$total_tva_by_vats[$obj->vatrate]." (calculated with UP*qty). We fix the total_vat and total_ht of line by running sqlfix = ".$sqlfix);
4061 } else {
4062 $sqlfix = "UPDATE ".$this->db->prefix().$this->table_element_line." SET ".$fieldtva." = ".price2num($obj->total_tva - (float) $diff).", total_ttc = ".price2num($obj->total_ttc - (float) $diff)." WHERE rowid = ".((int) $obj->rowid);
4063 dol_syslog('We found a difference of '.$diff.' for line rowid = '.$obj->rowid.' between TotalHT('.$total_ht_by_vats[$obj->vatrate].')*VATrate('.$obj->vatrate.')='.$tmpvat.' and total in database='.$total_tva_by_vats[$obj->vatrate]." (calculated with UP*qty). We fix the total_vat and total_ttc of line by running sqlfix = ".$sqlfix);
4064 }
4065
4066 $resqlfix = $this->db->query($sqlfix);
4067
4068 if (!$resqlfix) {
4069 dol_print_error($this->db, 'Failed to update line');
4070 }
4071
4072 $this->total_tva = (float) price2num($this->total_tva - (float) $diff, '', 1);
4073 $total_tva_by_vats[$obj->vatrate] = (float) price2num($total_tva_by_vats[$obj->vatrate] - (float) $diff, '', 1);
4074 if ($base_price_type == 'TTC') {
4075 $this->total_ht = (float) price2num($this->total_ht + (float) $diff, '', 1);
4076 $total_ht_by_vats[$obj->vatrate] = (float) price2num($total_ht_by_vats[$obj->vatrate] + (float) $diff, '', 1);
4077 } else {
4078 $this->total_ttc = (float) price2num($this->total_ttc - (float) $diff, '', 1);
4079 $total_ttc_by_vats[$obj->vatrate] = (float) price2num($total_ttc_by_vats[$obj->vatrate] - (float) $diff, '', 1);
4080 }
4081 }
4082 }
4083
4084 $i++;
4085 }
4086
4087 // Add revenue stamp to total
4088 // @phan-suppress-next-line PhanUndeclaredProperty
4089 $this->total_ttc += isset($this->revenuestamp) ? $this->revenuestamp : 0;
4090 // @phan-suppress-next-line PhanUndeclaredProperty
4091 $this->multicurrency_total_ttc += isset($this->revenuestamp) ? ($this->revenuestamp * $multicurrency_tx) : 0;
4092
4093 // Situations totals
4094 if (!empty($this->situation_cycle_ref) && !empty($this->situation_counter) && $this->situation_counter > 1 && method_exists($this, 'get_prev_sits')) { // @phan-suppress-current-line PhanUndeclaredProperty
4095 '@phan-var-force Facture $this';
4096 include_once DOL_DOCUMENT_ROOT.'/compta/facture/class/facture.class.php'; // Note: possibly useless as $this is normally already Facture, so the class file should be loaded
4097 if ($this->type != Facture::TYPE_CREDIT_NOTE) { // @phpstan-ignore-line
4098 if (getDolGlobalInt('INVOICE_USE_SITUATION') != 2) {
4099 $prev_sits = $this->get_prev_sits();
4100
4101 foreach ($prev_sits as $sit) { // $sit is an object Facture loaded with a fetch.
4102 $this->total_ht -= $sit->total_ht;
4103 $this->total_tva -= $sit->total_tva;
4104 $this->total_localtax1 -= $sit->total_localtax1;
4105 $this->total_localtax2 -= $sit->total_localtax2;
4106 $this->total_ttc -= $sit->total_ttc;
4107 $this->multicurrency_total_ht -= $sit->multicurrency_total_ht;
4108 $this->multicurrency_total_tva -= $sit->multicurrency_total_tva;
4109 $this->multicurrency_total_ttc -= $sit->multicurrency_total_ttc;
4110 }
4111 }
4112 }
4113 }
4114
4115 // Clean total
4116 $this->total_ht = (float) price2num($this->total_ht);
4117 $this->total_tva = (float) price2num($this->total_tva);
4118 $this->total_localtax1 = (float) price2num($this->total_localtax1);
4119 $this->total_localtax2 = (float) price2num($this->total_localtax2);
4120 $this->total_ttc = (float) price2num($this->total_ttc);
4121
4122 $this->db->free($resql);
4123
4124 // Now update global fields total_ht, total_ttc, total_tva, total_localtax1, total_localtax2, multicurrency_total_* of main object
4125 $fieldht = 'total_ht';
4126 $fieldtva = 'tva';
4127 $fieldlocaltax1 = 'localtax1';
4128 $fieldlocaltax2 = 'localtax2';
4129 $fieldttc = 'total_ttc';
4130 // Specific code for backward compatibility with old field names
4131 if (in_array($this->element, array('propal', 'commande', 'facture', 'facturerec', 'supplier_proposal', 'order_supplier', 'facture_fourn', 'invoice_supplier', 'invoice_supplier_rec', 'expensereport'))) {
4132 $fieldtva = 'total_tva';
4133 }
4134
4135 if (!$error && empty($nodatabaseupdate)) {
4136 $sql = "UPDATE ".$this->db->prefix().$this->table_element.' SET';
4137 $sql .= " ".$this->db->sanitize($fieldht)." = ".((float) price2num($this->total_ht, 'MT', 1)).",";
4138 $sql .= " ".$this->db->sanitize($fieldtva)." = ".((float) price2num($this->total_tva, 'MT', 1)).",";
4139 $sql .= " ".$this->db->sanitize($fieldlocaltax1)." = ".((float) price2num($this->total_localtax1, 'MT', 1)).",";
4140 $sql .= " ".$this->db->sanitize($fieldlocaltax2)." = ".((float) price2num($this->total_localtax2, 'MT', 1)).",";
4141 $sql .= " ".$this->db->sanitize($fieldttc)." = ".((float) price2num($this->total_ttc, 'MT', 1));
4142 $sql .= ", multicurrency_total_ht = ".((float) price2num($this->multicurrency_total_ht, 'MT', 1));
4143 $sql .= ", multicurrency_total_tva = ".((float) price2num($this->multicurrency_total_tva, 'MT', 1));
4144 $sql .= ", multicurrency_total_ttc = ".((float) price2num($this->multicurrency_total_ttc, 'MT', 1));
4145 $sql .= " WHERE rowid = ".((int) $this->id);
4146
4147 dol_syslog(get_class($this)."::update_price", LOG_DEBUG);
4148 $resql = $this->db->query($sql);
4149
4150 if (!$resql) {
4151 $error++;
4152 $this->error = $this->db->lasterror();
4153 $this->errors[] = $this->db->lasterror();
4154 }
4155 }
4156
4157 if (!$error) {
4158 $this->db->commit();
4159 return 1;
4160 } else {
4161 $this->db->rollback();
4162 return -1;
4163 }
4164 } else {
4165 dol_print_error($this->db, 'Bad request in update_price');
4166 return -1;
4167 }
4168 }
4169
4170 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
4181 public function add_object_linked($origin = null, $origin_id = null, $f_user = null, $notrigger = 0)
4182 {
4183 // phpcs:enable
4184 global $user, $hookmanager, $action;
4185 $origin = (!empty($origin) ? $origin : $this->origin);
4186 $origin_id = (!empty($origin_id) ? $origin_id : $this->origin_id);
4187 $f_user = isset($f_user) ? $f_user : $user;
4188
4189 // Special case
4190 if ($origin == 'order') {
4191 $origin = 'commande';
4192 }
4193 if ($origin == 'invoice') {
4194 $origin = 'facture';
4195 }
4196 if ($origin == 'invoice_template') {
4197 $origin = 'facturerec';
4198 }
4199 if ($origin == 'supplierorder') {
4200 $origin = 'order_supplier';
4201 }
4202
4203 // Add module part to target type
4204 $targettype = $this->getElementType();
4205
4206 $parameters = array('targettype' => $targettype);
4207 // Hook for explicitly set the targettype if it must be different than $this->element
4208 $reshook = $hookmanager->executeHooks('setLinkedObjectSourceTargetType', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
4209 if ($reshook > 0) {
4210 if (!empty($hookmanager->resArray['targettype'])) {
4211 $targettype = $hookmanager->resArray['targettype'];
4212 }
4213 }
4214
4215 $this->db->begin();
4216 $error = 0;
4217
4218 $sql = "INSERT INTO " . $this->db->prefix() . "element_element (";
4219 $sql .= "fk_source";
4220 $sql .= ", sourcetype";
4221 $sql .= ", fk_target";
4222 $sql .= ", targettype";
4223 $sql .= ") VALUES (";
4224 $sql .= ((int) $origin_id);
4225 $sql .= ", '" . $this->db->escape($origin) . "'";
4226 $sql .= ", " . ((int) $this->id);
4227 $sql .= ", '" . $this->db->escape($targettype) . "'";
4228 $sql .= ")";
4229
4230 dol_syslog(get_class($this) . "::add_object_linked", LOG_DEBUG);
4231 if ($this->db->query($sql)) {
4232 if (!$notrigger) {
4233 // Call trigger
4234 $this->context['link_origin'] = $origin;
4235 $this->context['link_origin_id'] = $origin_id;
4236 $result = $this->call_trigger('OBJECT_LINK_INSERT', $f_user);
4237 if ($result < 0) {
4238 $error++;
4239 }
4240 // End call triggers
4241 }
4242 } else {
4243 $this->error = $this->db->lasterror();
4244 $error++;
4245 }
4246
4247 if (!$error) {
4248 $this->db->commit();
4249 return 1;
4250 } else {
4251 $this->db->rollback();
4252 return 0;
4253 }
4254 }
4255
4261 public function getElementType()
4262 {
4263 // Elements of the core modules having a `$module` property but for which we may not want to prefix the element name with the module name for finding the linked object in llx_element_element.
4264 // It's because existing llx_element_element entries inserted prior to this modification (version <=14.2) may already use the element name alone in fk_source or fk_target (without the module name prefix).
4265 $coreModule = array('knowledgemanagement', 'partnership', 'workstation', 'ticket', 'recruitment', 'eventorganization', 'asset');
4266 // Add module part to target type if object has $module property and isn't in core modules.
4267 return ((!empty($this->module) && !in_array($this->module, $coreModule)) ? $this->module.'_' : '').$this->element;
4268 }
4269
4270
4293 public function fetchObjectLinked($sourceid = null, $sourcetype = '', $targetid = null, $targettype = '', $clause = 'OR', $alsosametype = 1, $orderby = 'sourcetype', $loadalsoobjects = 1)
4294 {
4295 global $hookmanager, $action;
4296
4297 // Important for pdf generation time reduction
4298 // This boolean is true if $this->linkedObjects has already been loaded with all objects linked without filter
4299 // If you need to force the reload, you can call clearObjectLinkedCache() before calling fetchObjectLinked()
4300 if ($this->id > 0 && !empty($this->linkedObjectsFullLoaded[$this->id])) {
4301 return 1;
4302 }
4303
4304 $this->linkedObjectsIds = array();
4305 $this->linkedObjects = array();
4306
4307 $justsource = false;
4308 $justtarget = false;
4309 $withtargettype = false;
4310 $withsourcetype = false;
4311
4312 $parameters = array('sourcetype' => $sourcetype, 'sourceid' => $sourceid, 'targettype' => $targettype, 'targetid' => $targetid);
4313 // Hook for explicitly set the targettype if it must be differtent than $this->element
4314 $reshook = $hookmanager->executeHooks('setLinkedObjectSourceTargetType', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
4315 if ($reshook > 0) {
4316 if (!empty($hookmanager->resArray['sourcetype'])) {
4317 $sourcetype = $hookmanager->resArray['sourcetype'];
4318 }
4319 if (!empty($hookmanager->resArray['sourceid'])) {
4320 $sourceid = $hookmanager->resArray['sourceid'];
4321 }
4322 if (!empty($hookmanager->resArray['targettype'])) {
4323 $targettype = $hookmanager->resArray['targettype'];
4324 }
4325 if (!empty($hookmanager->resArray['targetid'])) {
4326 $targetid = $hookmanager->resArray['targetid'];
4327 }
4328 }
4329
4330 if (!empty($sourceid) && !empty($sourcetype) && empty($targetid)) {
4331 $justsource = true; // the source (id and type) is a search criteria
4332 if (!empty($targettype)) {
4333 $withtargettype = true;
4334 }
4335 }
4336 if (!empty($targetid) && !empty($targettype) && empty($sourceid)) {
4337 $justtarget = true; // the target (id and type) is a search criteria
4338 if (!empty($sourcetype)) {
4339 $withsourcetype = true;
4340 }
4341 }
4342
4343 $sourceid = (!empty($sourceid) ? $sourceid : $this->id);
4344 $targetid = (!empty($targetid) ? $targetid : $this->id);
4345 $sourcetype = (!empty($sourcetype) ? $sourcetype : $this->getElementType());
4346 $targettype = (!empty($targettype) ? $targettype : $this->getElementType());
4347
4348 /*if (empty($sourceid) && empty($targetid))
4349 {
4350 dol_syslog('Bad usage of function. No source nor target id defined (nor as parameter nor as object id)', LOG_ERR);
4351 return -1;
4352 }*/
4353
4354 // Links between objects are stored in table element_element
4355 $sql = "SELECT rowid, fk_source, sourcetype, fk_target, targettype";
4356 $sql .= " FROM ".$this->db->prefix()."element_element";
4357 $sql .= " WHERE ";
4358 if ($justsource || $justtarget) {
4359 if ($justsource) {
4360 $sql .= "fk_source = ".((int) $sourceid)." AND sourcetype = '".$this->db->escape($sourcetype)."'";
4361 if ($withtargettype) {
4362 $sql .= " AND targettype = '".$this->db->escape($targettype)."'";
4363 }
4364 } elseif ($justtarget) {
4365 $sql .= "fk_target = ".((int) $targetid)." AND targettype = '".$this->db->escape($targettype)."'";
4366 if ($withsourcetype) {
4367 $sql .= " AND sourcetype = '".$this->db->escape($sourcetype)."'";
4368 }
4369 }
4370 } else {
4371 $sql .= "(fk_source = ".((int) $sourceid)." AND sourcetype = '".$this->db->escape($sourcetype)."')";
4372 $sql .= " ".$clause." (fk_target = ".((int) $targetid)." AND targettype = '".$this->db->escape($targettype)."')";
4373 if ($loadalsoobjects && $this->id > 0 && $sourceid == $this->id && $sourcetype == $this->element && $targetid == $this->id && $targettype == $this->element && $clause == 'OR') {
4374 $this->linkedObjectsFullLoaded[$this->id] = true;
4375 }
4376 }
4377 $sql .= " ORDER BY ".$orderby;
4378
4379 dol_syslog(get_class($this)."::fetchObjectLink", LOG_DEBUG);
4380 $resql = $this->db->query($sql);
4381 if ($resql) {
4382 $num = $this->db->num_rows($resql);
4383 $i = 0;
4384 while ($i < $num) {
4385 $obj = $this->db->fetch_object($resql);
4386 if ($justsource || $justtarget) {
4387 if ($justsource) {
4388 $this->linkedObjectsIds[$obj->targettype][$obj->rowid] = $obj->fk_target;
4389 } elseif ($justtarget) {
4390 $this->linkedObjectsIds[$obj->sourcetype][$obj->rowid] = $obj->fk_source;
4391 }
4392 } else {
4393 if ($obj->fk_source == $sourceid && $obj->sourcetype == $sourcetype) {
4394 $this->linkedObjectsIds[$obj->targettype][$obj->rowid] = $obj->fk_target;
4395 }
4396 if ($obj->fk_target == $targetid && $obj->targettype == $targettype) {
4397 $this->linkedObjectsIds[$obj->sourcetype][$obj->rowid] = $obj->fk_source;
4398 }
4399 }
4400 $i++;
4401 }
4402
4403 if (!empty($this->linkedObjectsIds)) {
4404 $tmparray = $this->linkedObjectsIds;
4405 foreach ($tmparray as $objecttype => $objectids) { // $objecttype is a module name ('facture', 'mymodule', ...) or a module name with a suffix ('project_task', 'mymodule_myobj', ...)
4406 $element_properties = getElementProperties($objecttype);
4407 $element = $element_properties['element'];
4408 $classPath = $element_properties['classpath'];
4409 $classFile = $element_properties['classfile'];
4410 $className = $element_properties['classname'];
4411 $module = $element_properties['module'];
4412
4413 // Here $module, $classFile and $className are set, we can use them.
4414 if (isModEnabled($module) && (($element != $this->element) || $alsosametype)) {
4415 if ($loadalsoobjects && (is_numeric($loadalsoobjects) || ($loadalsoobjects === $objecttype))) {
4416 dol_include_once('/'.$classPath.'/'.$classFile.'.class.php');
4417 if (class_exists($className)) {
4418 foreach ($objectids as $i => $objectid) { // $i is rowid into llx_element_element
4419 $object = new $className($this->db);
4420 '@phan-var-force CommonObject $object';
4421 $ret = $object->fetch($objectid);
4422 if ($ret >= 0) {
4423 $this->linkedObjects[$objecttype][$i] = $object;
4424 }
4425 }
4426 }
4427 }
4428 } else {
4429 unset($this->linkedObjectsIds[$objecttype]);
4430 }
4431 }
4432 }
4433 return 1;
4434 } else {
4435 dol_print_error($this->db);
4436 return -1;
4437 }
4438 }
4439
4446 public function clearObjectLinkedCache()
4447 {
4448 if ($this->id > 0 && !empty($this->linkedObjectsFullLoaded[$this->id])) {
4449 unset($this->linkedObjectsFullLoaded[$this->id]);
4450 }
4451
4452 return 1;
4453 }
4454
4467 public function updateObjectLinked($sourceid = null, $sourcetype = '', $targetid = null, $targettype = '', $f_user = null, $notrigger = 0)
4468 {
4469 global $user;
4470 $updatesource = false;
4471 $updatetarget = false;
4472 $f_user = isset($f_user) ? $f_user : $user;
4473
4474 if (!empty($sourceid) && !empty($sourcetype) && empty($targetid) && empty($targettype)) {
4475 $updatesource = true;
4476 } elseif (empty($sourceid) && empty($sourcetype) && !empty($targetid) && !empty($targettype)) {
4477 $updatetarget = true;
4478 }
4479
4480 $this->db->begin();
4481 $error = 0;
4482
4483 $sql = "UPDATE " . $this->db->prefix() . "element_element SET ";
4484 if ($updatesource) {
4485 $sql .= "fk_source = " . ((int) $sourceid);
4486 $sql .= ", sourcetype = '" . $this->db->escape($sourcetype) . "'";
4487 $sql .= " WHERE fk_target = " . ((int) $this->id);
4488 $sql .= " AND targettype = '" . $this->db->escape($this->element) . "'";
4489 } elseif ($updatetarget) {
4490 $sql .= "fk_target = " . ((int) $targetid);
4491 $sql .= ", targettype = '" . $this->db->escape($targettype) . "'";
4492 $sql .= " WHERE fk_source = " . ((int) $this->id);
4493 $sql .= " AND sourcetype = '" . $this->db->escape($this->element) . "'";
4494 }
4495
4496 dol_syslog(get_class($this) . "::updateObjectLinked", LOG_DEBUG);
4497 if ($this->db->query($sql)) {
4498 if (!$notrigger) {
4499 // Call trigger
4500 $this->context['link_source_id'] = $sourceid;
4501 $this->context['link_source_type'] = $sourcetype;
4502 $this->context['link_target_id'] = $targetid;
4503 $this->context['link_target_type'] = $targettype;
4504 $result = $this->call_trigger('OBJECT_LINK_MODIFY', $f_user);
4505 if ($result < 0) {
4506 $error++;
4507 }
4508 // End call triggers
4509 }
4510 } else {
4511 $this->error = $this->db->lasterror();
4512 $error++;
4513 }
4514
4515 if (!$error) {
4516 $this->db->commit();
4517 return 1;
4518 } else {
4519 $this->db->rollback();
4520 return -1;
4521 }
4522 }
4523
4537 public function deleteObjectLinked($sourceid = null, $sourcetype = '', $targetid = null, $targettype = '', $rowid = 0, $f_user = null, $notrigger = 0)
4538 {
4539 global $user;
4540 $deletesource = false;
4541 $deletetarget = false;
4542 $f_user = isset($f_user) ? $f_user : $user;
4543
4544 if (!empty($sourceid) && !empty($sourcetype) && empty($targetid) && empty($targettype)) {
4545 $deletesource = true;
4546 } elseif (empty($sourceid) && empty($sourcetype) && !empty($targetid) && !empty($targettype)) {
4547 $deletetarget = true;
4548 }
4549
4550 $sourceid = (!empty($sourceid) ? $sourceid : $this->id);
4551 $sourcetype = (!empty($sourcetype) ? $sourcetype : $this->element);
4552 $targetid = (!empty($targetid) ? $targetid : $this->id);
4553 $targettype = (!empty($targettype) ? $targettype : $this->element);
4554 $this->db->begin();
4555 $error = 0;
4556
4557 if (!$notrigger) {
4558 // Call trigger
4559 $this->context['link_id'] = $rowid;
4560 $this->context['link_source_id'] = $sourceid;
4561 $this->context['link_source_type'] = $sourcetype;
4562 $this->context['link_target_id'] = $targetid;
4563 $this->context['link_target_type'] = $targettype;
4564 $result = $this->call_trigger('OBJECT_LINK_DELETE', $f_user);
4565 if ($result < 0) {
4566 $error++;
4567 }
4568 // End call triggers
4569 }
4570
4571 if (!$error) {
4572 $sql = "DELETE FROM " . $this->db->prefix() . "element_element";
4573 $sql .= " WHERE";
4574 if ($rowid > 0) {
4575 $sql .= " rowid = " . ((int) $rowid);
4576 } else {
4577 if ($deletesource) {
4578 $sql .= " fk_source = " . ((int) $sourceid) . " AND sourcetype = '" . $this->db->escape($sourcetype) . "'";
4579 $sql .= " AND fk_target = " . ((int) $this->id) . " AND targettype = '" . $this->db->escape($this->element) . "'";
4580 } elseif ($deletetarget) {
4581 $sql .= " fk_target = " . ((int) $targetid) . " AND targettype = '" . $this->db->escape($targettype) . "'";
4582 $sql .= " AND fk_source = " . ((int) $this->id) . " AND sourcetype = '" . $this->db->escape($this->element) . "'";
4583 } else {
4584 $sql .= " (fk_source = " . ((int) $this->id) . " AND sourcetype = '" . $this->db->escape($this->element) . "')";
4585 $sql .= " OR";
4586 $sql .= " (fk_target = " . ((int) $this->id) . " AND targettype = '" . $this->db->escape($this->element) . "')";
4587 }
4588 }
4589
4590 dol_syslog(get_class($this) . "::deleteObjectLinked", LOG_DEBUG);
4591 if (!$this->db->query($sql)) {
4592 $this->error = $this->db->lasterror();
4593 $this->errors[] = $this->error;
4594 $error++;
4595 }
4596 }
4597
4598 if (!$error) {
4599 $this->db->commit();
4600 return 1;
4601 } else {
4602 $this->db->rollback();
4603 return 0;
4604 }
4605 }
4606
4616 public static function getAllItemsLinkedByObjectID($fk_object_where, $field_select, $field_where, $table_element)
4617 {
4618 if (empty($fk_object_where) || empty($field_where) || empty($table_element)) {
4619 return -1;
4620 }
4621 if (!preg_match('/^[_a-zA-Z0-9]+$/', $field_select)) {
4622 dol_syslog('Invalid value $field_select for parameter '.$field_select.' in call to getAllItemsLinkedByObjectID(). Must be a single field name.', LOG_ERR);
4623 }
4624
4625 global $db;
4626
4627 $sql = "SELECT ".$field_select." FROM ".$db->prefix().$table_element." WHERE ".$field_where." = ".((int) $fk_object_where);
4628 $resql = $db->query($sql);
4629
4630 $TRes = array();
4631 if (!empty($resql)) {
4632 while ($res = $db->fetch_object($resql)) {
4633 $TRes[] = $res->{$field_select};
4634 }
4635 }
4636
4637 return $TRes;
4638 }
4639
4648 public static function getCountOfItemsLinkedByObjectID($fk_object_where, $field_where, $table_element)
4649 {
4650 if (empty($fk_object_where) || empty($field_where) || empty($table_element)) {
4651 return -1;
4652 }
4653
4654 global $db;
4655
4656 $sql = "SELECT COUNT(*) as nb FROM ".$db->prefix().$table_element." WHERE ".$field_where." = ".((int) $fk_object_where);
4657 $resql = $db->query($sql);
4658 $n = 0;
4659 if ($resql) {
4660 $res = $db->fetch_object($resql);
4661 if ($res) {
4662 $n = $res->nb;
4663 }
4664 }
4665
4666 return $n;
4667 }
4668
4677 public static function deleteAllItemsLinkedByObjectID($fk_object_where, $field_where, $table_element)
4678 {
4679 if (empty($fk_object_where) || empty($field_where) || empty($table_element)) {
4680 return -1;
4681 }
4682
4683 global $db;
4684
4685 $sql = "DELETE FROM ".$db->prefix().$table_element." WHERE ".$field_where." = ".((int) $fk_object_where);
4686 $resql = $db->query($sql);
4687
4688 if (empty($resql)) {
4689 return 0;
4690 }
4691
4692 return 1;
4693 }
4694
4705 public function setStatut($status, $elementId = null, $elementType = '', $trigkey = '', $fieldstatus = 'fk_statut')
4706 {
4707 global $user;
4708
4709 $savElementId = $elementId; // To be used later to know if we were using the method using the id of this or not.
4710
4711 $elementId = (!empty($elementId) ? $elementId : $this->id);
4712 $elementTable = (!empty($elementType) ? $elementType : $this->table_element);
4713
4714 $this->db->begin();
4715
4716 if ($elementTable == 'facture_rec') {
4717 $fieldstatus = "suspended";
4718 }
4719 if ($elementTable == 'mailing') {
4720 $fieldstatus = "statut";
4721 }
4722 if ($elementTable == 'cronjob') {
4723 $fieldstatus = "status";
4724 }
4725 if ($elementTable == 'user') {
4726 $fieldstatus = "statut";
4727 }
4728 if ($elementTable == 'expensereport') {
4729 $fieldstatus = "fk_statut";
4730 }
4731 if ($elementTable == 'receptiondet_batch') {
4732 $fieldstatus = "status";
4733 }
4734 if ($elementTable == 'prelevement_bons') {
4735 $fieldstatus = "statut";
4736 }
4737 if (isset($this->fields) && is_array($this->fields) && array_key_exists('status', $this->fields)) {
4738 $fieldstatus = 'status';
4739 }
4740
4741 $sql = "UPDATE ".$this->db->prefix().$this->db->sanitize($elementTable);
4742 $sql .= " SET ".$this->db->sanitize($fieldstatus)." = ".((int) $status);
4743 // If status = 1 = validated, update also fk_user_valid
4744 // TODO Replace the test on $elementTable by doing a test on existence of the field in $this->fields
4745 if ($status == 1 && in_array($elementTable, array('expensereport', 'inventory'))) {
4746 $sql .= ", fk_user_valid = ".((int) $user->id);
4747 }
4748 if ($status == 1 && in_array($elementTable, array('expensereport'))) {
4749 $sql .= ", date_valid = '".$this->db->idate(dol_now())."'";
4750 }
4751 if ($status == 1 && in_array($elementTable, array('inventory'))) {
4752 $sql .= ", date_validation = '".$this->db->idate(dol_now())."'";
4753 }
4754 $sql .= " WHERE rowid = ".((int) $elementId);
4755 $sql .= " AND ".$fieldstatus." <> ".((int) $status); // We avoid update if status already correct
4756
4757 dol_syslog(get_class($this)."::setStatut", LOG_DEBUG);
4758 $resql = $this->db->query($sql);
4759 if ($resql) {
4760 $error = 0;
4761
4762 $nb_rows_affected = $this->db->affected_rows($resql); // should be 1 or 0 if status was already correct
4763
4764 if ($nb_rows_affected > 0) {
4765 if (empty($trigkey)) {
4766 // Try to guess trigkey (for backward compatibility, now we should have trigkey defined into the call of setStatus)
4767 if ($this->element == 'supplier_proposal' && $status == 2) {
4768 $trigkey = 'SUPPLIER_PROPOSAL_SIGN'; // 2 = SupplierProposal::STATUS_SIGNED. Can't use constant into this generic class
4769 }
4770 if ($this->element == 'supplier_proposal' && $status == 3) {
4771 $trigkey = 'SUPPLIER_PROPOSAL_REFUSE'; // 3 = SupplierProposal::STATUS_REFUSED. Can't use constant into this generic class
4772 }
4773 if ($this->element == 'supplier_proposal' && $status == 4) {
4774 $trigkey = 'SUPPLIER_PROPOSAL_CLOSE'; // 4 = SupplierProposal::STATUS_CLOSED. Can't use constant into this generic class
4775 }
4776 if ($this->element == 'fichinter' && $status == 3) {
4777 $trigkey = 'FICHINTER_CLASSIFY_DONE';
4778 }
4779 if ($this->element == 'fichinter' && $status == 2) {
4780 $trigkey = 'FICHINTER_CLASSIFY_BILLED';
4781 }
4782 if ($this->element == 'fichinter' && $status == 1) {
4783 $trigkey = 'FICHINTER_CLASSIFY_UNBILLED';
4784 }
4785 }
4786
4787 $this->context = array_merge($this->context, array('newstatus' => $status));
4788
4789 if ($trigkey) {
4790 // Call trigger
4791 $result = $this->call_trigger($trigkey, $user);
4792 if ($result < 0) {
4793 $error++;
4794 }
4795 // End call triggers
4796 }
4797 } else {
4798 // The status was probably already good. We do nothing more, no triggers.
4799 }
4800
4801 if (!$error) {
4802 $this->db->commit();
4803
4804 if (empty($savElementId)) {
4805 // If the element we update is $this (so $elementId was provided as null)
4806 if ($fieldstatus == 'tosell') {
4807 $this->status = $status;
4808 } elseif ($fieldstatus == 'tobuy') {
4809 $this->status_buy = $status; // @phpstan-ignore-line
4810 } else {
4811 $this->status = $status;
4812 }
4813 }
4814
4815 return 1;
4816 } else {
4817 $this->db->rollback();
4818 dol_syslog(get_class($this)."::setStatut ".$this->error, LOG_ERR);
4819 return -1;
4820 }
4821 } else {
4822 $this->error = $this->db->lasterror();
4823 $this->db->rollback();
4824 return -1;
4825 }
4826 }
4827
4828
4836 public function getCanvas($id = 0, $ref = '')
4837 {
4838 global $conf;
4839
4840 if (empty($id) && empty($ref)) {
4841 return 0;
4842 }
4843 if (getDolGlobalString('MAIN_DISABLE_CANVAS')) {
4844 return 0; // To increase speed. Not enabled by default.
4845 }
4846
4847 // Clean parameters
4848 $ref = trim($ref);
4849
4850 $sql = "SELECT rowid, canvas";
4851 $sql .= " FROM ".$this->db->prefix().$this->table_element;
4852 $sql .= " WHERE entity IN (".getEntity($this->element).")";
4853 if (!empty($id)) {
4854 $sql .= " AND rowid = ".((int) $id);
4855 }
4856 if (!empty($ref)) {
4857 $sql .= " AND ref = '".$this->db->escape($ref)."'";
4858 }
4859
4860 $resql = $this->db->query($sql);
4861 if ($resql) {
4862 $obj = $this->db->fetch_object($resql);
4863 if ($obj) {
4864 $this->canvas = $obj->canvas;
4865 return 1;
4866 } else {
4867 return 0;
4868 }
4869 } else {
4870 dol_print_error($this->db);
4871 return -1;
4872 }
4873 }
4874
4875
4882 public function getSpecialCode($lineid)
4883 {
4884 $sql = "SELECT special_code FROM ".$this->db->prefix().$this->table_element_line;
4885 $sql .= " WHERE rowid = ".((int) $lineid);
4886 $resql = $this->db->query($sql);
4887 if ($resql) {
4888 $row = $this->db->fetch_row($resql);
4889 return (!empty($row[0]) ? $row[0] : 0);
4890 }
4891
4892 return 0;
4893 }
4894
4903 public function isObjectUsed($id = 0, $entity = 0)
4904 {
4905 global $langs;
4906
4907 if (empty($id)) {
4908 $id = $this->id;
4909 }
4910
4911 // Check parameters
4912 if (!isset($this->childtables) || !is_array($this->childtables) || count($this->childtables) == 0) {
4913 dol_print_error(null, 'Called isObjectUsed on a class with property this->childtables not defined');
4914 return -1;
4915 }
4916
4917 $arraytoscan = $this->childtables; // array('tablename'=>array('fk_element'=>'parentfield'), ...) or array('tablename'=>array('parent'=>table_parent, 'parentkey'=>'nameoffieldforparentfkkey'), ...)
4918 // For backward compatibility, we check if array is old format array('tablename1', 'tablename2', ...)
4919 $tmparray = array_keys($this->childtables);
4920 if (is_numeric($tmparray[0])) {
4921 $arraytoscan = array_flip($this->childtables);
4922 }
4923
4924 // Test if child exists
4925 $haschild = 0;
4926 foreach ($arraytoscan as $table => $element) {
4927 //print $id.'-'.$table.'-'.$elementname.'<br>';
4928 // Check if element can be deleted
4929 $sql = "SELECT COUNT(*) as nb";
4930 $sql .= " FROM ".$this->db->prefix().$table." as c";
4931 if (!empty($element['parent']) && !empty($element['parentkey'])) {
4932 $sql .= ", ".$this->db->prefix().$element['parent']." as p";
4933 }
4934 if (!empty($element['fk_element'])) {
4935 $sql .= " WHERE c.".$element['fk_element']." = ".((int) $id);
4936 } else {
4937 $sql .= " WHERE c.".$this->fk_element." = ".((int) $id);
4938 }
4939 if (!empty($element['parent']) && !empty($element['parentkey'])) {
4940 $sql .= " AND c.".$element['parentkey']." = p.rowid";
4941 }
4942 if (!empty($element['parent']) && !empty($element['parenttypefield']) && !empty($element['parenttypevalue'])) {
4943 $sql .= " AND c.".$element['parenttypefield']." = '".$this->db->escape($element['parenttypevalue'])."'";
4944 }
4945 if (!empty($entity)) {
4946 if (!empty($element['parent']) && !empty($element['parentkey'])) {
4947 $sql .= " AND p.entity = ".((int) $entity);
4948 } else {
4949 $sql .= " AND c.entity = ".((int) $entity);
4950 }
4951 }
4952
4953 $resql = $this->db->query($sql);
4954 if ($resql) {
4955 $obj = $this->db->fetch_object($resql);
4956 if ($obj->nb > 0) {
4957 $langs->load("errors");
4958 //print 'Found into table '.$table.', type '.$langs->transnoentitiesnoconv($elementname).', haschild='.$haschild;
4959 $haschild += $obj->nb;
4960 if (is_numeric($element)) { // very old usage array('table1', 'table2', ...)
4961 $this->errors[] = $langs->transnoentitiesnoconv("ErrorRecordHasAtLeastOneChildOfType", method_exists($this, 'getNomUrl') ? $this->getNomUrl() : $this->ref, $table);
4962 } elseif (is_string($element)) { // old usage array('table1' => 'TranslateKey1', 'table2' => 'TranslateKey2', ...)
4963 $this->errors[] = $langs->transnoentitiesnoconv("ErrorRecordHasAtLeastOneChildOfType", method_exists($this, 'getNomUrl') ? $this->getNomUrl() : $this->ref, $langs->transnoentitiesnoconv($element));
4964 } else { // new usage: $element['name']=Translation key
4965 $this->errors[] = $langs->transnoentitiesnoconv("ErrorRecordHasAtLeastOneChildOfType", method_exists($this, 'getNomUrl') ? $this->getNomUrl() : $this->ref, $langs->transnoentitiesnoconv($element['name']));
4966 }
4967 break; // We found at least one, we stop here
4968 }
4969 } else {
4970 $this->errors[] = $this->db->lasterror();
4971 return -1;
4972 }
4973 }
4974 if ($haschild > 0) {
4975 $this->errors[] = "ErrorRecordHasChildren";
4976 return $haschild;
4977 } else {
4978 return 0;
4979 }
4980 }
4981
4988 public function hasProductsOrServices($predefined = -1)
4989 {
4990 $nb = 0;
4991
4992 foreach ($this->lines as $key => $val) {
4993 $qualified = 0;
4994 if ($predefined == -1) {
4995 $qualified = 1;
4996 }
4997 if ($predefined == 1 && $val->fk_product > 0) {
4998 $qualified = 1;
4999 }
5000 if ($predefined == 0 && $val->fk_product <= 0) {
5001 $qualified = 1;
5002 }
5003 if ($predefined == 2 && $val->fk_product > 0 && $val->product_type == 0) {
5004 $qualified = 1;
5005 }
5006 if ($predefined == 3 && $val->fk_product > 0 && $val->product_type == 1) {
5007 $qualified = 1;
5008 }
5009 if ($qualified) {
5010 $nb++;
5011 }
5012 }
5013 dol_syslog(get_class($this).'::hasProductsOrServices we found '.$nb.' qualified lines of products/servcies');
5014 return $nb;
5015 }
5016
5022 public function getTotalDiscount()
5023 {
5024 if (!empty($this->table_element_line)) {
5025 $total_discount = 0.00;
5026
5027 $sql = "SELECT subprice as pu_ht, qty, remise_percent, total_ht";
5028 $sql .= " FROM ".$this->db->prefix().$this->table_element_line;
5029 $sql .= " WHERE ".$this->fk_element." = ".((int) $this->id);
5030
5031 dol_syslog(get_class($this).'::getTotalDiscount', LOG_DEBUG);
5032 $resql = $this->db->query($sql);
5033 if ($resql) {
5034 $num = $this->db->num_rows($resql);
5035 $i = 0;
5036 while ($i < $num) {
5037 $obj = $this->db->fetch_object($resql);
5038
5039 $pu_ht = $obj->pu_ht;
5040 $qty = $obj->qty;
5041 $total_ht = $obj->total_ht;
5042
5043 $total_discount_line = (float) price2num(($pu_ht * $qty) - $total_ht, 'MT');
5044 $total_discount += $total_discount_line;
5045
5046 $i++;
5047 }
5048 }
5049
5050 //print $total_discount; exit;
5051 return (float) price2num($total_discount);
5052 }
5053
5054 return null;
5055 }
5056
5057
5064 public function getTotalWeightVolume()
5065 {
5066 $totalWeight = 0;
5067 $totalVolume = 0;
5068 // defined for shipment only
5069 $totalOrdered = 0;
5070 // defined for shipment only
5071 $totalToShip = 0;
5072
5073 if (empty($this->lines)) {
5074 return array('weight' => $totalWeight, 'volume' => $totalVolume, 'ordered' => $totalOrdered, 'toship' => $totalToShip);
5075 }
5076
5077 foreach ($this->lines as $line) {
5078 if (isset($line->qty_asked)) {
5079 $totalOrdered += $line->qty_asked; // defined for shipment only
5080 }
5081 if (isset($line->qty_shipped)) {
5082 $totalToShip += $line->qty_shipped; // defined for shipment only
5083 } elseif ($line->element == 'commandefournisseurdispatch' && isset($line->qty)) {
5084 if (empty($totalToShip)) {
5085 $totalToShip = 0;
5086 }
5087 $totalToShip += $line->qty; // defined for reception only
5088 }
5089
5090 // Define qty, weight, volume, weight_units, volume_units
5091 if ($this->element == 'shipping') {
5092 // for shipments
5093 $qty = $line->qty_shipped ? $line->qty_shipped : 0;
5094 } else {
5095 $qty = $line->qty ? $line->qty : 0;
5096 }
5097
5098 $weight = !empty($line->weight) ? $line->weight : 0;
5099 ($weight == 0 && !empty($line->product->weight)) ? $weight = $line->product->weight : 0;
5100 $volume = !empty($line->volume) ? $line->volume : 0;
5101 ($volume == 0 && !empty($line->product->volume)) ? $volume = $line->product->volume : 0;
5102
5103 $weight_units = !empty($line->weight_units) ? $line->weight_units : 0;
5104 ($weight_units == 0 && !empty($line->product->weight_units)) ? $weight_units = $line->product->weight_units : 0;
5105 $volume_units = !empty($line->volume_units) ? $line->volume_units : 0;
5106 ($volume_units == 0 && !empty($line->product->volume_units)) ? $volume_units = $line->product->volume_units : 0;
5107
5108 $weightUnit = 0;
5109 $volumeUnit = 0;
5110 if (!empty($weight_units)) {
5111 $weightUnit = $weight_units;
5112 }
5113 if (!empty($volume_units)) {
5114 $volumeUnit = $volume_units;
5115 }
5116
5117 if (empty($totalWeight)) {
5118 $totalWeight = 0; // Avoid warning because $totalWeight is ''
5119 }
5120 if (empty($totalVolume)) {
5121 $totalVolume = 0; // Avoid warning because $totalVolume is ''
5122 }
5123
5124 //var_dump($line->volume_units);
5125 if ($weight_units < 50) { // < 50 means a standard unit (power of 10 of official unit), > 50 means an exotic unit (like inch)
5126 $trueWeightUnit = pow(10, $weightUnit);
5127 $totalWeight += $weight * $qty * $trueWeightUnit;
5128 } else {
5129 if ($weight_units == 99) {
5130 // conversion 1 Pound = 0.45359237 KG
5131 $trueWeightUnit = 0.45359237;
5132 $totalWeight += $weight * $qty * $trueWeightUnit;
5133 } elseif ($weight_units == 98) {
5134 // conversion 1 Ounce = 0.0283495 KG
5135 $trueWeightUnit = 0.0283495;
5136 $totalWeight += $weight * $qty * $trueWeightUnit;
5137 } else {
5138 $totalWeight += $weight * $qty; // This may be wrong if we mix different units
5139 }
5140 }
5141 if ($volume_units < 50) { // >50 means a standard unit (power of 10 of official unit), > 50 means an exotic unit (like inch)
5142 //print $line->volume."x".$line->volume_units."x".($line->volume_units < 50)."x".$volumeUnit;
5143 $trueVolumeUnit = pow(10, $volumeUnit);
5144 //print $line->volume;
5145 $totalVolume += $volume * $qty * $trueVolumeUnit;
5146 } else {
5147 $totalVolume += $volume * $qty; // This may be wrong if we mix different units
5148 }
5149 }
5150
5151 return array('weight' => $totalWeight, 'volume' => $totalVolume, 'ordered' => $totalOrdered, 'toship' => $totalToShip);
5152 }
5153
5154
5160 public function setExtraParameters()
5161 {
5162 $this->db->begin();
5163
5164 $extraparams = (!empty($this->extraparams) ? json_encode($this->extraparams) : null);
5165
5166 $sql = "UPDATE ".$this->db->prefix().$this->table_element;
5167 $sql .= " SET extraparams = ".(!empty($extraparams) ? "'".$this->db->escape($extraparams)."'" : "null");
5168 $sql .= " WHERE rowid = ".((int) $this->id);
5169
5170 dol_syslog(get_class($this)."::setExtraParameters", LOG_DEBUG);
5171 $resql = $this->db->query($sql);
5172 if (!$resql) {
5173 $this->error = $this->db->lasterror();
5174 $this->db->rollback();
5175 return -1;
5176 } else {
5177 $this->db->commit();
5178 return 1;
5179 }
5180 }
5181
5182
5183 // --------------------
5184 // TODO: All functions here must be redesigned and moved as they are not business functions but output functions
5185 // --------------------
5186
5187 /* This is to show add lines */
5188
5198 public function formAddObjectLine($dateSelector, $seller, $buyer, $defaulttpldir = '/core/tpl')
5199 {
5200 global $conf, $user, $langs, $object, $hookmanager, $extrafields, $form;
5201
5202 // Line extrafield
5203 if (!is_object($extrafields)) {
5204 require_once DOL_DOCUMENT_ROOT.'/core/class/extrafields.class.php';
5205 $extrafields = new ExtraFields($this->db);
5206 }
5207 $extrafields->fetch_name_optionals_label($this->table_element_line);
5208
5209 // Output template part (modules that overwrite templates must declare this into descriptor)
5210 // Use global variables + $dateSelector + $seller and $buyer
5211 // Note: This is deprecated. If you need to overwrite the tpl file, use instead the hook 'formAddObjectLine'.
5212 $dirtpls = array_merge($conf->modules_parts['tpl'], array($defaulttpldir));
5213 foreach ($dirtpls as $module => $reldir) {
5214 if (!empty($module)) {
5215 $tpl = dol_buildpath($reldir.'/objectline_create.tpl.php');
5216 } else {
5217 $tpl = DOL_DOCUMENT_ROOT.$reldir.'/objectline_create.tpl.php';
5218 }
5219
5220 if (empty($conf->file->strict_mode)) {
5221 $res = @include $tpl;
5222 } else {
5223 $res = include $tpl; // for debug
5224 }
5225 if ($res) {
5226 break;
5227 }
5228 }
5229 }
5230
5231
5232
5233 /* This is to show array of line of details */
5234
5235
5250 public function printObjectLines($action, $seller, $buyer, $selected = 0, $dateSelector = 0, $defaulttpldir = '/core/tpl')
5251 {
5252 global $conf, $hookmanager, $langs, $user, $form, $extrafields, $object;
5253 // TODO We should not use global var for this
5254 global $inputalsopricewithtax, $usemargins, $disableedit, $disablemove, $disableremove, $outputalsopricetotalwithtax;
5255
5256 // Define $usemargins (used by objectline_xxx.tpl.php files)
5257 $usemargins = 0;
5258 if (isModEnabled('margin') && !empty($this->element) && in_array($this->element, array('facture', 'facturerec', 'propal', 'commande'))) {
5259 $usemargins = 1;
5260 }
5261
5262 $num = count($this->lines);
5263
5264 // Line extrafield
5265 if (!is_object($extrafields)) {
5266 require_once DOL_DOCUMENT_ROOT.'/core/class/extrafields.class.php';
5267 $extrafields = new ExtraFields($this->db);
5268 }
5269 $extrafields->fetch_name_optionals_label($this->table_element_line);
5270
5271 if (method_exists($this, 'loadExpeditions')) {
5272 $this->loadExpeditions();
5273 }
5274
5275 $parameters = array('num' => $num, 'dateSelector' => $dateSelector, 'seller' => $seller, 'buyer' => $buyer, 'selected' => $selected, 'table_element_line' => $this->table_element_line);
5276 $reshook = $hookmanager->executeHooks('printObjectLineTitle', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
5277 if (empty($reshook)) {
5278 // Output template part (modules that overwrite templates must declare this into descriptor)
5279 // Use global variables + $dateSelector + $seller and $buyer
5280 // Note: This is deprecated. If you need to overwrite the tpl file, use instead the hook.
5281 $dirtpls = array_merge($conf->modules_parts['tpl'], array($defaulttpldir));
5282 foreach ($dirtpls as $module => $reldir) {
5283 $res = 0;
5284 if (!empty($module)) {
5285 $tpl = dol_buildpath($reldir.'/objectline_title.tpl.php');
5286 } else {
5287 $tpl = DOL_DOCUMENT_ROOT.$reldir.'/objectline_title.tpl.php';
5288 }
5289 if (file_exists($tpl)) {
5290 if (empty($conf->file->strict_mode)) {
5291 $res = @include $tpl;
5292 } else {
5293 $res = include $tpl; // for debug
5294 }
5295 }
5296 if ($res) {
5297 break;
5298 }
5299 }
5300 }
5301
5302 $i = 0;
5303
5304 print "<!-- begin printObjectLines() -->\n";
5305 foreach ($this->lines as $line) {
5306 //Line extrafield
5307 $line->fetch_optionals();
5308
5309 //if (is_object($hookmanager) && (($line->product_type == 9 && !empty($line->special_code)) || !empty($line->fk_parent_line)))
5310 if (is_object($hookmanager)) { // Old code is commented on preceding line.
5311 if (empty($line->fk_parent_line)) {
5312 $parameters = array('line' => $line, 'num' => $num, 'i' => $i, 'dateSelector' => $dateSelector, 'seller' => $seller, 'buyer' => $buyer, 'selected' => $selected, 'table_element_line' => $line->table_element, 'defaulttpldir' => $defaulttpldir);
5313 $reshook = $hookmanager->executeHooks('printObjectLine', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
5314 } else {
5315 $parameters = array('line' => $line, 'num' => $num, 'i' => $i, 'dateSelector' => $dateSelector, 'seller' => $seller, 'buyer' => $buyer, 'selected' => $selected, 'table_element_line' => $line->table_element, 'fk_parent_line' => $line->fk_parent_line, 'defaulttpldir' => $defaulttpldir);
5316 $reshook = $hookmanager->executeHooks('printObjectSubLine', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
5317 }
5318 }
5319 if (empty($reshook)) {
5320 $this->printObjectLine($action, $line, '', $num, $i, $dateSelector, $seller, $buyer, $selected, $extrafields, $defaulttpldir);
5321 }
5322
5323 $i++;
5324 }
5325 print "<!-- end printObjectLines() -->\n";
5326 }
5327
5345 public function printObjectLine($action, $line, $var, $num, $i, $dateSelector, $seller, $buyer, $selected = 0, $extrafields = null, $defaulttpldir = '/core/tpl')
5346 {
5347 global $conf, $langs, $user, $object, $hookmanager;
5348 global $form;
5349 global $disableedit, $disablemove, $disableremove; // TODO We should not use global var for this !
5350
5351 // var used into tpl
5352 $text = '';
5353 $description = '';
5354
5355 // Line in view mode
5356 if ($action != 'editline' || $selected != $line->id) {
5357 // Product
5358 if (!empty($line->fk_product) && $line->fk_product > 0) {
5359 $product_static = new Product($this->db);
5360 $product_static->fetch($line->fk_product);
5361
5362 $product_static->ref = $line->ref; //can change ref in hook
5363 $product_static->label = !empty($line->label) ? $line->label : ""; //can change label in hook
5364
5365 $text = $product_static->getNomUrl(1);
5366
5367 // Define output language and label
5368 if (getDolGlobalInt('MAIN_MULTILANGS')) {
5369 if (property_exists($this, 'socid') && !is_object($this->thirdparty)) {
5370 dol_print_error(null, 'Error: Method printObjectLine was called on an object and object->fetch_thirdparty was not done before');
5371 return;
5372 }
5373
5374 $prod = new Product($this->db);
5375 $prod->fetch($line->fk_product);
5376
5377 $outputlangs = $langs;
5378 $newlang = '';
5379 if (empty($newlang) && GETPOST('lang_id', 'aZ09')) {
5380 $newlang = GETPOST('lang_id', 'aZ09');
5381 }
5382 if (getDolGlobalString('PRODUIT_TEXTS_IN_THIRDPARTY_LANGUAGE') && empty($newlang) && is_object($this->thirdparty)) {
5383 $newlang = $this->thirdparty->default_lang; // To use language of customer
5384 }
5385 if (!empty($newlang)) {
5386 $outputlangs = new Translate("", $conf);
5387 $outputlangs->setDefaultLang($newlang);
5388 }
5389
5390 $label = (!empty($prod->multilangs[$outputlangs->defaultlang]["label"])) ? $prod->multilangs[$outputlangs->defaultlang]["label"] : $line->product_label;
5391 } else {
5392 $label = $line->product_label;
5393 }
5394
5395 $text .= ' - '.(!empty($line->label) ? $line->label : $label);
5396 $description .= (getDolGlobalInt('PRODUIT_DESC_IN_FORM_ACCORDING_TO_DEVICE') ? '' : (!empty($line->description) ? dol_htmlentitiesbr($line->description) : '')); // Description is what to show on popup. We shown nothing if already into desc.
5397 }
5398
5399 $line->pu_ttc = price2num((!empty($line->subprice) ? $line->subprice : 0) * (1 + ((!empty($line->tva_tx) ? $line->tva_tx : 0) / 100)), 'MU');
5400
5401 // Output template part (modules that overwrite templates must declare this into descriptor)
5402 // Use global variables + $dateSelector + $seller and $buyer
5403 // Note: This is deprecated. If you need to overwrite the tpl file, use instead the hook printObjectLine and printObjectSubLine.
5404
5405 $qty_shipped = 0;
5406 if (isset($this->expeditions[$line->id])) {
5407 $qty_shipped = $this->expeditions[$line->id];
5408 }
5409 $disableedit = ($qty_shipped > 0) && ($qty_shipped >= $line->qty);
5410
5411 $dirtpls = array_merge($conf->modules_parts['tpl'], array($defaulttpldir));
5412 foreach ($dirtpls as $module => $reldir) {
5413 $res = 0;
5414 if (!empty($module)) {
5415 $tpl = dol_buildpath($reldir.'/objectline_view.tpl.php');
5416 } else {
5417 $tpl = DOL_DOCUMENT_ROOT.$reldir.'/objectline_view.tpl.php';
5418 }
5419 //var_dump($tpl);
5420 if (file_exists($tpl)) {
5421 if (empty($conf->file->strict_mode)) {
5422 $res = @include $tpl;
5423 } else {
5424 $res = include $tpl; // for debug
5425 }
5426 }
5427 if ($res) {
5428 break;
5429 }
5430 }
5431 }
5432
5433 // Line in update mode
5434 if ($this->status == 0 && $action == 'editline' && $selected == $line->id) {
5435 $label = (!empty($line->label) ? $line->label : (($line->fk_product > 0) ? $line->product_label : ''));
5436
5437 $line->pu_ttc = price2num($line->subprice * (1 + ($line->tva_tx / 100)), 'MU');
5438
5439 // Output template part (modules that overwrite templates must declare this into descriptor)
5440 // Use global variables + $dateSelector + $seller and $buyer
5441 // Note: This is deprecated. If you need to overwrite the tpl file, use instead the hook printObjectLine and printObjectSubLine.
5442 $dirtpls = array_merge($conf->modules_parts['tpl'], array($defaulttpldir));
5443 foreach ($dirtpls as $module => $reldir) {
5444 if (!empty($module)) {
5445 $tpl = dol_buildpath($reldir.'/objectline_edit.tpl.php');
5446 } else {
5447 $tpl = DOL_DOCUMENT_ROOT.$reldir.'/objectline_edit.tpl.php';
5448 }
5449
5450 if (empty($conf->file->strict_mode)) {
5451 $res = @include $tpl;
5452 } else {
5453 $res = include $tpl; // for debug
5454 }
5455 if ($res) {
5456 break;
5457 }
5458 }
5459 }
5460 }
5461
5462
5463 /* This is to show array of line of details of source object */
5464
5465
5476 public function printOriginLinesList($restrictlist = '', $selectedLines = array())
5477 {
5478 global $langs, $hookmanager, $form, $action;
5479
5480 print '<tr class="liste_titre">';
5481 print '<td class="linecolref">'.$langs->trans('Ref').'</td>';
5482 print '<td class="linecoldescription">'.$langs->trans('Description').'</td>';
5483 print '<td class="linecolvat right">'.$langs->trans('VATRate').'</td>';
5484 print '<td class="linecoluht right">'.$langs->trans('PriceUHT').'</td>';
5485 if (isModEnabled("multicurrency")) {
5486 print '<td class="linecoluht_currency right">'.$langs->trans('PriceUHTCurrency').'</td>';
5487 }
5488 print '<td class="linecolqty right">'.$langs->trans('Qty').'</td>';
5489 if (getDolGlobalInt('PRODUCT_USE_UNITS')) {
5490 print '<td class="linecoluseunit left">'.$langs->trans('Unit').'</td>';
5491 }
5492 print '<td class="linecoldiscount right">'.$langs->trans('ReductionShort').'</td>';
5493 print '<td class="linecolht right">'.$langs->trans('TotalHT').'</td>';
5494 print '<td class="center">'.$form->showCheckAddButtons('checkforselect', 1).'</td>';
5495 print '</tr>';
5496 $i = 0;
5497
5498 if (!empty($this->lines)) {
5499 foreach ($this->lines as $line) {
5500 $reshook = 0;
5501 //if (is_object($hookmanager) && (($line->product_type == 9 && !empty($line->special_code)) || !empty($line->fk_parent_line))) {
5502 if (is_object($hookmanager)) { // Old code is commented on preceding line.
5503 $parameters = array('line' => $line, 'i' => $i, 'restrictlist' => $restrictlist, 'selectedLines' => $selectedLines);
5504 if (!empty($line->fk_parent_line)) {
5505 $parameters['fk_parent_line'] = $line->fk_parent_line;
5506 }
5507 $reshook = $hookmanager->executeHooks('printOriginObjectLine', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
5508 }
5509 if (empty($reshook)) {
5510 $this->printOriginLine($line, '', $restrictlist, '/core/tpl', $selectedLines);
5511 }
5512
5513 $i++;
5514 }
5515 }
5516 }
5517
5531 public function printOriginLine($line, $var, $restrictlist = '', $defaulttpldir = '/core/tpl', $selectedLines = array())
5532 {
5533 global $langs, $conf;
5534
5535 //var_dump($line);
5536 if (!empty($line->date_start)) {
5537 // @phan-suppress-next-line PhanUndeclaredProperty
5538 $date_start = $line->date_start;
5539 } else {
5540 $date_start = $line->date_debut_prevue;
5541 if ($line->date_debut_reel) {
5542 $date_start = $line->date_debut_reel;
5543 }
5544 }
5545 if (!empty($line->date_end)) {
5546 // @phan-suppress-next-line PhanUndeclaredProperty
5547 $date_end = $line->date_end;
5548 } else {
5549 $date_end = $line->date_fin_prevue;
5550 if ($line->date_fin_reel) {
5551 $date_end = $line->date_fin_reel;
5552 }
5553 }
5554
5555 $this->tpl['id'] = $line->id;
5556
5557 $this->tpl['label'] = '';
5558 if (!empty($line->fk_parent_line)) {
5559 $this->tpl['label'] .= img_picto('', 'rightarrow');
5560 }
5561
5562 if (($line->info_bits & 2) == 2) { // TODO Not sure this is used for source object
5563 $discount = new DiscountAbsolute($this->db);
5564 if (property_exists($this, 'socid')) {
5565 $discount->fk_soc = $this->socid;
5566 $discount->socid = $this->socid;
5567 }
5568 $this->tpl['label'] .= $discount->getNomUrl(0, 'discount');
5569 } elseif (!empty($line->fk_product)) {
5570 $productstatic = new Product($this->db);
5571 $productstatic->id = $line->fk_product;
5572 $productstatic->ref = $line->ref;
5573 $productstatic->type = $line->fk_product_type;
5574 if (empty($productstatic->ref)) {
5575 $line->fetch_product();
5576 $productstatic = $line->product;
5577 }
5578
5579 $this->tpl['label'] .= $productstatic->getNomUrl(1);
5580 $this->tpl['label'] .= ' - '.(!empty($line->label) ? $line->label : $line->product_label);
5581 // Dates
5582 if ($line->product_type == 1 && ($date_start || $date_end)) {
5583 $this->tpl['label'] .= get_date_range($date_start, $date_end);
5584 }
5585 } else {
5586 $this->tpl['label'] .= ($line->product_type == -1 ? '&nbsp;' : ($line->product_type == 1 ? img_object($langs->trans(''), 'service') : img_object($langs->trans(''), 'product')));
5587 if (!empty($line->desc)) {
5588 $this->tpl['label'] .= $line->desc;
5589 } else {
5590 $this->tpl['label'] .= ($line->label ? '&nbsp;'.$line->label : '');
5591 }
5592
5593 // Dates
5594 if ($line->product_type == 1 && ($date_start || $date_end)) {
5595 $this->tpl['label'] .= get_date_range($date_start, $date_end);
5596 }
5597 }
5598
5599 if (!empty($line->desc)) {
5600 '@phan-var-force OrderLine|FactureLigne|ContratLigne|FactureFournisseurLigneRec|SupplierInvoiceLine|SupplierProposalLine $line';
5601 if ($line->desc == '(CREDIT_NOTE)') { // TODO Not sure this is used for source object
5602 $discount = new DiscountAbsolute($this->db);
5603 $discount->fetch($line->fk_remise_except);
5604 $this->tpl['description'] = $langs->transnoentities("DiscountFromCreditNote", $discount->getNomUrl(0));
5605 } elseif ($line->desc == '(DEPOSIT)') { // TODO Not sure this is used for source object
5606 $discount = new DiscountAbsolute($this->db);
5607 $discount->fetch($line->fk_remise_except);
5608 $this->tpl['description'] = $langs->transnoentities("DiscountFromDeposit", $discount->getNomUrl(0));
5609 } elseif ($line->desc == '(EXCESS RECEIVED)') {
5610 $discount = new DiscountAbsolute($this->db);
5611 $discount->fetch($line->fk_remise_except);
5612 $this->tpl['description'] = $langs->transnoentities("DiscountFromExcessReceived", $discount->getNomUrl(0));
5613 } elseif ($line->desc == '(EXCESS PAID)') {
5614 $discount = new DiscountAbsolute($this->db);
5615 $discount->fetch($line->fk_remise_except);
5616 $this->tpl['description'] = $langs->transnoentities("DiscountFromExcessPaid", $discount->getNomUrl(0));
5617 } else {
5618 $this->tpl['description'] = dol_trunc($line->desc, 60);
5619 }
5620 } else {
5621 $this->tpl['description'] = '&nbsp;';
5622 }
5623
5624 // VAT Rate
5625 $this->tpl['vat_rate'] = vatrate($line->tva_tx, true);
5626 $this->tpl['vat_rate'] .= (($line->info_bits & 1) == 1) ? '*' : '';
5627 if (!empty($line->vat_src_code) && !preg_match('/\‍(/', $this->tpl['vat_rate'])) {
5628 $this->tpl['vat_rate'] .= ' ('.$line->vat_src_code.')';
5629 }
5630
5631 $this->tpl['price'] = price($line->subprice);
5632 $this->tpl['total_ht'] = price($line->total_ht);
5633 $this->tpl['multicurrency_price'] = price($line->multicurrency_subprice);
5634 $this->tpl['qty'] = (($line->info_bits & 2) != 2) ? $line->qty : '&nbsp;';
5635 if (getDolGlobalInt('PRODUCT_USE_UNITS')) {
5636 $this->tpl['unit'] = $langs->transnoentities($line->getLabelOfUnit('long'));
5637 }
5638 $this->tpl['remise_percent'] = (($line->info_bits & 2) != 2) ? vatrate((string) $line->remise_percent, true) : '&nbsp;';
5639
5640 // Is the line strike or not
5641 $this->tpl['strike'] = 0;
5642 if ($restrictlist == 'services' && $line->product_type != Product::TYPE_SERVICE) {
5643 $this->tpl['strike'] = 1;
5644 }
5645
5646 // Output template part (modules that overwrite templates must declare this into descriptor)
5647 // Use global variables + $dateSelector + $seller and $buyer
5648 $dirtpls = array_merge($conf->modules_parts['tpl'], array($defaulttpldir));
5649 foreach ($dirtpls as $module => $reldir) {
5650 if (!empty($module)) {
5651 $tpl = dol_buildpath($reldir.'/originproductline.tpl.php');
5652 } else {
5653 $tpl = DOL_DOCUMENT_ROOT.$reldir.'/originproductline.tpl.php';
5654 }
5655
5656 if (empty($conf->file->strict_mode)) {
5657 $res = @include $tpl;
5658 } else {
5659 $res = include $tpl; // for debug
5660 }
5661 if ($res) {
5662 break;
5663 }
5664 }
5665 }
5666
5667
5668 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
5679 public function add_element_resource($resource_id, $resource_type, $busy = 0, $mandatory = 0)
5680 {
5681 // phpcs:enable
5682 $this->db->begin();
5683
5684 $sql = "INSERT INTO ".$this->db->prefix()."element_resources (";
5685 $sql .= "resource_id";
5686 $sql .= ", resource_type";
5687 $sql .= ", element_id";
5688 $sql .= ", element_type";
5689 $sql .= ", busy";
5690 $sql .= ", mandatory";
5691 $sql .= ") VALUES (";
5692 $sql .= ((int) $resource_id);
5693 $sql .= ", '".$this->db->escape($resource_type)."'";
5694 $sql .= ", '".$this->db->escape($this->id)."'";
5695 $sql .= ", '".$this->db->escape($this->element)."'";
5696 $sql .= ", '".$this->db->escape($busy)."'";
5697 $sql .= ", '".$this->db->escape($mandatory)."'";
5698 $sql .= ")";
5699
5700 dol_syslog(get_class($this)."::add_element_resource", LOG_DEBUG);
5701 if ($this->db->query($sql)) {
5702 $this->db->commit();
5703 return 1;
5704 } else {
5705 $this->error = $this->db->lasterror();
5706 $this->db->rollback();
5707 return 0;
5708 }
5709 }
5710
5711 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
5720 public function delete_resource($rowid, $element, $notrigger = 0)
5721 {
5722 // phpcs:enable
5723 global $user;
5724
5725 $this->db->begin();
5726
5727 $sql = "DELETE FROM ".$this->db->prefix()."element_resources";
5728 $sql .= " WHERE rowid = ".((int) $rowid);
5729
5730 dol_syslog(get_class($this)."::delete_resource", LOG_DEBUG);
5731
5732 $resql = $this->db->query($sql);
5733 if (!$resql) {
5734 $this->error = $this->db->lasterror();
5735 $this->db->rollback();
5736 return -1;
5737 } else {
5738 if (!$notrigger) {
5739 $result = $this->call_trigger(strtoupper($element).'_DELETE_RESOURCE', $user);
5740 if ($result < 0) {
5741 $this->db->rollback();
5742 return -1;
5743 }
5744 }
5745 $this->db->commit();
5746 return 1;
5747 }
5748 }
5749
5750
5756 public function __clone()
5757 {
5758 // Force a copy of this->lines, otherwise it will point to same object.
5759 if (isset($this->lines) && is_array($this->lines)) {
5760 $nboflines = count($this->lines);
5761 for ($i = 0; $i < $nboflines; $i++) {
5762 if (is_object($this->lines[$i])) {
5763 $this->lines[$i] = clone $this->lines[$i];
5764 }
5765 }
5766 }
5767 }
5768
5782 protected function commonGenerateDocument($modelspath, $modele, $outputlangs, $hidedetails, $hidedesc, $hideref, $moreparams = null)
5783 {
5784 global $conf, $langs, $user, $hookmanager, $action;
5785
5786 $srctemplatepath = '';
5787
5788 $parameters = array('modelspath' => $modelspath, 'modele' => $modele, 'outputlangs' => $outputlangs, 'hidedetails' => $hidedetails, 'hidedesc' => $hidedesc, 'hideref' => $hideref, 'moreparams' => $moreparams);
5789 $reshook = $hookmanager->executeHooks('commonGenerateDocument', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
5790
5791 if (!empty($reshook)) {
5792 return $reshook;
5793 }
5794
5795 dol_syslog("commonGenerateDocument modele=".$modele." outputlangs->defaultlang=".(is_object($outputlangs) ? $outputlangs->defaultlang : 'null'));
5796
5797 if (empty($modele)) {
5798 $this->error = 'BadValueForParameterModele';
5799 return -1;
5800 }
5801
5802 // Increase limit for PDF build
5803 $err = error_reporting();
5804 error_reporting(0);
5805 @set_time_limit(120);
5806 error_reporting($err);
5807
5808 // If selected model is a filename template (then $modele="modelname" or "modelname:filename")
5809 $tmp = explode(':', $modele, 2);
5810 $saved_model = $modele;
5811 if (!empty($tmp[1])) {
5812 $modele = $tmp[0];
5813 $srctemplatepath = $tmp[1];
5814 }
5815
5816 // Search template files
5817 $file = '';
5818 $classname = '';
5819 $filefound = '';
5820 $dirmodels = array('/');
5821 if (is_array($conf->modules_parts['models'])) {
5822 $dirmodels = array_merge($dirmodels, $conf->modules_parts['models']);
5823 }
5824 foreach ($dirmodels as $reldir) {
5825 foreach (array('doc', 'pdf') as $prefix) {
5826 if (in_array(get_class($this), array('Adherent'))) {
5827 // Member module use prefix_modele.class.php
5828 $file = $prefix."_".$modele.".class.php";
5829 } else {
5830 // Other module use prefix_modele.modules.php
5831 $file = $prefix."_".$modele.".modules.php";
5832 }
5833
5834 $file = dol_sanitizeFileName($file);
5835
5836 // We check if the file exists
5837 $file = dol_buildpath($reldir.$modelspath.$file, 0);
5838 if (file_exists($file)) {
5839 $filefound = $file;
5840 $classname = $prefix.'_'.$modele;
5841 break;
5842 }
5843 }
5844 if ($filefound) {
5845 break;
5846 }
5847 }
5848
5849 if ($filefound === '' || $classname === '') {
5850 $this->error = $langs->trans("Error").' Failed to load doc generator with modelpaths='.$modelspath.' - modele='.$modele;
5851 $this->errors[] = $this->error;
5852 dol_syslog($this->error, LOG_ERR);
5853 return -1;
5854 }
5855
5856 // Sanitize $filefound
5857 $filefound = dol_sanitizePathName($filefound);
5858
5859 // If generator was found
5860 global $db; // Required to solve a conception error making an include of some code that uses $db instead of $this->db just after.
5861
5862 require_once $filefound;
5863
5864 $obj = new $classname($this->db);
5865
5866 // TODO: Check the following classes that seem possible for $obj, but removed for compatibility:
5867 // ModeleBankAccountDoc|ModeleExpenseReport|ModelePDFBom|ModelePDFCommandes|ModelePDFContract|
5868 // ModelePDFDeliveryOrder|ModelePDFEvaluation|ModelePDFFactures|ModelePDFFicheinter|
5869 // ModelePDFMo|ModelePDFMovement|ModelePDFProduct|ModelePDFProjects|ModelePDFPropales|
5870 // ModelePDFRecruitmentJobPosition|ModelePDFSupplierProposal|ModelePDFSuppliersInvoices|
5871 // ModelePDFSuppliersOrders|ModelePDFSuppliersPayments|ModelePdfExpedition|ModelePdfReception|
5872 // ModelePDFStock|ModelePDFStockTransfer|
5873 // ModeleDon|ModelePDFTask|
5874 // ModelePDFAsset|ModelePDFTicket|ModelePDFUserGroup|ModeleThirdPartyDoc|ModelePDFUser
5875 // Has no write_file: ModeleBarCode|ModeleImports|ModeleExports|
5876 '@phan-var-force ModelePDFMember $obj';
5877 // '@phan-var-force ModelePDFMember|ModeleBarCode|ModeleDon|ModeleExports|ModeleImports|ModelePDFAsset|ModelePDFContract|ModelePDFDeliveryOrder|ModelePDFEvaluation|ModelePDFFactures|ModelePDFFicheinter|ModelePDFMo|ModelePDFMovement|ModelePDFProduct|ModelePDFProjects|ModelePDFPropales|ModelePDFRecruitmentJobPosition|ModelePDFStock|ModelePDFStockTransfer|ModelePDFSupplierProposal|ModelePDFSuppliersInvoices|ModelePDFSuppliersOrders|ModelePDFSuppliersPayments|ModelePDFTask|ModelePDFTicket|ModelePDFUser|ModelePDFUserGroup|ModelePdfExpedition|ModelePdfReception|ModeleThirdPartyDoc $obj';
5878
5879 // If generator is ODT, we must have srctemplatepath defined, if not we set it.
5880 if ($obj->type == 'odt' && empty($srctemplatepath)) {
5881 $varfortemplatedir = $obj->scandir;
5882 if ($varfortemplatedir && getDolGlobalString($varfortemplatedir)) {
5883 $dirtoscan = getDolGlobalString($varfortemplatedir);
5884
5885 $listoffiles = array();
5886
5887 // Now we add first model found in directories scanned
5888 $listofdir = explode(',', $dirtoscan);
5889 foreach ($listofdir as $key => $tmpdir) {
5890 $tmpdir = trim($tmpdir);
5891 $tmpdir = preg_replace('/DOL_DATA_ROOT/', DOL_DATA_ROOT, $tmpdir);
5892 if (!$tmpdir) {
5893 unset($listofdir[$key]);
5894 continue;
5895 }
5896 if (is_dir($tmpdir)) {
5897 $tmpfiles = dol_dir_list($tmpdir, 'files', 0, '\.od(s|t)$', '', 'name', SORT_ASC, 0);
5898 if (count($tmpfiles)) {
5899 $listoffiles = array_merge($listoffiles, $tmpfiles);
5900 }
5901 }
5902 }
5903
5904 if (count($listoffiles)) {
5905 foreach ($listoffiles as $record) {
5906 $srctemplatepath = $record['fullname'];
5907 break;
5908 }
5909 }
5910 }
5911
5912 if (empty($srctemplatepath)) {
5913 $this->error = 'ErrorGenerationAskedForOdtTemplateWithSrcFileNotDefined';
5914 return -1;
5915 }
5916 }
5917
5918 if ($obj->type == 'odt' && !empty($srctemplatepath)) {
5919 if (!dol_is_file($srctemplatepath)) {
5920 dol_syslog("Failed to locate template file ".$srctemplatepath, LOG_WARNING);
5921 $this->error = 'ErrorGenerationAskedForOdtTemplateWithSrcFileNotFound';
5922 return -1;
5923 }
5924 }
5925
5926 // We save charset_output to restore it because write_file can change it if needed for
5927 // output format that does not support UTF8.
5928 $sav_charset_output = empty($outputlangs->charset_output) ? '' : $outputlangs->charset_output;
5929
5930 // update model_pdf in object
5931 $this->model_pdf = $saved_model;
5932
5933 if ($obj instanceof ModelePDFMember) {
5934 $resultwritefile = $obj->write_file($this, $outputlangs, $srctemplatepath, 'member', 1, 'tmp_cards');
5935 } else {
5936 // TODO: Try to set type above again
5937 '@phan-var-force ModeleBarCode|ModeleDon|ModeleExports|ModeleImports|ModelePDFAsset|ModelePDFContract|ModelePDFDeliveryOrder|ModelePDFEvaluation|ModelePDFFactures|ModelePDFFicheinter|ModelePDFMo|ModelePDFMovement|ModelePDFProduct|ModelePDFProjects|ModelePDFPropales|ModelePDFRecruitmentJobPosition|ModelePDFStock|ModelePDFStockTransfer|ModelePDFSupplierProposal|ModelePDFSuppliersInvoices|ModelePDFSuppliersOrders|ModelePDFSuppliersPayments|ModelePDFTask|ModelePDFTicket|ModelePDFUser|ModelePDFUserGroup|ModelePdfExpedition|ModelePdfReception|ModeleThirdPartyDoc $obj';
5938 $resultwritefile = $obj->write_file($this, $outputlangs, $srctemplatepath, $hidedetails, $hidedesc, $hideref, $moreparams);
5939 }
5940 // After call of write_file $obj->result['fullpath'] is set with generated file. It will be used to update the ECM database index.
5941
5942 if ($resultwritefile > 0) {
5943 $outputlangs->charset_output = $sav_charset_output;
5944
5945 // We delete old preview
5946 require_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
5947 dol_delete_preview($this);
5948
5949 // Index file in database
5950 if (!empty($obj->result['fullpath'])) {
5951 $destfull = $obj->result['fullpath'];
5952
5953 // Update the last_main_doc field into main object (if document generator has property ->update_main_doc_field set)
5954 $update_main_doc_field = 0;
5955 if (!empty($obj->update_main_doc_field)) {
5956 $update_main_doc_field = 1;
5957 }
5958
5959 // Check that the file exists, before indexing it.
5960 // Hint: It does not exist, if we create a PDF and auto delete the ODT File
5961 if (dol_is_file($destfull)) {
5962 $this->indexFile($destfull, $update_main_doc_field);
5963 }
5964 } else {
5965 dol_syslog('Method ->write_file was called on object '.get_class($obj).' and return a success but the return array ->result["fullpath"] was not set.', LOG_WARNING);
5966 }
5967
5968 // Success in building document. We build meta file.
5969 dol_meta_create($this);
5970
5971 return 1;
5972 } else {
5973 $outputlangs->charset_output = $sav_charset_output;
5974 $this->error = $obj->error;
5975 $this->errors = $obj->errors;
5976 dol_syslog("Error generating document for ".__CLASS__.". Error: ".$obj->error, LOG_ERR);
5977 return -1;
5978 }
5979 }
5980
5990 public function indexFile($destfull, $update_main_doc_field)
5991 {
5992 global $conf, $user;
5993
5994 $upload_dir = dirname($destfull);
5995 $destfile = basename($destfull);
5996 $rel_dir = preg_replace('/^'.preg_quote(DOL_DATA_ROOT, '/').'/', '', $upload_dir);
5997
5998 if (!preg_match('/[\\/]temp[\\/]|[\\/]thumbs|\.meta$/', $rel_dir)) { // If not a tmp dir
5999 $filename = basename($destfile);
6000 $rel_dir = preg_replace('/[\\/]$/', '', $rel_dir);
6001 $rel_dir = preg_replace('/^[\\/]/', '', $rel_dir);
6002
6003 include_once DOL_DOCUMENT_ROOT.'/ecm/class/ecmfiles.class.php';
6004 $ecmfile = new EcmFiles($this->db);
6005 $result = $ecmfile->fetch(0, '', ($rel_dir ? $rel_dir.'/' : '').$filename);
6006
6007 // Set the public "share" key
6008 $setsharekey = false;
6009 if ($this->element == 'propal' || $this->element == 'proposal') {
6010 if (getDolGlobalInt("PROPOSAL_ALLOW_ONLINESIGN")) {
6011 $setsharekey = true; // feature to make online signature is not set or set to on (default)
6012 }
6013 if (getDolGlobalInt("PROPOSAL_ALLOW_EXTERNAL_DOWNLOAD")) {
6014 $setsharekey = true;
6015 }
6016 }
6017 if ($this->element == 'commande' && getDolGlobalInt("ORDER_ALLOW_EXTERNAL_DOWNLOAD")) {
6018 $setsharekey = true;
6019 }
6020 if ($this->element == 'facture' && getDolGlobalInt("INVOICE_ALLOW_EXTERNAL_DOWNLOAD")) {
6021 $setsharekey = true;
6022 }
6023 if ($this->element == 'bank_account' && getDolGlobalInt("BANK_ACCOUNT_ALLOW_EXTERNAL_DOWNLOAD")) {
6024 $setsharekey = true;
6025 }
6026 if ($this->element == 'product' && getDolGlobalInt("PRODUCT_ALLOW_EXTERNAL_DOWNLOAD")) {
6027 $setsharekey = true;
6028 }
6029 if ($this->element == 'contrat' && getDolGlobalInt("CONTRACT_ALLOW_EXTERNAL_DOWNLOAD")) {
6030 $setsharekey = true;
6031 }
6032 if ($this->element == 'fichinter' && getDolGlobalInt("FICHINTER_ALLOW_EXTERNAL_DOWNLOAD")) {
6033 $setsharekey = true;
6034 }
6035 if ($this->element == 'supplier_proposal' && getDolGlobalInt("SUPPLIER_PROPOSAL_ALLOW_EXTERNAL_DOWNLOAD")) {
6036 $setsharekey = true;
6037 }
6038 if ($this->element == 'societe_rib' && getDolGlobalInt("SOCIETE_RIB_ALLOW_ONLINESIGN")) {
6039 $setsharekey = true;
6040 }
6041
6042 if ($setsharekey) {
6043 if (empty($ecmfile->share)) { // Because object not found or share not set yet
6044 require_once DOL_DOCUMENT_ROOT.'/core/lib/security2.lib.php';
6045 $ecmfile->share = getRandomPassword(true);
6046 }
6047 }
6048
6049 if ($result > 0) {
6050 $ecmfile->label = md5_file(dol_osencode($destfull)); // hash of file content
6051 $ecmfile->fullpath_orig = '';
6052 $ecmfile->gen_or_uploaded = 'generated';
6053 $ecmfile->description = ''; // indexed content
6054 $ecmfile->keywords = ''; // keyword content
6055 $ecmfile->src_object_type = $this->table_element;
6056 $ecmfile->src_object_id = $this->id;
6057 $result = $ecmfile->update($user);
6058 if ($result < 0) {
6059 setEventMessages($ecmfile->error, $ecmfile->errors, 'warnings');
6060 return -1;
6061 }
6062 } else {
6063 $ecmfile->entity = $conf->entity;
6064 $ecmfile->filepath = $rel_dir;
6065 $ecmfile->filename = $filename;
6066 $ecmfile->label = md5_file(dol_osencode($destfull)); // hash of file content
6067 $ecmfile->fullpath_orig = '';
6068 $ecmfile->gen_or_uploaded = 'generated';
6069 $ecmfile->description = ''; // indexed content
6070 $ecmfile->keywords = ''; // keyword content
6071 $ecmfile->src_object_type = $this->table_element; // $this->table_name is 'myobject' or 'mymodule_myobject'.
6072 $ecmfile->src_object_id = $this->id;
6073
6074 $result = $ecmfile->create($user);
6075 if ($result < 0) {
6076 setEventMessages($ecmfile->error, $ecmfile->errors, 'warnings');
6077 return -1;
6078 }
6079 }
6080
6081 /*$this->result['fullname']=$destfull;
6082 $this->result['filepath']=$ecmfile->filepath;
6083 $this->result['filename']=$ecmfile->filename;*/
6084 //var_dump($obj->update_main_doc_field);exit;
6085
6086 if ($update_main_doc_field && !empty($this->table_element)) {
6087 $sql = "UPDATE ".$this->db->prefix().$this->table_element." SET last_main_doc = '".$this->db->escape($ecmfile->filepath."/".$ecmfile->filename)."'";
6088 $sql .= " WHERE rowid = ".((int) $this->id);
6089
6090 $resql = $this->db->query($sql);
6091 if (!$resql) {
6092 dol_print_error($this->db);
6093 return -1;
6094 } else {
6095 $this->last_main_doc = $ecmfile->filepath.'/'.$ecmfile->filename;
6096 }
6097 }
6098 }
6099
6100 return 1;
6101 }
6102
6110 public function addThumbs($file)
6111 {
6112 $file_osencoded = dol_osencode($file);
6113
6114 if (file_exists($file_osencoded)) {
6115 require_once DOL_DOCUMENT_ROOT.'/core/lib/images.lib.php';
6116
6117 $tmparraysize = getDefaultImageSizes();
6118 $maxwidthsmall = $tmparraysize['maxwidthsmall'];
6119 $maxheightsmall = $tmparraysize['maxheightsmall'];
6120 $maxwidthmini = $tmparraysize['maxwidthmini'];
6121 $maxheightmini = $tmparraysize['maxheightmini'];
6122 //$quality = $tmparraysize['quality'];
6123 $quality = 50; // For thumbs, we force quality to 50
6124
6125 // Create small thumbs for company (Ratio is near 16/9)
6126 // Used on logon for example
6127 vignette($file_osencoded, $maxwidthsmall, $maxheightsmall, '_small', $quality);
6128
6129 // Create mini thumbs for company (Ratio is near 16/9)
6130 // Used on menu or for setup page for example
6131 vignette($file_osencoded, $maxwidthmini, $maxheightmini, '_mini', $quality);
6132 }
6133 }
6134
6142 public function delThumbs($file)
6143 {
6144 $imgThumbName = getImageFileNameForSize($file, '_small'); // Full path of thumb file
6145 dol_delete_file($imgThumbName);
6146 $imgThumbName = getImageFileNameForSize($file, '_mini'); // Full path of thumb file
6147 dol_delete_file($imgThumbName);
6148 }
6149
6150
6151 /* Functions common to commonobject and commonobjectline */
6152
6153 /* For default values */
6154
6168 public function getDefaultCreateValueFor($fieldname, $alternatevalue = null, $type = 'alphanohtml')
6169 {
6170 // If param here has been posted, we use this value first.
6171 if (GETPOSTISSET($fieldname)) {
6172 return GETPOST($fieldname, $type, 3);
6173 }
6174
6175 if (isset($alternatevalue)) {
6176 return $alternatevalue;
6177 }
6178
6179 $newelement = $this->element;
6180 if ($newelement == 'facture') {
6181 $newelement = 'invoice';
6182 }
6183 if ($newelement == 'commande') {
6184 $newelement = 'order';
6185 }
6186 if (empty($newelement)) {
6187 dol_syslog("Ask a default value using common method getDefaultCreateValueForField on an object with no property ->element defined. Return empty string.", LOG_WARNING);
6188 return '';
6189 }
6190
6191 $keyforfieldname = strtoupper($newelement.'_DEFAULT_'.$fieldname);
6192 //var_dump($keyforfieldname);
6193 if (getDolGlobalString($keyforfieldname)) {
6194 return getDolGlobalString($keyforfieldname);
6195 }
6196
6197 // TODO Ad here a scan into table llx_overwrite_default with a filter on $this->element and $fieldname
6198 // store content into $conf->cache['overwrite_default']
6199
6200 return '';
6201 }
6202
6203
6204 /* For triggers */
6205
6206
6207 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
6218 public function call_trigger($triggerName, $user)
6219 {
6220 // phpcs:enable
6221 global $langs, $conf;
6222
6223 if (!empty(self::TRIGGER_PREFIX) && strpos($triggerName, self::TRIGGER_PREFIX . '_') !== 0) {
6224 dol_print_error(null, 'The trigger "' . $triggerName . '" does not start with "' . self::TRIGGER_PREFIX . '_" as required.');
6225 exit;
6226 }
6227 if (!is_object($langs)) { // If lang was not defined, we set it. It is required by run_triggers().
6228 include_once DOL_DOCUMENT_ROOT.'/core/class/translate.class.php';
6229 $langs = new Translate('', $conf);
6230 }
6231
6232 include_once DOL_DOCUMENT_ROOT.'/core/class/interfaces.class.php';
6233 $interface = new Interfaces($this->db);
6234 $result = $interface->run_triggers($triggerName, $this, $user, $langs, $conf);
6235
6236 if ($result < 0) {
6237 if (!empty($this->errors)) {
6238 $this->errors = array_unique(array_merge($this->errors, $interface->errors)); // We use array_unique because when a trigger call another trigger on same object, this->errors is added twice.
6239 } else {
6240 $this->errors = $interface->errors;
6241 }
6242 }
6243 return $result;
6244 }
6245
6246
6247 /* Functions for data in other language */
6248
6249
6258 {
6259 // To avoid SQL errors. Probably not the better solution though
6260 if (!$this->element) {
6261 return 0;
6262 }
6263 if (!($this->id > 0)) {
6264 return 0;
6265 }
6266 if (is_array($this->array_languages)) {
6267 return 1;
6268 }
6269
6270 $this->array_languages = array();
6271
6272 $element = $this->element;
6273 if ($element == 'categorie') {
6274 $element = 'categories'; // For compatibility
6275 }
6276
6277 // Request to get translation values for object
6278 $sql = "SELECT rowid, property, lang , value";
6279 $sql .= " FROM ".$this->db->prefix()."object_lang";
6280 $sql .= " WHERE type_object = '".$this->db->escape($element)."'";
6281 $sql .= " AND fk_object = ".((int) $this->id);
6282
6283 //dol_syslog(get_class($this)."::fetch_optionals get extrafields data for ".$this->table_element, LOG_DEBUG); // Too verbose
6284 $resql = $this->db->query($sql);
6285 if ($resql) {
6286 $numrows = $this->db->num_rows($resql);
6287 if ($numrows) {
6288 $i = 0;
6289 while ($i < $numrows) {
6290 $obj = $this->db->fetch_object($resql);
6291 $key = $obj->property;
6292 $value = $obj->value;
6293 $codelang = $obj->lang;
6294 $type = $this->fields[$key]['type'];
6295
6296 // we can add this attribute to object
6297 if (preg_match('/date/', $type)) {
6298 $this->array_languages[$key][$codelang] = $this->db->jdate($value);
6299 } else {
6300 $this->array_languages[$key][$codelang] = $value;
6301 }
6302
6303 $i++;
6304 }
6305 }
6306
6307 $this->db->free($resql);
6308
6309 if ($numrows) {
6310 return $numrows;
6311 } else {
6312 return 0;
6313 }
6314 } else {
6315 dol_print_error($this->db);
6316 return -1;
6317 }
6318 }
6319
6326 public function setValuesForExtraLanguages($onlykey = '')
6327 {
6328 // Get extra fields
6329 foreach ($_POST as $postfieldkey => $postfieldvalue) {
6330 $tmparray = explode('-', $postfieldkey);
6331 if ($tmparray[0] != 'field') {
6332 continue;
6333 }
6334
6335 $element = $tmparray[1];
6336 $key = $tmparray[2];
6337 $codelang = $tmparray[3];
6338 //var_dump("postfieldkey=".$postfieldkey." element=".$element." key=".$key." codelang=".$codelang);
6339
6340 if (!empty($onlykey) && $key != $onlykey) {
6341 continue;
6342 }
6343 if ($element != $this->element) {
6344 continue;
6345 }
6346
6347 $key_type = $this->fields[$key]['type'];
6348
6349 $enabled = 1;
6350 if (isset($this->fields[$key]['enabled'])) {
6351 $enabled = (int) dol_eval($this->fields[$key]['enabled'], 1, 1, '1');
6352 }
6353 /*$perms = 1;
6354 if (isset($this->fields[$key]['perms']))
6355 {
6356 $perms = (int) dol_eval($this->fields[$key]['perms'], 1, 1, '1');
6357 }*/
6358 if (empty($enabled)) {
6359 continue;
6360 }
6361 //if (empty($perms)) continue;
6362
6363 if (in_array($key_type, array('date'))) {
6364 // Clean parameters
6365 // TODO GMT date in memory must be GMT so we should add gm=true in parameters
6366 $value_key = dol_mktime(0, 0, 0, GETPOSTINT($postfieldkey."month"), GETPOSTINT($postfieldkey."day"), GETPOSTINT($postfieldkey."year"));
6367 } elseif (in_array($key_type, array('datetime'))) {
6368 // Clean parameters
6369 // TODO GMT date in memory must be GMT so we should add gm=true in parameters
6370 $value_key = dol_mktime(GETPOSTINT($postfieldkey."hour"), GETPOSTINT($postfieldkey."min"), 0, GETPOSTINT($postfieldkey."month"), GETPOSTINT($postfieldkey."day"), GETPOSTINT($postfieldkey."year"));
6371 } elseif (in_array($key_type, array('checkbox', 'chkbxlst'))) {
6372 $value_arr = GETPOST($postfieldkey, 'array'); // check if an array
6373 if (!empty($value_arr)) {
6374 $value_key = implode(',', $value_arr);
6375 } else {
6376 $value_key = '';
6377 }
6378 } elseif (in_array($key_type, array('price', 'double'))) {
6379 $value_arr = GETPOST($postfieldkey, 'alpha');
6380 $value_key = price2num($value_arr);
6381 } else {
6382 $value_key = GETPOST($postfieldkey);
6383 if (in_array($key_type, array('link')) && $value_key == '-1') {
6384 $value_key = '';
6385 }
6386 }
6387
6388 $this->array_languages[$key][$codelang] = $value_key;
6389
6390 /*if ($nofillrequired) {
6391 $langs->load('errors');
6392 setEventMessages($langs->trans('ErrorFieldsRequired').' : '.implode(', ', $error_field_required), null, 'errors');
6393 return -1;
6394 }*/
6395 }
6396
6397 return 1;
6398 }
6399
6400
6401 /* Functions for extrafields */
6402
6409 public function fetchNoCompute($id)
6410 {
6411 global $conf;
6412
6413 $savDisableCompute = $conf->disable_compute;
6414 $conf->disable_compute = 1;
6415
6416 $ret = $this->fetch($id); /* @phpstan-ignore-line */
6417
6418 $conf->disable_compute = $savDisableCompute;
6419
6420 return $ret;
6421 }
6422
6423 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
6433 public function fetch_optionals($rowid = null, $optionsArray = null)
6434 {
6435 // phpcs:enable
6436 global $conf, $extrafields;
6437
6438 if (empty($rowid)) {
6439 $rowid = $this->id;
6440 }
6441 if (empty($rowid) && isset($this->rowid)) { // @phan-suppress-current-line PhanUndeclaredProperty
6442 $rowid = $this->rowid; // deprecated @phan-suppress-current-line PhanUndeclaredProperty
6443 }
6444
6445 // To avoid SQL errors. Probably not the better solution though
6446 if (!$this->table_element) {
6447 return 0;
6448 }
6449
6450 $this->array_options = array();
6451
6452 if (!is_array($optionsArray)) {
6453 // If $extrafields is not a known object, we initialize it. Best practice is to have $extrafields defined into card.php or list.php page.
6454 if (!isset($extrafields) || !is_object($extrafields)) {
6455 require_once DOL_DOCUMENT_ROOT.'/core/class/extrafields.class.php';
6456 $extrafields = new ExtraFields($this->db);
6457 }
6458
6459 // Load array of extrafields for elementype = $this->table_element
6460 if (empty($extrafields->attributes[$this->table_element]['loaded'])) {
6461 $extrafields->fetch_name_optionals_label($this->table_element);
6462 }
6463 $optionsArray = (!empty($extrafields->attributes[$this->table_element]['label']) ? $extrafields->attributes[$this->table_element]['label'] : null);
6464 } else {
6465 global $extrafields;
6466 dol_syslog("Warning: fetch_optionals was called with param optionsArray defined when you should pass null now", LOG_WARNING);
6467 }
6468
6469 $table_element = $this->table_element;
6470 if ($table_element == 'categorie') {
6471 $table_element = 'categories'; // For compatibility
6472 }
6473
6474 // Request to get complementary values
6475 if (is_array($optionsArray) && count($optionsArray) > 0) {
6476 $sql = "SELECT rowid";
6477 foreach ($optionsArray as $name => $label) {
6478 if (empty($extrafields->attributes[$this->table_element]['type'][$name]) || (!in_array($extrafields->attributes[$this->table_element]['type'][$name], ['separate', 'point', 'multipts', 'linestrg','polygon']))) {
6479 $sql .= ", ".$name;
6480 }
6481 // use geo sql fonction to read as text
6482 if (empty($extrafields->attributes[$this->table_element]['type'][$name]) || $extrafields->attributes[$this->table_element]['type'][$name] == 'point') {
6483 $sql .= ", ST_AsWKT(".$name.") as ".$name;
6484 }
6485 if (empty($extrafields->attributes[$this->table_element]['type'][$name]) || $extrafields->attributes[$this->table_element]['type'][$name] == 'multipts') {
6486 $sql .= ", ST_AsWKT(".$name.") as ".$name;
6487 }
6488 if (empty($extrafields->attributes[$this->table_element]['type'][$name]) || $extrafields->attributes[$this->table_element]['type'][$name] == 'linestrg') {
6489 $sql .= ", ST_AsWKT(".$name.") as ".$name;
6490 }
6491 if (empty($extrafields->attributes[$this->table_element]['type'][$name]) || $extrafields->attributes[$this->table_element]['type'][$name] == 'polygon') {
6492 $sql .= ", ST_AsWKT(".$name.") as ".$name;
6493 }
6494 }
6495 $sql .= " FROM ".$this->db->prefix().$table_element."_extrafields";
6496 $sql .= " WHERE fk_object = ".((int) $rowid);
6497
6498 //dol_syslog(get_class($this)."::fetch_optionals get extrafields data for ".$this->table_element, LOG_DEBUG); // Too verbose
6499 $resql = $this->db->query($sql);
6500 if ($resql) {
6501 $numrows = $this->db->num_rows($resql);
6502 if ($numrows) {
6503 $tab = $this->db->fetch_array($resql);
6504
6505 foreach ($tab as $key => $value) {
6506 // Test fetch_array ! is_int($key) because fetch_array result is a mix table with Key as alpha and Key as int (depend db engine)
6507 if ($key != 'rowid' && $key != 'tms' && $key != 'fk_member' && !is_int($key)) {
6508 // we can add this attribute to object
6509 if (!empty($extrafields->attributes[$this->table_element]) && in_array($extrafields->attributes[$this->table_element]['type'][$key], array('date', 'datetime'))) {
6510 //var_dump($extrafields->attributes[$this->table_element]['type'][$key]);
6511 $this->array_options["options_".$key] = $this->db->jdate($value);
6512 } else {
6513 $this->array_options["options_".$key] = $value;
6514 }
6515
6516 //var_dump('key '.$key.' '.$value.' type='.$extrafields->attributes[$this->table_element]['type'][$key].' '.$this->array_options["options_".$key]);
6517 }
6518 if (!empty($extrafields->attributes[$this->table_element]['type'][$key]) && $extrafields->attributes[$this->table_element]['type'][$key] == 'password') {
6519 if (!empty($value) && preg_match('/^dolcrypt:/', $value)) {
6520 $this->array_options["options_".$key] = dolDecrypt($value);
6521 }
6522 }
6523 }
6524 } else {
6529 if (is_array($extrafields->attributes[$this->table_element]['label'])) {
6530 foreach ($extrafields->attributes[$this->table_element]['label'] as $key => $val) {
6531 $this->array_options['options_' . $key] = null;
6532 }
6533 }
6534 }
6535
6536 // If field is a computed field, value must become result of compute (regardless of whether a row exists
6537 // in the element's extrafields table)
6538 if (is_array($extrafields->attributes[$this->table_element]['label'])) {
6539 foreach ($extrafields->attributes[$this->table_element]['label'] as $key => $val) {
6540 if (!empty($extrafields->attributes[$this->table_element]) && !empty($extrafields->attributes[$this->table_element]['computed'][$key])) {
6541 //var_dump($conf->disable_compute);
6542 if (empty($conf->disable_compute)) {
6543 global $objectoffield; // We set a global variable to $objectoffield so
6544 $objectoffield = $this; // we can use it inside computed formula
6545 $this->array_options['options_' . $key] = dol_eval($extrafields->attributes[$this->table_element]['computed'][$key], 1, 0, '2');
6546 }
6547 }
6548 }
6549 }
6550
6551 $this->db->free($resql);
6552
6553 if ($numrows) {
6554 return $numrows;
6555 } else {
6556 return 0;
6557 }
6558 } else {
6559 $this->errors[] = $this->db->lasterror;
6560 return -1;
6561 }
6562 }
6563 return 0;
6564 }
6565
6572 public function deleteExtraFields()
6573 {
6574 global $conf;
6575
6576 if (getDolGlobalString('MAIN_EXTRAFIELDS_DISABLED')) {
6577 return 0;
6578 }
6579
6580 $this->db->begin();
6581
6582 $table_element = $this->table_element;
6583 if ($table_element == 'categorie') {
6584 $table_element = 'categories'; // For compatibility
6585 }
6586
6587 dol_syslog(get_class($this)."::deleteExtraFields delete", LOG_DEBUG);
6588
6589 $sql_del = "DELETE FROM ".$this->db->prefix().$table_element."_extrafields WHERE fk_object = ".((int) $this->id);
6590
6591 $resql = $this->db->query($sql_del);
6592 if (!$resql) {
6593 $this->error = $this->db->lasterror();
6594 $this->db->rollback();
6595 return -1;
6596 } else {
6597 $this->db->commit();
6598 return 1;
6599 }
6600 }
6601
6612 public function insertExtraFields($trigger = '', $userused = null)
6613 {
6614 global $conf, $langs, $user;
6615
6616 if (getDolGlobalString('MAIN_EXTRAFIELDS_DISABLED')) {
6617 return 0;
6618 }
6619
6620 if (empty($userused)) {
6621 $userused = $user;
6622 }
6623
6624 $error = 0;
6625
6626 if (!empty($this->array_options)) {
6627 // Check parameters
6628 $langs->load('admin');
6629 require_once DOL_DOCUMENT_ROOT.'/core/class/extrafields.class.php';
6630 $extrafields = new ExtraFields($this->db);
6631 $target_extrafields = $extrafields->fetch_name_optionals_label($this->table_element);
6632
6633 // Eliminate copied source object extra fields that do not exist in target object
6634 $new_array_options = array();
6635 foreach ($this->array_options as $key => $value) {
6636 if (in_array(substr($key, 8), array_keys($target_extrafields))) { // We remove the 'options_' from $key for test
6637 $new_array_options[$key] = $value;
6638 } elseif (in_array($key, array_keys($target_extrafields))) { // We test on $key that does not contain the 'options_' prefix
6639 $new_array_options['options_'.$key] = $value;
6640 }
6641 }
6642
6643 foreach ($new_array_options as $key => $value) {
6644 $attributeKey = substr($key, 8); // Remove 'options_' prefix
6645 $attributeType = $extrafields->attributes[$this->table_element]['type'][$attributeKey];
6646 $attributeLabel = $langs->transnoentities($extrafields->attributes[$this->table_element]['label'][$attributeKey]);
6647 $attributeParam = $extrafields->attributes[$this->table_element]['param'][$attributeKey];
6648 $attributeRequired = $extrafields->attributes[$this->table_element]['required'][$attributeKey];
6649 $attributeUnique = $extrafields->attributes[$this->table_element]['unique'][$attributeKey];
6650 $attrfieldcomputed = $extrafields->attributes[$this->table_element]['computed'][$attributeKey];
6651
6652 // If we clone, we have to clean unique extrafields to prevent duplicates.
6653 // This behaviour can be prevented by external code by changing $this->context['createfromclone'] value in createFrom hook
6654 if (!empty($this->context['createfromclone']) && $this->context['createfromclone'] == 'createfromclone' && !empty($attributeUnique)) {
6655 $new_array_options[$key] = null;
6656 }
6657
6658 // Similar code than into insertExtraFields
6659 if ($attributeRequired) {
6660 $v = $this->array_options[$key];
6661 if (ExtraFields::isEmptyValue($v, $attributeType)) {
6662 $langs->load("errors");
6663 dol_syslog("Mandatory field '".$key."' is empty during create and set to required into definition of extrafields");
6664 $this->errors[] = $langs->trans('ErrorFieldRequired', $attributeLabel);
6665 return -1;
6666 }
6667 }
6668
6669 //dol_syslog("attributeLabel=".$attributeLabel, LOG_DEBUG);
6670 //dol_syslog("attributeType=".$attributeType, LOG_DEBUG);
6671
6672 if (!empty($attrfieldcomputed)) {
6673 if (getDolGlobalString('MAIN_STORE_COMPUTED_EXTRAFIELDS')) {
6674 $value = dol_eval($attrfieldcomputed, 1, 0, '2');
6675 dol_syslog($langs->trans("Extrafieldcomputed")." on ".$attributeLabel."(".$value.")", LOG_DEBUG);
6676 $new_array_options[$key] = $value;
6677 } else {
6678 $new_array_options[$key] = null;
6679 }
6680 }
6681
6682 switch ($attributeType) {
6683 case 'int':
6684 if (!is_numeric($value) && $value != '') {
6685 $this->errors[] = $langs->trans("ExtraFieldHasWrongValue", $attributeLabel);
6686 return -1;
6687 } elseif ($value == '') {
6688 $new_array_options[$key] = null;
6689 }
6690 break;
6691 case 'price':
6692 case 'double':
6693 $value = price2num($value);
6694 if (!is_numeric($value) && $value != '') {
6695 dol_syslog($langs->trans("ExtraFieldHasWrongValue")." for ".$attributeLabel."(".$value."is not '".$attributeType."')", LOG_DEBUG);
6696 $this->errors[] = $langs->trans("ExtraFieldHasWrongValue", $attributeLabel);
6697 return -1;
6698 } elseif ($value == '') {
6699 $value = null;
6700 }
6701 //dol_syslog("double value"." on ".$attributeLabel."(".$value." is '".$attributeType."')", LOG_DEBUG);
6702 $new_array_options[$key] = $value;
6703 break;
6704 /*case 'select': // Not required, we chose value='0' for undefined values
6705 if ($value=='-1')
6706 {
6707 $this->array_options[$key] = null;
6708 }
6709 break;*/
6710 case 'password':
6711 $algo = '';
6712 if ($this->array_options[$key] != '' && is_array($extrafields->attributes[$this->table_element]['param'][$attributeKey]['options'])) {
6713 // If there is an encryption choice, we use it to encrypt data before insert
6714 $tmparrays = array_keys($extrafields->attributes[$this->table_element]['param'][$attributeKey]['options']);
6715 $algo = reset($tmparrays);
6716 if ($algo != '') {
6717 //global $action; // $action may be 'create', 'update', 'update_extras'...
6718 //var_dump($action);
6719 //var_dump($this->oldcopy);exit;
6720 if (is_object($this->oldcopy)) { // If this->oldcopy is not defined, we can't know if we change attribute or not, so we must keep value
6721 //var_dump('algo='.$algo.' '.$this->oldcopy->array_options[$key].' -> '.$this->array_options[$key]);
6722 if (isset($this->oldcopy->array_options[$key]) && $this->array_options[$key] == $this->oldcopy->array_options[$key]) {
6723 // If old value encrypted in database is same than submitted new value, it means we don't change it, so we don't update.
6724 if ($algo == 'dolcrypt') { // dolibarr reversible encryption
6725 if (!preg_match('/^dolcrypt:/', $this->array_options[$key])) {
6726 $new_array_options[$key] = dolEncrypt($this->array_options[$key]); // warning, must be called when on the master
6727 } else {
6728 $new_array_options[$key] = $this->array_options[$key]; // Value is kept
6729 }
6730 } else {
6731 $new_array_options[$key] = $this->array_options[$key]; // Value is kept
6732 }
6733 } else {
6734 // If value has changed
6735 if ($algo == 'dolcrypt') { // dolibarr reversible encryption
6736 if (!preg_match('/^dolcrypt:/', $this->array_options[$key])) {
6737 $new_array_options[$key] = dolEncrypt($this->array_options[$key]); // warning, must be called when on the master
6738 } else {
6739 $new_array_options[$key] = $this->array_options[$key]; // Value is kept
6740 }
6741 } else {
6742 $new_array_options[$key] = dol_hash($this->array_options[$key], $algo);
6743 }
6744 }
6745 } else {
6746 //var_dump('jjj'.$algo.' '.$this->oldcopy->array_options[$key].' -> '.$this->array_options[$key]);
6747 // If this->oldcopy is not defined, we can't know if we change attribute or not, so we must keep value
6748 if ($algo == 'dolcrypt' && !preg_match('/^dolcrypt:/', $this->array_options[$key])) { // dolibarr reversible encryption
6749 $new_array_options[$key] = dolEncrypt($this->array_options[$key]); // warning, must be called when on the master
6750 } else {
6751 $new_array_options[$key] = $this->array_options[$key]; // Value is kept
6752 }
6753 }
6754 } else {
6755 // No encryption
6756 $new_array_options[$key] = $this->array_options[$key]; // Value is kept
6757 }
6758 } else { // Common usage
6759 $new_array_options[$key] = $this->array_options[$key]; // Value is kept
6760 }
6761 break;
6762 case 'date':
6763 case 'datetime':
6764 // If data is a string instead of a timestamp, we convert it
6765 if (!is_numeric($this->array_options[$key]) || $this->array_options[$key] != intval($this->array_options[$key])) {
6766 $this->array_options[$key] = strtotime($this->array_options[$key]);
6767 }
6768 $new_array_options[$key] = $this->db->idate($this->array_options[$key]);
6769 break;
6770 case 'datetimegmt':
6771 // If data is a string instead of a timestamp, we convert it
6772 if (!is_numeric($this->array_options[$key]) || $this->array_options[$key] != intval($this->array_options[$key])) {
6773 $this->array_options[$key] = strtotime($this->array_options[$key]);
6774 }
6775 $new_array_options[$key] = $this->db->idate($this->array_options[$key], 'gmt');
6776 break;
6777 case 'link':
6778 $param_list = array_keys($attributeParam['options']);
6779 // 0 : ObjectName
6780 // 1 : classPath
6781 $InfoFieldList = explode(":", $param_list[0]);
6782 dol_include_once($InfoFieldList[1]);
6783 if ($InfoFieldList[0] && class_exists($InfoFieldList[0])) {
6784 if ($value == '-1') { // -1 is key for no defined in combo list of objects
6785 $new_array_options[$key] = '';
6786 } elseif ($value) {
6787 $object = new $InfoFieldList[0]($this->db);
6788 '@phan-var-force CommonObject $object';
6789 if (is_numeric($value)) {
6790 $res = $object->fetch($value); // Common case
6791 } else {
6792 $res = $object->fetch(0, $value); // For compatibility
6793 }
6794
6795 if ($res > 0) {
6796 $new_array_options[$key] = $object->id;
6797 } else {
6798 $this->error = "Id/Ref '".$value."' for object '".$object->element."' not found";
6799 return -1;
6800 }
6801 }
6802 } else {
6803 dol_syslog('Error bad setup of extrafield', LOG_WARNING);
6804 }
6805 break;
6806 case 'checkbox':
6807 case 'chkbxlst':
6808 if (is_array($this->array_options[$key])) {
6809 $new_array_options[$key] = implode(',', $this->array_options[$key]);
6810 } else {
6811 $new_array_options[$key] = $this->array_options[$key];
6812 }
6813 break;
6814 }
6815 }
6816
6817 $this->db->begin();
6818
6819 $table_element = $this->table_element;
6820 if ($table_element == 'categorie') {
6821 $table_element = 'categories'; // For compatibility
6822 }
6823
6824 dol_syslog(get_class($this)."::insertExtraFields delete then insert", LOG_DEBUG);
6825
6826 $sql_del = "DELETE FROM ".$this->db->prefix().$table_element."_extrafields WHERE fk_object = ".((int) $this->id);
6827 $this->db->query($sql_del);
6828
6829 $sql = "INSERT INTO ".$this->db->prefix().$table_element."_extrafields (fk_object";
6830 foreach ($new_array_options as $key => $value) {
6831 $attributeKey = substr($key, 8); // Remove 'options_' prefix
6832 // Add field of attribute
6833 if ($extrafields->attributes[$this->table_element]['type'][$attributeKey] != 'separate') { // Only for other type than separator
6834 $sql .= ",".$attributeKey;
6835 }
6836 }
6837 // We must insert a default value for fields for other entities that are mandatory to avoid not null error
6838 if (!empty($extrafields->attributes[$this->table_element]['mandatoryfieldsofotherentities']) && is_array($extrafields->attributes[$this->table_element]['mandatoryfieldsofotherentities'])) {
6839 foreach ($extrafields->attributes[$this->table_element]['mandatoryfieldsofotherentities'] as $tmpkey => $tmpval) {
6840 if (!isset($extrafields->attributes[$this->table_element]['type'][$tmpkey])) { // If field not already added previously
6841 $sql .= ",".$tmpkey;
6842 }
6843 }
6844 }
6845 $sql .= ") VALUES (".$this->id;
6846
6847 foreach ($new_array_options as $key => $value) {
6848 $attributeKey = substr($key, 8); // Remove 'options_' prefix
6849 // Add field of attribute
6850 if (!in_array($extrafields->attributes[$this->table_element]['type'][$attributeKey], ['separate', 'point', 'multipts', 'linestrg', 'polygon'])) { // Only for other type than separator)
6851 if ($new_array_options[$key] != '' || $new_array_options[$key] == '0') {
6852 $sql .= ",'".$this->db->escape($new_array_options[$key])."'";
6853 } else {
6854 $sql .= ",null";
6855 }
6856 }
6857 if ($extrafields->attributes[$this->table_element]['type'][$attributeKey] == 'point') { // for point type
6858 if (!empty($new_array_options[$key])) {
6859 if (!preg_match('/error/i', $new_array_options[$key])) {
6860 // Text must be a WKT string, so "POINT(15 20)"
6861 $sql .= ",ST_PointFromText('".$this->db->escape($new_array_options[$key])."')";
6862 } else {
6863 dol_syslog("Bad syntax string for point ".$new_array_options[$key]." to generate SQL request", LOG_WARNING);
6864 $sql .= ",null";
6865 }
6866 } else {
6867 $sql .= ",null";
6868 }
6869 }
6870 if ($extrafields->attributes[$this->table_element]['type'][$attributeKey] == 'multipts') { // for point type
6871 if (!empty($new_array_options[$key])) {
6872 if (!preg_match('/error/i', $new_array_options[$key])) {
6873 // Text must be a WKT string, so "MULTIPOINT(0 0, 20 20, 60 60)"
6874 $sql .= ",ST_MultiPointFromText('".$this->db->escape($new_array_options[$key])."')";
6875 } else {
6876 dol_syslog("Bad syntax string for multipoint ".$new_array_options[$key]." to generate SQL request", LOG_WARNING);
6877 $sql .= ",null";
6878 }
6879 } else {
6880 $sql .= ",null";
6881 }
6882 }
6883 if ($extrafields->attributes[$this->table_element]['type'][$attributeKey] == 'linestrg') { // for linestring type
6884 if (!empty($new_array_options[$key])) {
6885 if (!preg_match('/error/i', $new_array_options[$key])) {
6886 // Text must be a WKT string, so "LINESTRING(0 0, 10 10, 20 25, 50 60)"
6887 $sql .= ",ST_LineFromText('".$this->db->escape($new_array_options[$key])."')";
6888 } else {
6889 dol_syslog("Bad syntax string for line ".$new_array_options[$key]." to generate SQL request", LOG_WARNING);
6890 $sql .= ",null";
6891 }
6892 } else {
6893 $sql .= ",null";
6894 }
6895 }
6896 if ($extrafields->attributes[$this->table_element]['type'][$attributeKey] == 'polygon') { // for polygon type
6897 if (!empty($new_array_options[$key])) {
6898 if (!preg_match('/error/i', $new_array_options[$key])) {
6899 // Text must be a WKT string, so "POLYGON((0 0,10 0,10 10,0 10,0 0),(5 5,7 5,7 7,5 7, 5 5))"
6900 $sql .= ",ST_PolyFromText('".$this->db->escape($new_array_options[$key])."')";
6901 } else {
6902 dol_syslog("Bad syntax string for polygon ".$new_array_options[$key]." to generate SQL request", LOG_WARNING);
6903 $sql .= ",null";
6904 }
6905 } else {
6906 $sql .= ",null";
6907 }
6908 }
6909 }
6910 // We must insert a default value for fields for other entities that are mandatory to avoid not null error
6911 if (!empty($extrafields->attributes[$this->table_element]['mandatoryfieldsofotherentities']) && is_array($extrafields->attributes[$this->table_element]['mandatoryfieldsofotherentities'])) {
6912 foreach ($extrafields->attributes[$this->table_element]['mandatoryfieldsofotherentities'] as $tmpkey => $tmpval) {
6913 if (!isset($extrafields->attributes[$this->table_element]['type'][$tmpkey])) { // If field not already added previously
6914 if (in_array($tmpval, array('int', 'double', 'price'))) {
6915 $sql .= ", 0";
6916 } else {
6917 $sql .= ", ''";
6918 }
6919 }
6920 }
6921 }
6922
6923 $sql .= ")";
6924
6925 $resql = $this->db->query($sql);
6926 if (!$resql) {
6927 $this->error = $this->db->lasterror();
6928 $error++;
6929 }
6930
6931 if (!$error && $trigger) {
6932 // Call trigger
6933 $this->context = array('extrafieldaddupdate' => 1);
6934 $result = $this->call_trigger($trigger, $userused);
6935 if ($result < 0) {
6936 $error++;
6937 }
6938 // End call trigger
6939 }
6940
6941 if ($error) {
6942 $this->db->rollback();
6943 return -1;
6944 } else {
6945 $this->db->commit();
6946 return 1;
6947 }
6948 } else {
6949 return 0;
6950 }
6951 }
6952
6963 public function insertExtraLanguages($trigger = '', $userused = null)
6964 {
6965 global $conf, $langs, $user;
6966
6967 if (empty($userused)) {
6968 $userused = $user;
6969 }
6970
6971 $error = 0;
6972
6973 if (getDolGlobalString('MAIN_EXTRALANGUAGES_DISABLED')) {
6974 return 0; // For avoid conflicts if trigger used
6975 }
6976
6977 if (is_array($this->array_languages)) {
6978 $new_array_languages = $this->array_languages;
6979
6980 foreach ($new_array_languages as $key => $value) {
6981 $attributeKey = $key;
6982 $attributeType = $this->fields[$attributeKey]['type'];
6983 $attributeLabel = $this->fields[$attributeKey]['label'];
6984
6985 //dol_syslog("attributeLabel=".$attributeLabel, LOG_DEBUG);
6986 //dol_syslog("attributeType=".$attributeType, LOG_DEBUG);
6987
6988 switch ($attributeType) {
6989 case 'int':
6990 if (is_array($value) || (!is_numeric($value) && $value != '')) {
6991 $this->errors[] = $langs->trans("ExtraLanguageHasWrongValue", $attributeLabel);
6992 return -1;
6993 } elseif ($value == '') { // @phan-suppress-current-line PhanTypeComparisonFromArray
6994 $new_array_languages[$key] = null;
6995 }
6996 break;
6997 case 'double':
6998 $value = price2num((string) $value);
6999 if (!is_numeric($value) && $value != '') {
7000 dol_syslog($langs->trans("ExtraLanguageHasWrongValue")." on ".$attributeLabel."(".$value."is not '".$attributeType."')", LOG_DEBUG);
7001 $this->errors[] = $langs->trans("ExtraLanguageHasWrongValue", $attributeLabel);
7002 return -1;
7003 } elseif ($value == '') {
7004 $new_array_languages[$key] = null;
7005 } else {
7006 $new_array_languages[$key] = $value;
7007 }
7008 break;
7009 /*case 'select': // Not required, we chose value='0' for undefined values
7010 if ($value=='-1')
7011 {
7012 $this->array_options[$key] = null;
7013 }
7014 break;*/
7015 }
7016 }
7017
7018 $this->db->begin();
7019
7020 $table_element = $this->table_element;
7021 if ($table_element == 'categorie') { // TODO Rename table llx_categories_extrafields into llx_categorie_extrafields so we can remove this.
7022 $table_element = 'categories'; // For compatibility
7023 }
7024
7025 dol_syslog(get_class($this)."::insertExtraLanguages delete then insert", LOG_DEBUG);
7026
7027 foreach ($new_array_languages as $key => $langcodearray) { // $key = 'name', 'town', ...
7028 foreach ($langcodearray as $langcode => $value) {
7029 $sql_del = "DELETE FROM ".$this->db->prefix()."object_lang";
7030 $sql_del .= " WHERE fk_object = ".((int) $this->id)." AND property = '".$this->db->escape($key)."' AND type_object = '".$this->db->escape($table_element)."'";
7031 $sql_del .= " AND lang = '".$this->db->escape($langcode)."'";
7032 $this->db->query($sql_del);
7033
7034 if ($value !== '') {
7035 $sql = "INSERT INTO ".$this->db->prefix()."object_lang (fk_object, property, type_object, lang, value";
7036 $sql .= ") VALUES (".$this->id.", '".$this->db->escape($key)."', '".$this->db->escape($table_element)."', '".$this->db->escape($langcode)."', '".$this->db->escape($value)."'";
7037 $sql .= ")";
7038
7039 $resql = $this->db->query($sql);
7040 if (!$resql) {
7041 $this->error = $this->db->lasterror();
7042 $error++;
7043 break;
7044 }
7045 }
7046 }
7047 }
7048
7049 if (!$error && $trigger) {
7050 // Call trigger
7051 $this->context = array('extralanguagesaddupdate' => 1);
7052 $result = $this->call_trigger($trigger, $userused);
7053 if ($result < 0) {
7054 $error++;
7055 }
7056 // End call trigger
7057 }
7058
7059 if ($error) {
7060 $this->db->rollback();
7061 return -1;
7062 } else {
7063 $this->db->commit();
7064 return 1;
7065 }
7066 } else {
7067 return 0;
7068 }
7069 }
7070
7081 public function updateExtraField($key, $trigger = null, $userused = null)
7082 {
7083 global $conf, $langs, $user, $hookmanager;
7084
7085 if (getDolGlobalString('MAIN_EXTRAFIELDS_DISABLED')) {
7086 return 0;
7087 }
7088
7089 if (empty($userused)) {
7090 $userused = $user;
7091 }
7092
7093 $error = 0;
7094
7095 if (!empty($this->array_options) && isset($this->array_options["options_".$key])) {
7096 // Check parameters
7097 $langs->load('admin');
7098 require_once DOL_DOCUMENT_ROOT.'/core/class/extrafields.class.php';
7099 $extrafields = new ExtraFields($this->db);
7100 $extrafields->fetch_name_optionals_label($this->table_element);
7101
7102 $value = $this->array_options["options_".$key];
7103
7104 $attributeKey = $key;
7105 $attributeType = $extrafields->attributes[$this->table_element]['type'][$key];
7106 $attributeLabel = $extrafields->attributes[$this->table_element]['label'][$key];
7107 $attributeParam = $extrafields->attributes[$this->table_element]['param'][$key];
7108 $attributeRequired = $extrafields->attributes[$this->table_element]['required'][$key];
7109 $attributeUnique = $extrafields->attributes[$this->table_element]['unique'][$attributeKey];
7110 $attrfieldcomputed = $extrafields->attributes[$this->table_element]['computed'][$key];
7111
7112 // Similar code than into insertExtraFields
7113 if ($attributeRequired) {
7114 $mandatorypb = false;
7115 if ($attributeType == 'link' && $this->array_options["options_".$key] == '-1') {
7116 $mandatorypb = true;
7117 }
7118 if ($this->array_options["options_".$key] === '') {
7119 $mandatorypb = true;
7120 }
7121 if ($mandatorypb) {
7122 $langs->load("errors");
7123 dol_syslog("Mandatory field 'options_".$key."' is empty during update and set to required into definition of extrafields");
7124 $this->errors[] = $langs->trans('ErrorFieldRequired', $attributeLabel);
7125 return -1;
7126 }
7127 }
7128
7129 // $new_array_options will be used for direct update, so must contains formatted data for the UPDATE.
7130 $new_array_options = $this->array_options;
7131
7132 //dol_syslog("attributeLabel=".$attributeLabel, LOG_DEBUG);
7133 //dol_syslog("attributeType=".$attributeType, LOG_DEBUG);
7134 if (!empty($attrfieldcomputed)) {
7135 if (getDolGlobalString('MAIN_STORE_COMPUTED_EXTRAFIELDS')) {
7136 $value = dol_eval($attrfieldcomputed, 1, 0, '2');
7137 dol_syslog($langs->trans("Extrafieldcomputed")." on ".$attributeLabel."(".$value.")", LOG_DEBUG);
7138
7139 $new_array_options["options_".$key] = $value;
7140
7141 $this->array_options["options_".$key] = $new_array_options["options_".$key];
7142 } else {
7143 $new_array_options["options_".$key] = null;
7144
7145 $this->array_options["options_".$key] = $new_array_options["options_".$key];
7146 }
7147 }
7148
7149 switch ($attributeType) {
7150 case 'int':
7151 if (!is_numeric($value) && $value != '') {
7152 $this->errors[] = $langs->trans("ExtraFieldHasWrongValue", $attributeLabel);
7153 return -1;
7154 } elseif ($value === '') {
7155 $new_array_options["options_".$key] = null;
7156
7157 $this->array_options["options_".$key] = $new_array_options["options_".$key];
7158 }
7159 break;
7160 case 'price':
7161 case 'double':
7162 $value = price2num($value);
7163 if (!is_numeric($value) && $value != '') {
7164 dol_syslog($langs->trans("ExtraFieldHasWrongValue")." on ".$attributeLabel."(".$value."is not '".$attributeType."')", LOG_DEBUG);
7165 $this->errors[] = $langs->trans("ExtraFieldHasWrongValue", $attributeLabel);
7166 return -1;
7167 } elseif ($value === '') {
7168 $value = null;
7169 }
7170 //dol_syslog("double value"." on ".$attributeLabel."(".$value." is '".$attributeType."')", LOG_DEBUG);
7171 $new_array_options["options_".$key] = $value;
7172
7173 $this->array_options["options_".$key] = $new_array_options["options_".$key];
7174 break;
7175 /*case 'select': // Not required, we chose value='0' for undefined values
7176 if ($value=='-1')
7177 {
7178 $new_array_options["options_".$key] = $value;
7179
7180 $this->array_options["options_".$key] = $new_array_options["options_".$key];
7181 }
7182 break;*/
7183 case 'password':
7184 $algo = '';
7185 if ($this->array_options["options_".$key] != '' && is_array($extrafields->attributes[$this->table_element]['param'][$attributeKey]['options'])) {
7186 // If there is an encryption choice, we use it to encrypt data before insert
7187 $tmparrays = array_keys($extrafields->attributes[$this->table_element]['param'][$attributeKey]['options']);
7188 $algo = reset($tmparrays);
7189 if ($algo != '') {
7190 //global $action; // $action may be 'create', 'update', 'update_extras'...
7191 //var_dump($action);
7192 //var_dump($this->oldcopy);exit;
7193 //var_dump($key.' '.$this->array_options["options_".$key].' '.$algo);
7194 if (is_object($this->oldcopy)) { // If this->oldcopy is not defined, we can't know if we change attribute or not, so we must keep value
7195 //var_dump($this->oldcopy->array_options["options_".$key]); var_dump($this->array_options["options_".$key]);
7196 if (isset($this->oldcopy->array_options["options_".$key]) && $this->array_options["options_".$key] == $this->oldcopy->array_options["options_".$key]) { // If old value encrypted in database is same than submitted new value, it means we don't change it, so we don't update.
7197 if ($algo == 'dolcrypt') { // dolibarr reversible encryption
7198 if (!preg_match('/^dolcrypt:/', $this->array_options["options_".$key])) {
7199 $new_array_options["options_".$key] = dolEncrypt($this->array_options["options_".$key]); // warning, must be called when on the master
7200 } else {
7201 $new_array_options["options_".$key] = $this->array_options["options_".$key]; // Value is kept
7202 }
7203 } else {
7204 $new_array_options["options_".$key] = $this->array_options["options_".$key]; // Value is kept
7205 }
7206 } else {
7207 if ($algo == 'dolcrypt') { // dolibarr reversible encryption
7208 if (!preg_match('/^dolcrypt:/', $this->array_options["options_".$key])) {
7209 $new_array_options["options_".$key] = dolEncrypt($this->array_options["options_".$key]);
7210 } else {
7211 $new_array_options["options_".$key] = $this->array_options["options_".$key]; // Value is kept
7212 }
7213 } else {
7214 $new_array_options["options_".$key] = dol_hash($this->array_options["options_".$key], $algo);
7215 }
7216 }
7217 } else {
7218 if ($algo == 'dolcrypt' && !preg_match('/^dolcrypt:/', $this->array_options["options_".$key])) { // dolibarr reversible encryption
7219 $new_array_options["options_".$key] = dolEncrypt($this->array_options["options_".$key]); // warning, must be called when on the master
7220 } else {
7221 $new_array_options["options_".$key] = $this->array_options["options_".$key]; // Value is kept
7222 }
7223 }
7224 } else {
7225 // No encryption
7226 $new_array_options["options_".$key] = $this->array_options["options_".$key]; // Value is kept
7227 }
7228 } else { // Common usage
7229 $new_array_options["options_".$key] = $this->array_options["options_".$key]; // Value is kept
7230 }
7231
7232 $this->array_options["options_".$key] = $new_array_options["options_".$key];
7233 break;
7234 case 'date':
7235 case 'datetime':
7236 if (empty($this->array_options["options_".$key])) {
7237 $new_array_options["options_".$key] = null;
7238
7239 $this->array_options["options_".$key] = $new_array_options["options_".$key];
7240 } else {
7241 $new_array_options["options_".$key] = $this->db->idate($this->array_options["options_".$key]);
7242 }
7243 break;
7244 case 'datetimegmt':
7245 if (empty($this->array_options["options_".$key])) {
7246 $new_array_options["options_".$key] = null;
7247
7248 $this->array_options["options_".$key] = $new_array_options["options_".$key];
7249 } else {
7250 $new_array_options["options_".$key] = $this->db->idate($this->array_options["options_".$key], 'gmt');
7251 }
7252 break;
7253 case 'boolean':
7254 if (empty($this->array_options["options_".$key])) {
7255 $new_array_options["options_".$key] = null;
7256
7257 $this->array_options["options_".$key] = $new_array_options["options_".$key];
7258 }
7259 break;
7260 case 'link':
7261 if ($this->array_options["options_".$key] === '') {
7262 $new_array_options["options_".$key] = null;
7263
7264 $this->array_options["options_".$key] = $new_array_options["options_".$key];
7265 }
7266 break;
7267 /*
7268 case 'link':
7269 $param_list = array_keys($attributeParam['options']);
7270 // 0 : ObjectName
7271 // 1 : classPath
7272 $InfoFieldList = explode(":", $param_list[0]);
7273 dol_include_once($InfoFieldList[1]);
7274 if ($InfoFieldList[0] && class_exists($InfoFieldList[0]))
7275 {
7276 if ($value == '-1') // -1 is key for no defined in combo list of objects
7277 {
7278 $new_array_options[$key] = '';
7279 } elseif ($value) {
7280 $object = new $InfoFieldList[0]($this->db);
7281 if (is_numeric($value)) $res = $object->fetch($value); // Common case
7282 else $res = $object->fetch(0, $value); // For compatibility
7283
7284 if ($res > 0) $new_array_options[$key] = $object->id;
7285 else {
7286 $this->error = "Id/Ref '".$value."' for object '".$object->element."' not found";
7287 $this->db->rollback();
7288 return -1;
7289 }
7290 }
7291 } else {
7292 dol_syslog('Error bad setup of extrafield', LOG_WARNING);
7293 }
7294 break;
7295 */
7296 case 'checkbox':
7297 case 'chkbxlst':
7298 $new_array_options = array();
7299 if (is_array($this->array_options["options_".$key])) {
7300 $new_array_options["options_".$key] = implode(',', $this->array_options["options_".$key]);
7301 } else {
7302 $new_array_options["options_".$key] = $this->array_options["options_".$key];
7303 }
7304
7305 $this->array_options["options_".$key] = $new_array_options["options_".$key];
7306 break;
7307 }
7308
7309 $this->db->begin();
7310
7311 $linealreadyfound = 0;
7312
7313 // Check if there is already a line for this object (in most cases, it is, but sometimes it is not, for example when extra field has been created after), so we must keep this overload)
7314 $table_element = $this->table_element;
7315 if ($table_element == 'categorie') { // TODO Rename table llx_categories_extrafields into llx_categorie_extrafields so we can remove this.
7316 $table_element = 'categories'; // For compatibility
7317 }
7318
7319 $sql = "SELECT COUNT(rowid) as nb FROM ".$this->db->prefix().$table_element."_extrafields WHERE fk_object = ".((int) $this->id);
7320 $resql = $this->db->query($sql);
7321 if ($resql) {
7322 $tmpobj = $this->db->fetch_object($resql);
7323 if ($tmpobj) {
7324 $linealreadyfound = $tmpobj->nb;
7325 }
7326 }
7327
7328 //var_dump('linealreadyfound='.$linealreadyfound.' sql='.$sql); exit;
7329 if ($linealreadyfound) {
7330 if ($this->array_options["options_".$key] === null) {
7331 $sql = "UPDATE ".$this->db->prefix().$table_element."_extrafields SET ".$key." = null";
7332 } else {
7333 $sql = "UPDATE ".$this->db->prefix().$table_element."_extrafields SET ".$key." = '".$this->db->escape($new_array_options["options_".$key])."'";
7334 }
7335 $sql .= " WHERE fk_object = ".((int) $this->id);
7336
7337 $resql = $this->db->query($sql);
7338 if (!$resql) {
7339 $error++;
7340 $this->error = $this->db->lasterror();
7341 }
7342 } else {
7343 $result = $this->insertExtraFields('', $user);
7344 if ($result < 0) {
7345 $error++;
7346 }
7347 }
7348
7349 if (!$error) {
7350 $parameters = array('key' => $key);
7351 global $action;
7352 $reshook = $hookmanager->executeHooks('updateExtraFieldBeforeCommit', $parameters, $this, $action);
7353 if ($reshook < 0) {
7354 setEventMessages($hookmanager->error, $hookmanager->errors, 'errors');
7355 }
7356 }
7357
7358 if (!$error && $trigger) {
7359 // Call trigger
7360 $this->context = array('extrafieldupdate' => 1);
7361 $result = $this->call_trigger($trigger, $userused);
7362 if ($result < 0) {
7363 $error++;
7364 }
7365 // End call trigger
7366 }
7367
7368 if ($error) {
7369 dol_syslog(__METHOD__.$this->error, LOG_ERR);
7370 $this->db->rollback();
7371 return -1;
7372 } else {
7373 $this->db->commit();
7374 return 1;
7375 }
7376 } else {
7377 return 0;
7378 }
7379 }
7380
7387 public function getExtraField($key)
7388 {
7389 return $this->array_options['options_'.$key] ?? null;
7390 }
7391
7399 public function setExtraField($key, $value)
7400 {
7401 $this->array_options['options_'.$key] = $value;
7402 }
7403
7414 public function updateExtraLanguages($key, $trigger = null, $userused = null)
7415 {
7416 global $conf, $langs, $user;
7417
7418 if (empty($userused)) {
7419 $userused = $user;
7420 }
7421
7422 $error = 0;
7423
7424 if (getDolGlobalString('MAIN_EXTRALANGUAGES_DISABLED')) {
7425 return 0; // For avoid conflicts if trigger used
7426 }
7427
7428 return 0;
7429 }
7430
7431
7447 public function showInputField($val, $key, $value, $moreparam = '', $keysuffix = '', $keyprefix = '', $morecss = 0, $nonewbutton = 0)
7448 {
7449 global $conf, $langs, $form;
7450
7451 // TODO pass the current object as a parameter to give more flexibility (like disable showing input for extra fields when canAlwaysBeEdited is false and $object->status is not draft...)
7452
7453 if (!is_object($form)) {
7454 require_once DOL_DOCUMENT_ROOT.'/core/class/html.form.class.php';
7455 $form = new Form($this->db);
7456 }
7457
7458 if (!empty($this->fields)) {
7459 $val = $this->fields[$key];
7460 }
7461
7462 // Validation tests and output
7463 $fieldValidationErrorMsg = '';
7464 $validationClass = '';
7465 $fieldValidationErrorMsg = $this->getFieldError($key);
7466 if (!empty($fieldValidationErrorMsg)) {
7467 $validationClass = ' --error'; // the -- is use as class state in css : .--error can't be be defined alone it must be define with another class like .my-class.--error or input.--error
7468 } else {
7469 $validationClass = ' --success'; // the -- is use as class state in css : .--success can't be be defined alone it must be define with another class like .my-class.--success or input.--success
7470 }
7471
7472 $valuemultiselectinput = array();
7473 $out = '';
7474 $type = '';
7475 $isDependList = 0;
7476 $param = array();
7477 $param['options'] = array();
7478 $reg = array();
7479 // @phan-suppress-next-line PhanTypeMismatchProperty
7480 $size = !empty($this->fields[$key]['size']) ? $this->fields[$key]['size'] : 0;
7481 // Because we work on extrafields
7482 if (preg_match('/^(integer|link):(.*):(.*):(.*):(.*)/i', $val['type'], $reg)) {
7483 $param['options'] = array($reg[2].':'.$reg[3].':'.$reg[4].':'.$reg[5] => 'N');
7484 $type = 'link';
7485 } elseif (preg_match('/^(integer|link):(.*):(.*):(.*)/i', $val['type'], $reg)) {
7486 $param['options'] = array($reg[2].':'.$reg[3].':'.$reg[4] => 'N');
7487 $type = 'link';
7488 } elseif (preg_match('/^(integer|link):(.*):(.*)/i', $val['type'], $reg)) {
7489 $param['options'] = array($reg[2].':'.$reg[3] => 'N');
7490 $type = 'link';
7491 } elseif (preg_match('/^(sellist):(.*):(.*):(.*):(.*)/i', $val['type'], $reg)) {
7492 $param['options'] = array($reg[2].':'.$reg[3].':'.$reg[4].':'.$reg[5] => 'N');
7493 $type = 'sellist';
7494 } elseif (preg_match('/^(sellist):(.*):(.*):(.*)/i', $val['type'], $reg)) {
7495 $param['options'] = array($reg[2].':'.$reg[3].':'.$reg[4] => 'N');
7496 $type = 'sellist';
7497 } elseif (preg_match('/^(sellist):(.*):(.*)/i', $val['type'], $reg)) {
7498 $param['options'] = array($reg[2].':'.$reg[3] => 'N');
7499 $type = 'sellist';
7500 } elseif (preg_match('/^chkbxlst:(.*)/i', $val['type'], $reg)) {
7501 $param['options'] = array($reg[1] => 'N');
7502 $type = 'chkbxlst';
7503 } elseif (preg_match('/varchar\‍((\d+)\‍)/', $val['type'], $reg)) {
7504 $param['options'] = array();
7505 $type = 'varchar';
7506 $size = $reg[1];
7507 } elseif (preg_match('/varchar/', $val['type'])) {
7508 $param['options'] = array();
7509 $type = 'varchar';
7510 } elseif (preg_match('/stars\‍((\d+)\‍)/', $val['type'], $reg)) {
7511 $param['options'] = array();
7512 $type = 'stars';
7513 $size = $reg[1];
7514 } else {
7515 $param['options'] = array();
7516 $type = $this->fields[$key]['type'];
7517 }
7518 //var_dump($type); var_dump($param['options']);
7519
7520 // Special case that force options and type ($type can be integer, varchar, ...)
7521 if (!empty($this->fields[$key]['arrayofkeyval']) && is_array($this->fields[$key]['arrayofkeyval'])) {
7522 $param['options'] = $this->fields[$key]['arrayofkeyval'];
7523 // Special case that prevent to force $type to have multiple input @phan-suppress-next-line PhanTypeMismatchProperty
7524 if (empty($this->fields[$key]['multiinput'])) {
7525 $type = (($this->fields[$key]['type'] == 'checkbox') ? $this->fields[$key]['type'] : 'select');
7526 }
7527 }
7528
7529 $label = $this->fields[$key]['label'];
7530 //$elementtype=$this->fields[$key]['elementtype']; // Seems not used
7531 // @phan-suppress-next-line PhanTypeArraySuspiciousNullable
7532 $default = (!empty($this->fields[$key]['default']) ? $this->fields[$key]['default'] : '');
7533 // @phan-suppress-next-line PhanTypeMismatchProperty
7534 $computed = (!empty($this->fields[$key]['computed']) ? $this->fields[$key]['computed'] : '');
7535 // @phan-suppress-next-line PhanTypeMismatchProperty
7536 $unique = (!empty($this->fields[$key]['unique']) ? $this->fields[$key]['unique'] : 0);
7537 // @phan-suppress-next-line PhanTypeMismatchProperty
7538 $required = (!empty($this->fields[$key]['required']) ? $this->fields[$key]['required'] : 0);
7539 // @phan-suppress-next-line PhanTypeMismatchProperty
7540 $autofocusoncreate = (!empty($this->fields[$key]['autofocusoncreate']) ? $this->fields[$key]['autofocusoncreate'] : 0);
7541
7542 // @phan-suppress-next-line PhanTypeMismatchProperty
7543 $langfile = (!empty($this->fields[$key]['langfile']) ? $this->fields[$key]['langfile'] : '');
7544 // @phan-suppress-next-line PhanTypeMismatchProperty
7545 $list = (!empty($this->fields[$key]['list']) ? $this->fields[$key]['list'] : 0);
7546 $hidden = (in_array(abs($this->fields[$key]['visible']), array(0, 2)) ? 1 : 0);
7547
7548 $objectid = $this->id;
7549
7550 if ($computed) {
7551 if (!preg_match('/^search_/', $keyprefix)) {
7552 return '<span class="opacitymedium">'.$langs->trans("AutomaticallyCalculated").'</span>';
7553 } else {
7554 return '';
7555 }
7556 }
7557
7558 // Set value of $morecss. For this, we use in priority showsize from parameters, then $val['css'] then autodefine
7559 if (empty($morecss) && !empty($val['css'])) {
7560 $morecss = $val['css'];
7561 } elseif (empty($morecss)) {
7562 if ($type == 'date') {
7563 $morecss = 'minwidth100imp';
7564 } elseif ($type == 'datetime' || $type == 'link') { // link means an foreign key to another primary id
7565 $morecss = 'minwidth200imp';
7566 } elseif (in_array($type, array('int', 'integer', 'price')) || preg_match('/^double(\‍([0-9],[0-9]\‍)){0,1}/', (string) $type)) {
7567 $morecss = 'maxwidth75';
7568 } elseif ($type == 'url') {
7569 $morecss = 'minwidth400';
7570 } elseif ($type == 'boolean') {
7571 $morecss = '';
7572 } else {
7573 if (is_numeric($size) && round((float) $size) < 12) {
7574 $morecss = 'minwidth100';
7575 } elseif (is_numeric($size) && round((float) $size) <= 48) {
7576 $morecss = 'minwidth200';
7577 } else {
7578 $morecss = 'minwidth400';
7579 }
7580 }
7581 }
7582
7583 // Add validation state class
7584 if (!empty($validationClass)) {
7585 $morecss .= $validationClass;
7586 }
7587
7588 if (in_array($type, array('date'))) {
7589 $tmp = explode(',', $size);
7590 $newsize = $tmp[0];
7591 $showtime = 0;
7592
7593 // Do not show current date when field not required (see selectDate() method)
7594 if (!$required && $value == '') {
7595 $value = '-1';
7596 }
7597
7598 // TODO Must also support $moreparam
7599 $out = $form->selectDate($value, $keyprefix.$key.$keysuffix, $showtime, $showtime, $required, '', 1, (($keyprefix != 'search_' && $keyprefix != 'search_options_') ? 1 : 0), 0, 1);
7600 } elseif (in_array($type, array('datetime'))) {
7601 $tmp = explode(',', $size);
7602 $newsize = $tmp[0];
7603 $showtime = 1;
7604
7605 // Do not show current date when field not required (see selectDate() method)
7606 if (!$required && $value == '') {
7607 $value = '-1';
7608 }
7609
7610 // TODO Must also support $moreparam
7611 $out = $form->selectDate($value, $keyprefix.$key.$keysuffix, $showtime, $showtime, $required, '', 1, (($keyprefix != 'search_' && $keyprefix != 'search_options_') ? 1 : 0), 0, 1, '', '', '', 1, '', '', 'tzuserrel');
7612 } elseif (in_array($type, array('duration'))) {
7613 $out = $form->select_duration($keyprefix.$key.$keysuffix, $value, 0, 'text', 0, 1);
7614 } elseif (in_array($type, array('int', 'integer'))) {
7615 $tmp = explode(',', $size);
7616 $newsize = $tmp[0];
7617 $out = '<input type="text" class="flat '.$morecss.'" name="'.$keyprefix.$key.$keysuffix.'" id="'.$keyprefix.$key.$keysuffix.'"'.($newsize > 0 ? ' maxlength="'.$newsize.'"' : '').' value="'.dol_escape_htmltag($value).'"'.($moreparam ? $moreparam : '').($autofocusoncreate ? ' autofocus' : '').'>';
7618 } elseif (in_array($type, array('real'))) {
7619 $out = '<input type="text" class="flat '.$morecss.'" name="'.$keyprefix.$key.$keysuffix.'" id="'.$keyprefix.$key.$keysuffix.'" value="'.dol_escape_htmltag($value).'"'.($moreparam ? $moreparam : '').($autofocusoncreate ? ' autofocus' : '').'>';
7620 } elseif (preg_match('/varchar/', (string) $type)) {
7621 $out = '<input type="text" class="flat '.$morecss.'" name="'.$keyprefix.$key.$keysuffix.'" id="'.$keyprefix.$key.$keysuffix.'"'.($size > 0 ? ' maxlength="'.$size.'"' : '').' value="'.dol_escape_htmltag($value).'"'.($moreparam ? $moreparam : '').($autofocusoncreate ? ' autofocus' : '').'>';
7622 } elseif (in_array($type, array('email', 'mail', 'phone', 'url', 'ip'))) {
7623 $out = '<input type="text" class="flat '.$morecss.'" name="'.$keyprefix.$key.$keysuffix.'" id="'.$keyprefix.$key.$keysuffix.'" value="'.dol_escape_htmltag($value).'" '.($moreparam ? $moreparam : '').($autofocusoncreate ? ' autofocus' : '').'>';
7624 } elseif (preg_match('/^text/', (string) $type)) {
7625 if (!preg_match('/search_/', $keyprefix)) { // If keyprefix is search_ or search_options_, we must just use a simple text field
7626 if (!empty($param['options'])) {
7627 // If the textarea field has a list of arrayofkeyval into its definition, we suggest a combo with possible values to fill the textarea.
7628 //var_dump($param['options']);
7629 $out .= $form->selectarray($keyprefix.$key.$keysuffix."_multiinput", $param['options'], '', 1, 0, 0, "flat maxwidthonphone".$morecss);
7630 $out .= '<input id="'.$keyprefix.$key.$keysuffix.'_multiinputadd" type="button" class="button" value="'.$langs->trans("Add").'">';
7631 $out .= "<script>";
7632 $out .= '
7633 function handlemultiinputdisabling(htmlname){
7634 console.log("We handle the disabling of used options for "+htmlname+"_multiinput");
7635 multiinput = $("#"+htmlname+"_multiinput");
7636 multiinput.find("option").each(function(){
7637 tmpval = $("#"+htmlname).val();
7638 tmpvalarray = tmpval.split("\n");
7639 valtotest = $(this).val();
7640 if(tmpvalarray.includes(valtotest)){
7641 $(this).prop("disabled",true);
7642 } else {
7643 if($(this).prop("disabled") == true){
7644 console.log(valtotest)
7645 $(this).prop("disabled", false);
7646 }
7647 }
7648 });
7649 }
7650
7651 $(document).ready(function () {
7652 $("#'.$keyprefix.$key.$keysuffix.'_multiinputadd").on("click",function() {
7653 tmpval = $("#'.$keyprefix.$key.$keysuffix.'").val();
7654 tmpvalarray = tmpval.split(",");
7655 valtotest = $("#'.$keyprefix.$key.$keysuffix.'_multiinput").val();
7656 if(valtotest != -1 && !tmpvalarray.includes(valtotest)){
7657 console.log("We add the selected value to the text area '.$keyprefix.$key.$keysuffix.'");
7658 if(tmpval == ""){
7659 tmpval = valtotest;
7660 } else {
7661 tmpval = tmpval + "\n" + valtotest;
7662 }
7663 $("#'.$keyprefix.$key.$keysuffix.'").val(tmpval);
7664 handlemultiinputdisabling("'.$keyprefix.$key.$keysuffix.'");
7665 $("#'.$keyprefix.$key.$keysuffix.'_multiinput").val(-1);
7666 } else {
7667 console.log("We add nothing the text area '.$keyprefix.$key.$keysuffix.'");
7668 }
7669 });
7670 $("#'.$keyprefix.$key.$keysuffix.'").on("change",function(){
7671 handlemultiinputdisabling("'.$keyprefix.$key.$keysuffix.'");
7672 });
7673 handlemultiinputdisabling("'.$keyprefix.$key.$keysuffix.'");
7674 })';
7675 $out .= "</script>";
7676 $value = str_replace(',', "\n", $value);
7677 }
7678 require_once DOL_DOCUMENT_ROOT.'/core/class/doleditor.class.php';
7679 $doleditor = new DolEditor($keyprefix.$key.$keysuffix, $value, '', 200, 'dolibarr_notes', 'In', false, false, false, ROWS_5, '90%');
7680 $out .= (string) $doleditor->Create(1, '', true, '', '', '', $morecss);
7681 } else {
7682 $out = '<input type="text" class="flat '.$morecss.' maxwidthonsmartphone" name="'.$keyprefix.$key.$keysuffix.'" id="'.$keyprefix.$key.$keysuffix.'" value="'.dol_escape_htmltag($value).'" '.($moreparam ? $moreparam : '').'>';
7683 }
7684 } elseif (preg_match('/^html/', (string) $type)) {
7685 if (!preg_match('/search_/', $keyprefix)) { // If keyprefix is search_ or search_options_, we must just use a simple text field
7686 require_once DOL_DOCUMENT_ROOT.'/core/class/doleditor.class.php';
7687 $doleditor = new DolEditor($keyprefix.$key.$keysuffix, $value, '', 200, 'dolibarr_notes', 'In', false, false, isModEnabled('fckeditor') && getDolGlobalInt('FCKEDITOR_ENABLE_SOCIETE'), ROWS_5, '90%');
7688 $out = (string) $doleditor->Create(1, '', true, '', '', $moreparam, $morecss);
7689 } else {
7690 $out = '<input type="text" class="flat '.$morecss.' maxwidthonsmartphone" name="'.$keyprefix.$key.$keysuffix.'" id="'.$keyprefix.$key.$keysuffix.'" value="'.dol_escape_htmltag($value).'" '.($moreparam ? $moreparam : '').'>';
7691 }
7692 } elseif ($type == 'boolean') {
7693 $checked = '';
7694 if (!empty($value)) {
7695 $checked = ' checked value="1" ';
7696 } else {
7697 $checked = ' value="1" ';
7698 }
7699 $out = '<input type="checkbox" class="flat '.$morecss.' maxwidthonsmartphone" name="'.$keyprefix.$key.$keysuffix.'" id="'.$keyprefix.$key.$keysuffix.'" '.$checked.' '.($moreparam ? $moreparam : '').'>';
7700 } elseif ($type == 'price') {
7701 if (!empty($value)) { // $value in memory is a php numeric, we format it into user number format.
7702 $value = price($value);
7703 }
7704 $out = '<input type="text" class="flat '.$morecss.' maxwidthonsmartphone" name="'.$keyprefix.$key.$keysuffix.'" id="'.$keyprefix.$key.$keysuffix.'" value="'.$value.'" '.($moreparam ? $moreparam : '').'> '.$langs->getCurrencySymbol($conf->currency);
7705 } elseif ($type == 'stars') {
7706 $out = '<input type="hidden" class="flat '.$morecss.'" name="'.$keyprefix.$key.$keysuffix.'" id="'.$keyprefix.$key.$keysuffix.'" value="'.dol_escape_htmltag($value).'"'.($moreparam ? $moreparam : '').($autofocusoncreate ? ' autofocus' : '').'>';
7707 $out .= '<div class="star-selection" id="'.$keyprefix.$key.$keysuffix.'_selection">';
7708 $i = 1;
7709 while ($i <= $size) {
7710 $out .= '<span class="star" data-value="'.$i.'">'.img_picto('', 'fontawesome_star_fas').'</span>';
7711 $i++;
7712 }
7713 $out .= '</div>';
7714 $out .= '<script>
7715 jQuery(function($) {
7716 let container = $("#'.$keyprefix.$key.$keysuffix.'_selection");
7717 let selectedStars = parseInt($("#'.$keyprefix.$key.$keysuffix.'").val()) || 0;
7718 container.find(".star").each(function() {
7719 $(this).toggleClass("active", $(this).data("value") <= selectedStars);
7720 });
7721 container.find(".star").on("mouseover", function() {
7722 let selectedStar = $(this).data("value");
7723 container.find(".star").each(function() {
7724 $(this).toggleClass("active", $(this).data("value") <= selectedStar);
7725 });
7726 });
7727 container.on("mouseout", function() {
7728 container.find(".star").each(function() {
7729 $(this).toggleClass("active", $(this).data("value") <= selectedStars);
7730 });
7731 });
7732 container.find(".star").off("click").on("click", function() {
7733 selectedStars = $(this).data("value");
7734 if (selectedStars === 1 && $("#'.$keyprefix.$key.$keysuffix.'").val() == 1) {
7735 selectedStars = 0;
7736 }
7737 $("#'.$keyprefix.$key.$keysuffix.'").val(selectedStars);
7738 container.find(".star").each(function() {
7739 $(this).toggleClass("active", $(this).data("value") <= selectedStars);
7740 });
7741 });
7742 });
7743 </script>';
7744 } elseif (preg_match('/^double(\‍([0-9],[0-9]\‍)){0,1}/', (string) $type)) {
7745 if (!empty($value)) { // $value in memory is a php numeric, we format it into user number format.
7746 $value = price($value);
7747 }
7748 $out = '<input type="text" class="flat '.$morecss.' maxwidthonsmartphone" name="'.$keyprefix.$key.$keysuffix.'" id="'.$keyprefix.$key.$keysuffix.'" value="'.$value.'" '.($moreparam ? $moreparam : '').'> ';
7749 } elseif ($type == 'select') { // combo list
7750 $out = '';
7751 if (!empty($conf->use_javascript_ajax) && !getDolGlobalString('MAIN_EXTRAFIELDS_DISABLE_SELECT2')) {
7752 include_once DOL_DOCUMENT_ROOT.'/core/lib/ajax.lib.php';
7753 $out .= ajax_combobox($keyprefix.$key.$keysuffix, array(), 0);
7754 }
7755
7756 $tmpselect = '';
7757 $nbchoice = 0;
7758 foreach ($param['options'] as $keyb => $valb) {
7759 if ((string) $keyb == '') {
7760 continue;
7761 }
7762 if (strpos($valb, "|") !== false) {
7763 list($valb, $parent) = explode('|', $valb);
7764 }
7765 $nbchoice++;
7766 $tmpselect .= '<option value="'.$keyb.'"';
7767 $tmpselect .= (((string) $value == (string) $keyb) ? ' selected' : '');
7768 if (!empty($parent)) {
7769 $isDependList = 1;
7770 }
7771 $tmpselect .= (!empty($parent) ? ' parent="'.$parent.'"' : '');
7772 $tmpselect .= '>'.$langs->trans($valb).'</option>';
7773 }
7774
7775 $out .= '<select class="flat '.$morecss.' maxwidthonsmartphone" name="'.$keyprefix.$key.$keysuffix.'" id="'.$keyprefix.$key.$keysuffix.'" '.($moreparam ? $moreparam : '').'>';
7776 if ((!isset($this->fields[$key]['default'])) || ($this->fields[$key]['notnull'] != 1) || $nbchoice >= 2) {
7777 $out .= '<option value="0">&nbsp;</option>';
7778 }
7779 $out .= $tmpselect;
7780 $out .= '</select>';
7781 } elseif ($type == 'sellist') {
7782 $out = '';
7783 if (!empty($conf->use_javascript_ajax) && !getDolGlobalString('MAIN_EXTRAFIELDS_DISABLE_SELECT2')) {
7784 include_once DOL_DOCUMENT_ROOT.'/core/lib/ajax.lib.php';
7785 $out .= ajax_combobox($keyprefix.$key.$keysuffix, array(), 0);
7786 }
7787
7788 $out .= '<select class="flat '.$morecss.' maxwidthonsmartphone" name="'.$keyprefix.$key.$keysuffix.'" id="'.$keyprefix.$key.$keysuffix.'" '.($moreparam ? $moreparam : '').'>';
7789 if (is_array($param['options'])) {
7790 $tmpparamoptions = array_keys($param['options']);
7791 $paramoptions = preg_split('/[\r\n]+/', $tmpparamoptions[0]);
7792
7793 $InfoFieldList = explode(":", $paramoptions[0], 5);
7794 // 0 : tableName
7795 // 1 : label field name
7796 // 2 : key fields name (if different of rowid)
7797 // optional parameters...
7798 // 3 : key field parent (for dependent lists). How this is used ?
7799 // 4 : where clause filter on column or table extrafield, syntax field='value' or extra.field=value. Or use USF on a second line separated by "\n".
7800 // 5 : string category type. This replace the filter.
7801 // 6 : ids categories list separated by comma for category root. This replace the filter.
7802 // 7 : sort field
7803
7804 // If there is filter
7805 if (! empty($InfoFieldList[4])) {
7806 $pos = 0;
7807 $parenthesisopen = 0;
7808 while (substr($InfoFieldList[4], $pos, 1) !== '' && ($parenthesisopen || $pos == 0 || substr($InfoFieldList[4], $pos, 1) != ':')) {
7809 if (substr($InfoFieldList[4], $pos, 1) == '(') {
7810 $parenthesisopen++;
7811 }
7812 if (substr($InfoFieldList[4], $pos, 1) == ')') {
7813 $parenthesisopen--;
7814 }
7815 $pos++;
7816 }
7817 $tmpbefore = substr($InfoFieldList[4], 0, $pos);
7818 $tmpafter = substr($InfoFieldList[4], $pos + 1);
7819 //var_dump($InfoFieldList[4].' -> '.$pos); var_dump($tmpafter);
7820 $InfoFieldList[4] = $tmpbefore;
7821 if ($tmpafter !== '') {
7822 $InfoFieldList = array_merge($InfoFieldList, explode(':', $tmpafter));
7823 }
7824 //var_dump($InfoFieldList);
7825
7826 // Fix better compatibility with some old extrafield syntax filter "(field=123)"
7827 $reg = array();
7828 if (preg_match('/^\‍(?([a-z0-9]+)([=<>]+)(\d+)\‍)?$/i', $InfoFieldList[4], $reg)) {
7829 $InfoFieldList[4] = '('.$reg[1].':'.$reg[2].':'.$reg[3].')';
7830 }
7831
7832 //var_dump($InfoFieldList);
7833 }
7834
7835 //$Usf = empty($paramoptions[1]) ? '' :$paramoptions[1];
7836
7837 $parentName = '';
7838 $parentField = '';
7839
7840 $keyList = (empty($InfoFieldList[2]) ? 'rowid' : $InfoFieldList[2].' as rowid');
7841
7842 if (count($InfoFieldList) > 4 && !empty($InfoFieldList[4])) {
7843 if (strpos($InfoFieldList[4], 'extra.') !== false) {
7844 $keyList = 'main.'.$InfoFieldList[2].' as rowid';
7845 } else {
7846 $keyList = $InfoFieldList[2].' as rowid';
7847 }
7848 }
7849 if (count($InfoFieldList) > 3 && !empty($InfoFieldList[3])) {
7850 list($parentName, $parentField) = explode('|', $InfoFieldList[3]);
7851 $keyList .= ', '.$parentField;
7852 }
7853
7854 $filter_categorie = false;
7855 if (count($InfoFieldList) > 5) {
7856 if ($InfoFieldList[0] == 'categorie') {
7857 $filter_categorie = true;
7858 }
7859 }
7860
7861 if (!$filter_categorie) {
7862 $fields_label = explode('|', $InfoFieldList[1]);
7863 if (is_array($fields_label)) {
7864 $keyList .= ', ';
7865 $keyList .= implode(', ', $fields_label);
7866 }
7867
7868 $sqlwhere = '';
7869 $sql = "SELECT " . $keyList;
7870 $sql .= " FROM " . $this->db->prefix() . $InfoFieldList[0];
7871
7872 if (!empty($InfoFieldList[4])) {
7873 // can use SELECT request
7874 if (strpos($InfoFieldList[4], '$SEL$') !== false) {
7875 $InfoFieldList[4] = str_replace('$SEL$', 'SELECT', $InfoFieldList[4]);
7876 }
7877
7878 // current object id can be use into filter
7879 if (strpos($InfoFieldList[4], '$ID$') !== false && !empty($objectid)) {
7880 $InfoFieldList[4] = str_replace('$ID$', (string) $objectid, $InfoFieldList[4]);
7881 } else {
7882 $InfoFieldList[4] = str_replace('$ID$', '0', $InfoFieldList[4]);
7883 }
7884
7885 // We have to join on extrafield table
7886 $errstr = '';
7887 if (strpos($InfoFieldList[4], 'extra') !== false) {
7888 $sql .= " as main, " . $this->db->sanitize($this->db->prefix() . $InfoFieldList[0]) . "_extrafields as extra";
7889 $sqlwhere .= " WHERE extra.fk_object = main." . $this->db->sanitize($InfoFieldList[2]);
7890 $sqlwhere .= " AND " . forgeSQLFromUniversalSearchCriteria($InfoFieldList[4], $errstr, 1);
7891 } else {
7892 $sqlwhere .= " WHERE " . forgeSQLFromUniversalSearchCriteria($InfoFieldList[4], $errstr, 1);
7893 }
7894 } else {
7895 $sqlwhere .= ' WHERE 1=1';
7896 }
7897
7898 // Add Usf filter on second line
7899 /*
7900 if ($Usf) {
7901 $errorstr = '';
7902 $sqlusf .= forgeSQLFromUniversalSearchCriteria($Usf, $errorstr);
7903 if (!$errorstr) {
7904 $sqlwhere .= $sqlusf;
7905 } else {
7906 $sqlwhere .= " AND invalid_usf_filter_of_extrafield";
7907 }
7908 }
7909 */
7910
7911 // Some tables may have field, some other not. For the moment we disable it.
7912 if (in_array($InfoFieldList[0], array('tablewithentity'))) {
7913 $sqlwhere .= " AND entity = " . ((int) $conf->entity);
7914 }
7915 $sql .= $sqlwhere;
7916
7917 // Note: $InfoFieldList can be 'sellist:TableName:LabelFieldName[:KeyFieldName[:KeyFieldParent[:Filter[:CategoryIdType[:CategoryIdList[:Sortfield]]]]]]'
7918 if (isset($InfoFieldList[7]) && preg_match('/^[a-z0-9_\-,]+$/i', $InfoFieldList[7])) {
7919 $sql .= " ORDER BY ".$this->db->escape($InfoFieldList[7]);
7920 } else {
7921 $sql .= " ORDER BY ".$this->db->sanitize(implode(', ', $fields_label));
7922 }
7923
7924 dol_syslog(get_class($this) . '::showInputField type=sellist', LOG_DEBUG);
7925 $resql = $this->db->query($sql);
7926 if ($resql) {
7927 $out .= '<option value="0">&nbsp;</option>';
7928 $num = $this->db->num_rows($resql);
7929 $i = 0;
7930 while ($i < $num) {
7931 $labeltoshow = '';
7932 $obj = $this->db->fetch_object($resql);
7933
7934 // Several field into label (eq table:code|libelle:rowid)
7935 $notrans = false;
7936 $fields_label = explode('|', $InfoFieldList[1]);
7937 if (count($fields_label) > 1) {
7938 $notrans = true;
7939 foreach ($fields_label as $field_toshow) {
7940 $labeltoshow .= $obj->$field_toshow . ' ';
7941 }
7942 } else {
7943 $labeltoshow = $obj->{$InfoFieldList[1]};
7944 }
7945 $labeltoshow = dol_trunc($labeltoshow, 45);
7946
7947 if ($value == $obj->rowid) {
7948 foreach ($fields_label as $field_toshow) {
7949 $translabel = $langs->trans($obj->$field_toshow);
7950 if ($translabel != $obj->$field_toshow) {
7951 $labeltoshow = dol_trunc($translabel) . ' ';
7952 } else {
7953 $labeltoshow = dol_trunc($obj->$field_toshow) . ' ';
7954 }
7955 }
7956 $out .= '<option value="' . $obj->rowid . '" selected>' . $labeltoshow . '</option>';
7957 } else {
7958 if (!$notrans) {
7959 $translabel = $langs->trans($obj->{$InfoFieldList[1]});
7960 if ($translabel != $obj->{$InfoFieldList[1]}) {
7961 $labeltoshow = dol_trunc($translabel, 18);
7962 } else {
7963 $labeltoshow = dol_trunc($obj->{$InfoFieldList[1]});
7964 }
7965 }
7966 if (empty($labeltoshow)) {
7967 $labeltoshow = '(not defined)';
7968 }
7969 if ($value == $obj->rowid) {
7970 $out .= '<option value="' . $obj->rowid . '" selected>' . $labeltoshow . '</option>';
7971 }
7972
7973 if (!empty($InfoFieldList[3]) && $parentField) {
7974 $parent = $parentName . ':' . $obj->{$parentField};
7975 $isDependList = 1;
7976 }
7977
7978 $out .= '<option value="' . $obj->rowid . '"';
7979 $out .= ($value == $obj->rowid ? ' selected' : '');
7980 $out .= (!empty($parent) ? ' parent="' . $parent . '"' : '');
7981 $out .= '>' . $labeltoshow . '</option>';
7982 }
7983
7984 $i++;
7985 }
7986 $this->db->free($resql);
7987 } else {
7988 print 'Error in request ' . $sql . ' ' . $this->db->lasterror() . '. Check setup of extra parameters.<br>';
7989 }
7990 } else {
7991 require_once DOL_DOCUMENT_ROOT.'/categories/class/categorie.class.php';
7992 $data = $form->select_all_categories(Categorie::$MAP_ID_TO_CODE[$InfoFieldList[5]], '', 'parent', 64, $InfoFieldList[6], 1, 1);
7993 $out .= '<option value="0">&nbsp;</option>';
7994 foreach ($data as $data_key => $data_value) {
7995 $out .= '<option value="' . $data_key . '"';
7996 $out .= ($value == $data_key ? ' selected' : '');
7997 $out .= '>' . $data_value . '</option>';
7998 }
7999 }
8000 }
8001 $out .= '</select>';
8002 } elseif ($type == 'checkbox') {
8003 $value_arr = explode(',', $value);
8004 $out = $form->multiselectarray($keyprefix.$key.$keysuffix, (empty($param['options']) ? null : $param['options']), $value_arr, 0, 0, $morecss, 0, '100%');
8005 } elseif ($type == 'radio') {
8006 $out = '';
8007 foreach ($param['options'] as $keyopt => $valopt) {
8008 $out .= '<input class="flat '.$morecss.'" type="radio" name="'.$keyprefix.$key.$keysuffix.'" id="'.$keyprefix.$key.$keysuffix.'" '.($moreparam ? $moreparam : '');
8009 $out .= ' value="'.$keyopt.'"';
8010 $out .= ' id="'.$keyprefix.$key.$keysuffix.'_'.$keyopt.'"';
8011 $out .= ($value == $keyopt ? 'checked' : '');
8012 $out .= '/><label for="'.$keyprefix.$key.$keysuffix.'_'.$keyopt.'">'.$valopt.'</label><br>';
8013 }
8014 } elseif ($type == 'chkbxlst') {
8015 if (is_array($value)) {
8016 $value_arr = $value;
8017 } else {
8018 $value_arr = explode(',', $value);
8019 }
8020
8021 if (is_array($param['options'])) {
8022 $tmpparamoptions = array_keys($param['options']);
8023 $paramoptions = preg_split('/[\r\n]+/', $tmpparamoptions[0]);
8024
8025 $InfoFieldList = explode(":", $paramoptions[0], 5);
8026 // 0 : tableName
8027 // 1 : label field name
8028 // 2 : key fields name (if different of rowid)
8029 // optional parameters...
8030 // 3 : key field parent (for dependent lists). How this is used ?
8031 // 4 : where clause filter on column or table extrafield, syntax field='value' or extra.field=value. Or use USF on a second line separated by "\n".
8032 // 5 : string category type. This replace the filter.
8033 // 6 : ids categories list separated by comma for category root. This replace the filter.
8034 // 7 : sort field
8035
8036 // If there is a filter
8037 if (! empty($InfoFieldList[4])) {
8038 $pos = 0;
8039 $parenthesisopen = 0;
8040 while (substr($InfoFieldList[4], $pos, 1) !== '' && ($parenthesisopen || $pos == 0 || substr($InfoFieldList[4], $pos, 1) != ':')) {
8041 if (substr($InfoFieldList[4], $pos, 1) == '(') {
8042 $parenthesisopen++;
8043 }
8044 if (substr($InfoFieldList[4], $pos, 1) == ')') {
8045 $parenthesisopen--;
8046 }
8047 $pos++;
8048 }
8049 $tmpbefore = substr($InfoFieldList[4], 0, $pos);
8050 $tmpafter = substr($InfoFieldList[4], $pos + 1);
8051 //var_dump($InfoFieldList[4].' -> '.$pos); var_dump($tmpafter);
8052 $InfoFieldList[4] = $tmpbefore;
8053 if ($tmpafter !== '') {
8054 $InfoFieldList = array_merge($InfoFieldList, explode(':', $tmpafter));
8055 }
8056
8057 // Fix better compatibility with some old extrafield syntax filter "(field=123)"
8058 $reg = array();
8059 if (preg_match('/^\‍(?([a-z0-9]+)([=<>]+)(\d+)\‍)?$/i', $InfoFieldList[4], $reg)) {
8060 $InfoFieldList[4] = '('.$reg[1].':'.$reg[2].':'.$reg[3].')';
8061 }
8062
8063 //var_dump($InfoFieldList);
8064 }
8065
8066 //$Usf = empty($paramoptions[1]) ? '' :$paramoptions[1];
8067
8068 '@phan-var-force array{0:string,1:string,2:string,3:string,3:string,5:string,6:string} $InfoFieldList';
8069
8070 $parentName = '';
8071 $parentField = '';
8072
8073 $keyList = (empty($InfoFieldList[2]) ? 'rowid' : $InfoFieldList[2].' as rowid');
8074
8075 if (count($InfoFieldList) > 3 && !empty($InfoFieldList[3])) {
8076 list($parentName, $parentField) = explode('|', $InfoFieldList[3]);
8077 $keyList .= ', '.$parentField;
8078 }
8079 if (count($InfoFieldList) > 4 && !empty($InfoFieldList[4])) {
8080 if (strpos($InfoFieldList[4], 'extra.') !== false) {
8081 $keyList = 'main.'.$InfoFieldList[2].' as rowid';
8082 } else {
8083 $keyList = $InfoFieldList[2].' as rowid';
8084 }
8085 }
8086
8087 $filter_categorie = false;
8088 if (count($InfoFieldList) > 5) {
8089 if ($InfoFieldList[0] == 'categorie') {
8090 $filter_categorie = true;
8091 }
8092 }
8093
8094 // Common filter
8095 if (!$filter_categorie) {
8096 $fields_label = explode('|', $InfoFieldList[1]);
8097 if (is_array($fields_label)) {
8098 $keyList .= ', ';
8099 $keyList .= implode(', ', $fields_label);
8100 }
8101
8102 $sqlwhere = '';
8103 $sql = "SELECT " . $keyList;
8104 $sql .= ' FROM ' . $this->db->prefix() . $InfoFieldList[0];
8105
8106 if (!empty($InfoFieldList[4])) {
8107 // can use SELECT request
8108 if (strpos($InfoFieldList[4], '$SEL$') !== false) {
8109 $InfoFieldList[4] = str_replace('$SEL$', 'SELECT', $InfoFieldList[4]);
8110 }
8111
8112 // current object id can be use into filter
8113 if (strpos($InfoFieldList[4], '$ID$') !== false && !empty($objectid)) {
8114 $InfoFieldList[4] = str_replace('$ID$', (string) $objectid, $InfoFieldList[4]);
8115 } else {
8116 $InfoFieldList[4] = str_replace('$ID$', '0', $InfoFieldList[4]);
8117 }
8118
8119 // We have to join on extrafield table
8120 $errstr = '';
8121 if (strpos($InfoFieldList[4], 'extra') !== false) {
8122 $sql .= ' as main, ' . $this->db->sanitize($this->db->prefix() . $InfoFieldList[0]) . '_extrafields as extra';
8123 $sqlwhere .= " WHERE extra.fk_object = main." . $this->db->sanitize($InfoFieldList[2]);
8124 $sqlwhere .= " AND " . $InfoFieldList[4];
8125 } else {
8126 $sqlwhere .= " WHERE " . $InfoFieldList[4];
8127 }
8128 } else {
8129 $sqlwhere .= ' WHERE 1=1';
8130 }
8131
8132 // Add Usf filter on second line
8133 /*
8134 if ($Usf) {
8135 $errorstr = '';
8136 $sqlusf .= forgeSQLFromUniversalSearchCriteria($Usf, $errorstr);
8137 if (!$errorstr) {
8138 $sqlwhere .= $sqlusf;
8139 } else {
8140 $sqlwhere .= " AND invalid_usf_filter_of_extrafield";
8141 }
8142 }
8143 */
8144
8145 // Some tables may have field, some other not. For the moment we disable it.
8146 if (in_array($InfoFieldList[0], array('tablewithentity'))) {
8147 $sqlwhere .= " AND entity = " . ((int) $conf->entity);
8148 }
8149 // $sql.=preg_replace('/^ AND /','',$sqlwhere);
8150 // print $sql;
8151
8152 $sql .= $sqlwhere;
8153
8154 dol_syslog(get_class($this) . '::showInputField type=chkbxlst', LOG_DEBUG);
8155
8156 $resql = $this->db->query($sql);
8157 if ($resql) {
8158 $num = $this->db->num_rows($resql);
8159 $i = 0;
8160
8161 $data = array();
8162
8163 while ($i < $num) {
8164 $labeltoshow = '';
8165 $obj = $this->db->fetch_object($resql);
8166
8167 $notrans = false;
8168 // Several field into label (eq table:code|libelle:rowid)
8169 $fields_label = explode('|', $InfoFieldList[1]);
8170 if (count($fields_label) > 1) {
8171 $notrans = true;
8172 foreach ($fields_label as $field_toshow) {
8173 $labeltoshow .= $obj->$field_toshow . ' ';
8174 }
8175 } else {
8176 $labeltoshow = $obj->{$InfoFieldList[1]};
8177 }
8178 $labeltoshow = dol_trunc($labeltoshow, 45);
8179
8180 if (is_array($value_arr) && in_array($obj->rowid, $value_arr)) {
8181 foreach ($fields_label as $field_toshow) {
8182 $translabel = $langs->trans($obj->$field_toshow);
8183 if ($translabel != $obj->$field_toshow) {
8184 $labeltoshow = dol_trunc($translabel, 18) . ' ';
8185 } else {
8186 $labeltoshow = dol_trunc($obj->$field_toshow, 18) . ' ';
8187 }
8188 }
8189
8190 $data[$obj->rowid] = $labeltoshow;
8191 } else {
8192 if (!$notrans) {
8193 $translabel = $langs->trans($obj->{$InfoFieldList[1]});
8194 if ($translabel != $obj->{$InfoFieldList[1]}) {
8195 $labeltoshow = dol_trunc($translabel, 18);
8196 } else {
8197 $labeltoshow = dol_trunc($obj->{$InfoFieldList[1]}, 18);
8198 }
8199 }
8200 if (empty($labeltoshow)) {
8201 $labeltoshow = '(not defined)';
8202 }
8203
8204 if (is_array($value_arr) && in_array($obj->rowid, $value_arr)) {
8205 $data[$obj->rowid] = $labeltoshow;
8206 }
8207
8208 if (!empty($InfoFieldList[3]) && $parentField) {
8209 $parent = $parentName . ':' . $obj->{$parentField};
8210 $isDependList = 1;
8211 }
8212
8213 $data[(int) $obj->rowid] = $labeltoshow;
8214 }
8215
8216 $i++;
8217 }
8218 $this->db->free($resql);
8219
8220 $out = $form->multiselectarray($keyprefix . $key . $keysuffix, $data, $value_arr, 0, 0, $morecss, 0, '100%');
8221 } else {
8222 print 'Error in request ' . $sql . ' ' . $this->db->lasterror() . '. Check setup of extra parameters.<br>';
8223 }
8224 } else {
8225 require_once DOL_DOCUMENT_ROOT.'/categories/class/categorie.class.php';
8226 $data = $form->select_all_categories(Categorie::$MAP_ID_TO_CODE[(int) $InfoFieldList[5]], '', 'parent', 64, $InfoFieldList[6], 1, 1);
8227 $out = $form->multiselectarray($keyprefix . $key . $keysuffix, $data, $value_arr, 0, 0, $morecss, 0, '100%');
8228 }
8229 }
8230 } elseif ($type == 'link') {
8231 // $param_list='ObjectName:classPath[:AddCreateButtonOrNot[:Filter[:Sortfield]]]'
8232 // Filter can contains some ':' inside.
8233 $param_list = array_keys($param['options']);
8234 $param_list_array = explode(':', $param_list[0], 4);
8235
8236 $showempty = (($required && $default != '') ? 0 : 1);
8237
8238 if (!preg_match('/search_/', $keyprefix)) {
8239 if (!empty($param_list_array[2])) { // If the entry into $fields is set to add a create button
8240 // @phan-suppress-next-line PhanTypeMismatchProperty
8241 if (!empty($this->fields[$key]['picto'])) {
8242 $morecss .= ' widthcentpercentminusxx';
8243 } else {
8244 $morecss .= ' widthcentpercentminusx';
8245 }
8246 } else {
8247 // @phan-suppress-next-line PhanTypeMismatchProperty
8248 if (!empty($this->fields[$key]['picto'])) {
8249 $morecss .= ' widthcentpercentminusx';
8250 }
8251 }
8252 }
8253 $objectfield = $this->element.($this->module ? '@'.$this->module : '').':'.$key.$keysuffix;
8254 $out = $form->selectForForms($param_list_array[0], $keyprefix.$key.$keysuffix, $value, $showempty, '', '', $morecss, $moreparam, 0, (empty($val['disabled']) ? 0 : 1), '', $objectfield);
8255
8256 if (!empty($param_list_array[2])) { // If the entry into $fields is set, we must add a create button
8257 if ((!GETPOSTISSET('backtopage') || strpos(GETPOST('backtopage'), $_SERVER['PHP_SELF']) === 0) // // To avoid to open several times the 'Plus' button (we accept only one level)
8258 && empty($val['disabled']) && empty($nonewbutton)) { // and to avoid to show the button if the field is protected by a "disabled".
8259 list($class, $classfile) = explode(':', $param_list[0]);
8260 if (file_exists(dol_buildpath(dirname(dirname($classfile)).'/card.php'))) {
8261 $url_path = dol_buildpath(dirname(dirname($classfile)).'/card.php', 1);
8262 } else {
8263 $url_path = dol_buildpath(dirname(dirname($classfile)).'/'.strtolower($class).'_card.php', 1);
8264 }
8265 $paramforthenewlink = '';
8266 $paramforthenewlink .= (GETPOSTISSET('action') ? '&action='.GETPOST('action', 'aZ09') : '');
8267 $paramforthenewlink .= (GETPOSTISSET('id') ? '&id='.GETPOSTINT('id') : '');
8268 $paramforthenewlink .= (GETPOSTISSET('origin') ? '&origin='.GETPOST('origin', 'aZ09') : '');
8269 $paramforthenewlink .= (GETPOSTISSET('originid') ? '&originid='.GETPOSTINT('originid') : '');
8270 $paramforthenewlink .= '&fk_'.strtolower($class).'=--IDFORBACKTOPAGE--';
8271 // TODO Add JavaScript code to add input fields already filled into $paramforthenewlink so we won't loose them when going back to main page
8272 $out .= '<a class="butActionNew" title="'.$langs->trans("New").'" href="'.$url_path.'?action=create&backtopage='.urlencode($_SERVER['PHP_SELF'].($paramforthenewlink ? '?'.$paramforthenewlink : '')).'"><span class="fa fa-plus-circle valignmiddle"></span></a>';
8273 }
8274 }
8275 } elseif ($type == 'password') {
8276 // If prefix is 'search_', field is used as a filter, we use a common text field.
8277 if ($keyprefix.$key.$keysuffix == 'pass_crypted') {
8278 $out = '<input type="'.($keyprefix == 'search_' ? 'text' : 'password').'" class="flat '.$morecss.'" name="pass" id="pass" value="" '.($moreparam ? $moreparam : '').'>';
8279 $out .= '<input type="hidden" name="pass_crypted" id="pass_crypted" value="'.$value.'" '.($moreparam ? $moreparam : '').'>';
8280 } else {
8281 $out = '<input type="'.($keyprefix == 'search_' ? 'text' : 'password').'" class="flat '.$morecss.'" name="'.$keyprefix.$key.$keysuffix.'" id="'.$keyprefix.$key.$keysuffix.'" value="'.$value.'" '.($moreparam ? $moreparam : '').'>';
8282 }
8283 } elseif ($type == 'array') {
8284 $newval = $val;
8285 $newval['type'] = 'varchar(256)';
8286
8287 $out = '';
8288 if (!empty($value)) {
8289 foreach ($value as $option) {
8290 $out .= '<span><a class="'.dol_escape_htmltag($keyprefix.$key.$keysuffix).'_del" href="javascript:;"><span class="fa fa-minus-circle valignmiddle"></span></a> ';
8291 $out .= $this->showInputField($newval, $keyprefix.$key.$keysuffix.'[]', $option, $moreparam, '', '', $morecss).'<br></span>';
8292 }
8293 }
8294 $out .= '<a id="'.dol_escape_htmltag($keyprefix.$key.$keysuffix).'_add" href="javascript:;"><span class="fa fa-plus-circle valignmiddle"></span></a>';
8295
8296 $newInput = '<span><a class="'.dol_escape_htmltag($keyprefix.$key.$keysuffix).'_del" href="javascript:;"><span class="fa fa-minus-circle valignmiddle"></span></a> ';
8297 $newInput .= $this->showInputField($newval, $keyprefix.$key.$keysuffix.'[]', '', $moreparam, '', '', $morecss).'<br></span>';
8298
8299 if (!empty($conf->use_javascript_ajax)) {
8300 $out .= '
8301 <script nonce="'.getNonce().'">
8302 $(document).ready(function() {
8303 $("a#'.dol_escape_js($keyprefix.$key.$keysuffix).'_add").click(function() {
8304 $("'.dol_escape_js($newInput).'").insertBefore(this);
8305 });
8306
8307 $(document).on("click", "a.'.dol_escape_js($keyprefix.$key.$keysuffix).'_del", function() {
8308 $(this).parent().remove();
8309 });
8310 });
8311 </script>';
8312 }
8313 }
8314 if (!empty($hidden)) {
8315 $out = '<input type="hidden" value="'.$value.'" name="'.$keyprefix.$key.$keysuffix.'" id="'.$keyprefix.$key.$keysuffix.'"/>';
8316 }
8317
8318 if ($isDependList == 1) {
8319 $out .= $this->getJSListDependancies('_common');
8320 }
8321 /* Add comments
8322 if ($type == 'date') $out.=' (YYYY-MM-DD)';
8323 elseif ($type == 'datetime') $out.=' (YYYY-MM-DD HH:MM:SS)';
8324 */
8325
8326 // Display error message for field
8327 if (!empty($fieldValidationErrorMsg) && function_exists('getFieldErrorIcon')) {
8328 $out .= ' '.getFieldErrorIcon($fieldValidationErrorMsg);
8329 }
8330
8331 return $out;
8332 }
8333
8347 public function showOutputField($val, $key, $value, $moreparam = '', $keysuffix = '', $keyprefix = '', $morecss = '')
8348 {
8349 global $conf, $langs, $form;
8350
8351 // TODO pass the current object as a parameter to give more flexibility (like disable ajax update when canAlwaysBeEdited is false and $object->status is not draft...)
8352
8353 if (!is_object($form)) {
8354 require_once DOL_DOCUMENT_ROOT.'/core/class/html.form.class.php';
8355 $form = new Form($this->db);
8356 }
8357
8358 //$label = empty($val['label']) ? '' : $val['label'];
8359 $type = empty($val['type']) ? '' : $val['type'];
8360 $size = empty($val['css']) ? '' : $val['css'];
8361 $reg = array();
8362
8363 // Convert var to be able to share same code than showOutputField of extrafields
8364 if (preg_match('/varchar\‍((\d+)\‍)/', $type, $reg)) {
8365 $type = 'varchar'; // convert varchar(xx) int varchar
8366 $size = $reg[1];
8367 } elseif (preg_match('/varchar/', $type)) {
8368 $type = 'varchar'; // convert varchar(xx) int varchar
8369 }
8370 if (!empty($val['arrayofkeyval']) && is_array($val['arrayofkeyval'])) {
8371 // @phan-suppress-next-line PhanTypeMismatchProperty
8372 if (empty($this->fields[$key]['multiinput'])) {
8373 $type = (($this->fields[$key]['type'] == 'checkbox') ? $this->fields[$key]['type'] : 'select');
8374 }
8375 }
8376 if (preg_match('/^integer:(.*):(.*)/i', $val['type'], $reg)) {
8377 $type = 'link';
8378 }
8379
8380 $default = empty($val['default']) ? '' : $val['default'];
8381 $computed = empty($val['computed']) ? '' : $val['computed'];
8382 $unique = empty($val['unique']) ? '' : $val['unique'];
8383 $required = empty($val['required']) ? '' : $val['required'];
8384 $param = array();
8385 $param['options'] = array();
8386
8387 if (!empty($val['arrayofkeyval']) && is_array($val['arrayofkeyval'])) {
8388 $param['options'] = $val['arrayofkeyval'];
8389 }
8390 if (preg_match('/^integer:([^:]*):([^:]*)/i', $val['type'], $reg)) { // ex: integer:User:user/class/user.class.php
8391 $type = 'link';
8392 $stringforoptions = $reg[1].':'.$reg[2];
8393 // Special case: Force addition of getnomurlparam1 to -1 for users
8394 if ($reg[1] == 'User') {
8395 $stringforoptions .= ':#getnomurlparam1=-1';
8396 }
8397 $param['options'] = array($stringforoptions => $stringforoptions);
8398 } elseif (preg_match('/^sellist:(.*):(.*):(.*):(.*)/i', $val['type'], $reg)) {
8399 $param['options'] = array($reg[1].':'.$reg[2].':'.$reg[3].':'.$reg[4] => 'N');
8400 $type = 'sellist';
8401 } elseif (preg_match('/^sellist:(.*):(.*):(.*)/i', $val['type'], $reg)) {
8402 $param['options'] = array($reg[1].':'.$reg[2].':'.$reg[3] => 'N');
8403 $type = 'sellist';
8404 } elseif (preg_match('/^sellist:(.*):(.*)/i', $val['type'], $reg)) {
8405 $param['options'] = array($reg[1].':'.$reg[2] => 'N');
8406 $type = 'sellist';
8407 } elseif (preg_match('/^chkbxlst:(.*)/i', $val['type'], $reg)) {
8408 $param['options'] = array($reg[1] => 'N');
8409 $type = 'chkbxlst';
8410 } elseif (preg_match('/stars\‍((\d+)\‍)/', $val['type'], $reg)) {
8411 $param['options'] = array();
8412 $type = 'stars';
8413 $size = $reg[1];
8414 }
8415
8416 $langfile = empty($val['langfile']) ? '' : $val['langfile'];
8417 $list = (empty($val['list']) ? '' : $val['list']);
8418 $help = (empty($val['help']) ? '' : $val['help']);
8419 $hidden = (($val['visible'] == 0) ? 1 : 0); // If zero, we are sure it is hidden, otherwise we show. If it depends on mode (view/create/edit form or list, this must be filtered by caller)
8420
8421 if ($hidden) {
8422 return '';
8423 }
8424
8425 // If field is a computed field, value must become result of compute
8426 if ($computed) {
8427 // Make the eval of compute string
8428 //var_dump($computed);
8429 $value = dol_eval($computed, 1, 0, '2');
8430 }
8431
8432 if (empty($morecss)) {
8433 if ($type == 'date') {
8434 $morecss = 'minwidth100imp';
8435 } elseif ($type == 'datetime' || $type == 'timestamp') {
8436 $morecss = 'minwidth200imp';
8437 } elseif (in_array($type, array('int', 'double', 'price'))) {
8438 $morecss = 'maxwidth75';
8439 } elseif ($type == 'url') {
8440 $morecss = 'minwidth400';
8441 } elseif ($type == 'boolean') {
8442 $morecss = '';
8443 } else {
8444 if (is_numeric($size) && round((float) $size) < 12) {
8445 $morecss = 'minwidth100';
8446 } elseif (is_numeric($size) && round((float) $size) <= 48) {
8447 $morecss = 'minwidth200';
8448 } else {
8449 $morecss = 'minwidth400';
8450 }
8451 }
8452 }
8453
8454 // Format output value differently according to properties of field
8455 if (in_array($key, array('rowid', 'ref')) && method_exists($this, 'getNomUrl')) {
8456 // @phan-suppress-next-line PhanTypeMismatchProperty
8457 if ($key != 'rowid' || empty($this->fields['ref'])) { // If we want ref field or if we want ID and there is no ref field, we show the link.
8458 $value = $this->getNomUrl(1, '', 0, '', 1);
8459 }
8460 } elseif ($key == 'status' && method_exists($this, 'getLibStatut')) {
8461 $value = $this->getLibStatut(3);
8462 } elseif ($type == 'date') {
8463 if (!empty($value)) {
8464 $value = dol_print_date($value, 'day'); // We suppose dates without time are always gmt (storage of course + output)
8465 } else {
8466 $value = '';
8467 }
8468 } elseif ($type == 'datetime' || $type == 'timestamp') {
8469 if (!empty($value)) {
8470 $value = dol_print_date($value, 'dayhour', 'tzuserrel');
8471 } else {
8472 $value = '';
8473 }
8474 } elseif ($type == 'duration') {
8475 include_once DOL_DOCUMENT_ROOT.'/core/lib/date.lib.php';
8476 if (!is_null($value) && $value !== '') {
8477 $value = convertSecondToTime((int) $value, 'allhourmin');
8478 }
8479 } elseif ($type == 'double' || $type == 'real') {
8480 if (!is_null($value) && $value !== '') {
8481 $value = price($value);
8482 }
8483 } elseif ($type == 'boolean') {
8484 $checked = '';
8485 if (!empty($value)) {
8486 $checked = ' checked ';
8487 }
8488 if (getDolGlobalInt('MAIN_OPTIMIZEFORTEXTBROWSER') < 2) {
8489 $value = '<input type="checkbox" '.$checked.' '.($moreparam ? $moreparam : '').' readonly disabled>';
8490 } else {
8491 $value = yn($value ? 1 : 0);
8492 }
8493 } elseif ($type == 'mail' || $type == 'email') {
8494 $value = dol_print_email($value, 0, 0, 0, 64, 1, 1);
8495 } elseif ($type == 'url') {
8496 $value = dol_print_url($value, '_blank', 32, 1);
8497 } elseif ($type == 'phone') {
8498 $value = dol_print_phone($value, '', 0, 0, '', '&nbsp;', 'phone');
8499 } elseif ($type == 'ip') {
8500 $value = dol_print_ip($value, 0);
8501 } elseif ($type == 'stars') {
8502 $value = '<input type="hidden" class="flat '.$morecss.'" name="'.$keyprefix.$key.$keysuffix.'" id="'.$keyprefix.$key.$keysuffix.$this->id.'" value="'.dol_escape_htmltag($value).'"'.($moreparam ? $moreparam : '').'>';
8503 $value .= '<div class="star-selection" id="'.$keyprefix.$key.$keysuffix.$this->id.'_selection">';
8504 $i = 1;
8505 while ($i <= $size) {
8506 $value .= '<span class="star" data-value="'.$i.'">'.img_picto('', 'fontawesome_star_fas').'</span>';
8507 $i++;
8508 }
8509 $value .= '</div>';
8510 $value .= '<script>
8511 $(document).ready(function() {
8512 let container = $("#'.$keyprefix.$key.$keysuffix.$this->id.'_selection");
8513 let selectedStars = parseInt($("#'.$keyprefix.$key.$keysuffix.$this->id.'").val()) || 0;
8514 container.find(".star").each(function() {
8515 $(this).toggleClass("active", $(this).data("value") <= selectedStars);
8516 });
8517 container.find(".star").on("mouseover", function() {
8518 let selectedStar = $(this).data("value");
8519 container.find(".star").each(function() {
8520 $(this).toggleClass("active", $(this).data("value") <= selectedStar);
8521 });
8522 });
8523 container.on("mouseout", function() {
8524 container.find(".star").each(function() {
8525 $(this).toggleClass("active", $(this).data("value") <= selectedStars);
8526 });
8527 });
8528 container.find(".star").off("click").on("click", function() {
8529 selectedStars = $(this).data("value");
8530 if (selectedStars == 1 && $("#'.$keyprefix.$key.$keysuffix.$this->id.'").val() == 1) {
8531 selectedStars = 0;
8532 }
8533 container.find("#'.$keyprefix.$key.$keysuffix.$this->id.'").val(selectedStars);
8534 container.find(".star").each(function() {
8535 $(this).toggleClass("active", $(this).data("value") <= selectedStars);
8536 });
8537 $.ajax({
8538 url: "ajax/'.$this->element.'.php",
8539 method: "POST",
8540 data: {
8541 objectId: "'.$this->id.'",
8542 field: "'.$keyprefix.$key.$keysuffix.'",
8543 value: selectedStars,
8544 token: "'.newToken().'"
8545 },
8546 success: function(response) {
8547 var res = JSON.parse(response);
8548 console[res.status === "success" ? "log" : "error"](res.message);
8549 },
8550 error: function(xhr, status, error) {
8551 console.log("Ajax request failed while updating '.$keyprefix.$key.$keysuffix.':", error);
8552 }
8553 });
8554 });
8555 });
8556 </script>';
8557 } elseif ($type == 'price') {
8558 if (!is_null($value) && $value !== '') {
8559 $value = price($value, 0, $langs, 0, 0, -1, $conf->currency);
8560 }
8561 } elseif ($type == 'select') {
8562 $value = isset($param['options'][(string) $value]) ? $param['options'][(string) $value] : '';
8563 if (strpos($value, "|") !== false) {
8564 $value = $langs->trans(explode('|', $value)[0]);
8565 } elseif (! is_numeric($value)) {
8566 $value = $langs->trans($value);
8567 }
8568 } elseif ($type == 'sellist') {
8569 $param_list = array_keys($param['options']);
8570 $InfoFieldList = explode(":", $param_list[0]);
8571
8572 $selectkey = "rowid";
8573 $keyList = 'rowid';
8574
8575 if (count($InfoFieldList) > 2 && !empty($InfoFieldList[2])) {
8576 $selectkey = $InfoFieldList[2];
8577 $keyList = $InfoFieldList[2].' as rowid';
8578 }
8579
8580 $fields_label = explode('|', $InfoFieldList[1]);
8581 if (is_array($fields_label)) {
8582 $keyList .= ', ';
8583 $keyList .= implode(', ', $fields_label);
8584 }
8585
8586 $filter_categorie = false;
8587 if (count($InfoFieldList) > 5) {
8588 if ($InfoFieldList[0] == 'categorie') {
8589 $filter_categorie = true;
8590 }
8591 }
8592
8593 $sql = "SELECT ".$keyList;
8594 $sql .= ' FROM '.$this->db->prefix().$InfoFieldList[0];
8595 if (isset($InfoFieldList[4]) && strpos($InfoFieldList[4], 'extra') !== false) {
8596 $sql .= ' as main';
8597 }
8598 if ($selectkey == 'rowid' && empty($value)) {
8599 $sql .= " WHERE ".$selectkey." = 0";
8600 } elseif ($selectkey == 'rowid') {
8601 $sql .= " WHERE ".$selectkey." = ".((int) $value);
8602 } else {
8603 $sql .= " WHERE ".$selectkey." = '".$this->db->escape($value)."'";
8604 }
8605
8606 //$sql.= ' AND entity = '.$conf->entity;
8607
8608 dol_syslog(get_class($this).':showOutputField:$type=sellist', LOG_DEBUG);
8609 $resql = $this->db->query($sql);
8610 if ($resql) {
8611 if (!$filter_categorie) {
8612 $value = ''; // value was used, so now we reset it to use it to build final output
8613 $numrows = $this->db->num_rows($resql);
8614 if ($numrows) {
8615 $obj = $this->db->fetch_object($resql);
8616
8617 // Several field into label (eq table:code|libelle:rowid)
8618 $fields_label = explode('|', $InfoFieldList[1]);
8619
8620 if (is_array($fields_label) && count($fields_label) > 1) {
8621 foreach ($fields_label as $field_toshow) {
8622 $translabel = '';
8623 if (!empty($obj->$field_toshow)) {
8624 $translabel = $langs->trans($obj->$field_toshow);
8625 }
8626 if ($translabel != $field_toshow) {
8627 $value .= dol_trunc($translabel, 18) . ' ';
8628 } else {
8629 $value .= $obj->$field_toshow . ' ';
8630 }
8631 }
8632 } else {
8633 $translabel = '';
8634 if (!empty($obj->{$InfoFieldList[1]})) {
8635 $translabel = $langs->trans($obj->{$InfoFieldList[1]});
8636 }
8637 if ($translabel != $obj->{$InfoFieldList[1]}) {
8638 $value = dol_trunc($translabel, 18);
8639 } else {
8640 $value = $obj->{$InfoFieldList[1]};
8641 }
8642 }
8643 }
8644 } else {
8645 require_once DOL_DOCUMENT_ROOT . '/categories/class/categorie.class.php';
8646
8647 $toprint = array();
8648 $obj = $this->db->fetch_object($resql);
8649 $c = new Categorie($this->db);
8650 $c->fetch($obj->rowid);
8651 $ways = $c->print_all_ways(); // $ways[0] = "ccc2 >> ccc2a >> ccc2a1" with html formatted text
8652 foreach ($ways as $way) {
8653 $toprint[] = '<li class="select2-search-choice-dolibarr noborderoncategories"' . ($c->color ? ' style="background: #' . $c->color . ';"' : ' style="background: #aaa"') . '>' . img_object('', 'category') . ' ' . $way . '</li>';
8654 }
8655 $value = '<div class="select2-container-multi-dolibarr" style="width: 90%;"><ul class="select2-choices-dolibarr">'.implode(' ', $toprint).'</ul></div>';
8656 }
8657 } else {
8658 dol_syslog(get_class($this).'::showOutputField error '.$this->db->lasterror(), LOG_WARNING);
8659 }
8660 } elseif ($type == 'radio') {
8661 $value = $param['options'][(string) $value];
8662 } elseif ($type == 'checkbox') {
8663 $value_arr = explode(',', (string) $value);
8664 $value = '';
8665 if (is_array($value_arr) && count($value_arr) > 0) {
8666 $toprint = array();
8667 foreach ($value_arr as $keyval => $valueval) {
8668 if (!empty($valueval)) {
8669 $toprint[] = '<li class="select2-search-choice-dolibarr noborderoncategories" style="background: #bbb">' . $param['options'][$valueval] . '</li>';
8670 }
8671 }
8672 if (!empty($toprint)) {
8673 $value = '<div class="select2-container-multi-dolibarr" style="width: 90%;"><ul class="select2-choices-dolibarr">' . implode(' ', $toprint) . '</ul></div>';
8674 }
8675 }
8676 } elseif ($type == 'chkbxlst') {
8677 $value_arr = (isset($value) ? explode(',', $value) : array());
8678
8679 $param_list = array_keys($param['options']);
8680 $InfoFieldList = explode(":", $param_list[0]);
8681
8682 $selectkey = "rowid";
8683 $keyList = 'rowid';
8684
8685 if (count($InfoFieldList) >= 3) {
8686 $selectkey = $InfoFieldList[2];
8687 $keyList = $InfoFieldList[2].' as rowid';
8688 }
8689
8690 $fields_label = explode('|', $InfoFieldList[1]);
8691 if (is_array($fields_label)) {
8692 $keyList .= ', ';
8693 $keyList .= implode(', ', $fields_label);
8694 }
8695
8696 $filter_categorie = false;
8697 if (count($InfoFieldList) > 5) {
8698 if ($InfoFieldList[0] == 'categorie') {
8699 $filter_categorie = true;
8700 }
8701 }
8702
8703 $sql = "SELECT ".$keyList;
8704 $sql .= ' FROM '.$this->db->prefix().$InfoFieldList[0];
8705 if (isset($InfoFieldList[4]) && strpos($InfoFieldList[4], 'extra') !== false) {
8706 $sql .= ' as main';
8707 }
8708 // $sql.= " WHERE ".$selectkey."='".$this->db->escape($value)."'";
8709 // $sql.= ' AND entity = '.$conf->entity;
8710
8711 dol_syslog(get_class($this).':showOutputField:$type=chkbxlst', LOG_DEBUG);
8712 $resql = $this->db->query($sql);
8713 if ($resql) {
8714 if (!$filter_categorie) {
8715 $value = ''; // value was used, so now we reset it to use it to build final output
8716 $toprint = array();
8717 while ($obj = $this->db->fetch_object($resql)) {
8718 // Several field into label (eq table:code|libelle:rowid)
8719 $fields_label = explode('|', $InfoFieldList[1]);
8720 if (is_array($value_arr) && in_array($obj->rowid, $value_arr)) {
8721 if (is_array($fields_label) && count($fields_label) > 1) {
8722 foreach ($fields_label as $field_toshow) {
8723 $translabel = '';
8724 if (!empty($obj->$field_toshow)) {
8725 $translabel = $langs->trans($obj->$field_toshow);
8726 }
8727 if ($translabel != $field_toshow) {
8728 $toprint[] = '<li class="select2-search-choice-dolibarr noborderoncategories" style="background: #bbb">' . dol_trunc($translabel, 18) . '</li>';
8729 } else {
8730 $toprint[] = '<li class="select2-search-choice-dolibarr noborderoncategories" style="background: #bbb">' . $obj->$field_toshow . '</li>';
8731 }
8732 }
8733 } else {
8734 $translabel = '';
8735 if (!empty($obj->{$InfoFieldList[1]})) {
8736 $translabel = $langs->trans($obj->{$InfoFieldList[1]});
8737 }
8738 if ($translabel != $obj->{$InfoFieldList[1]}) {
8739 $toprint[] = '<li class="select2-search-choice-dolibarr noborderoncategories" style="background: #bbb">' . dol_trunc($translabel, 18) . '</li>';
8740 } else {
8741 $toprint[] = '<li class="select2-search-choice-dolibarr noborderoncategories" style="background: #bbb">' . $obj->{$InfoFieldList[1]} . '</li>';
8742 }
8743 }
8744 }
8745 }
8746 } else {
8747 require_once DOL_DOCUMENT_ROOT . '/categories/class/categorie.class.php';
8748
8749 $toprint = array();
8750 while ($obj = $this->db->fetch_object($resql)) {
8751 if (is_array($value_arr) && in_array($obj->rowid, $value_arr)) {
8752 $c = new Categorie($this->db);
8753 $c->fetch($obj->rowid);
8754 $ways = $c->print_all_ways(); // $ways[0] = "ccc2 >> ccc2a >> ccc2a1" with html formatted text
8755 foreach ($ways as $way) {
8756 $toprint[] = '<li class="select2-search-choice-dolibarr noborderoncategories"' . ($c->color ? ' style="background: #' . $c->color . ';"' : ' style="background: #aaa"') . '>' . img_object('', 'category') . ' ' . $way . '</li>';
8757 }
8758 }
8759 }
8760 }
8761 $value = '<div class="select2-container-multi-dolibarr" style="width: 90%;"><ul class="select2-choices-dolibarr">'.implode(' ', $toprint).'</ul></div>';
8762 } else {
8763 dol_syslog(get_class($this).'::showOutputField error '.$this->db->lasterror(), LOG_WARNING);
8764 }
8765 } elseif ($type == 'link') {
8766 $out = '';
8767
8768 // only if something to display (perf)
8769 if ($value) {
8770 $param_list = array_keys($param['options']);
8771 // Example: $param_list='ObjectClass:PathToClass[:AddCreateButtonOrNot[:Filter[:Sortfield]]]'
8772 // Example: $param_list='ObjectClass:PathToClass:#getnomurlparam1=-1#getnomurlparam2=customer'
8773
8774 $InfoFieldList = explode(":", $param_list[0]);
8775
8776 $classname = $InfoFieldList[0];
8777 $classpath = $InfoFieldList[1];
8778
8779 // Set $getnomurlparam1 et getnomurlparam2
8780 $getnomurlparam = 3;
8781 $getnomurlparam2 = '';
8782 $regtmp = array();
8783 if (preg_match('/#getnomurlparam1=([^#]*)/', $param_list[0], $regtmp)) {
8784 $getnomurlparam = $regtmp[1];
8785 }
8786 if (preg_match('/#getnomurlparam2=([^#]*)/', $param_list[0], $regtmp)) {
8787 $getnomurlparam2 = $regtmp[1];
8788 }
8789
8790 if (!empty($classpath)) {
8791 dol_include_once($InfoFieldList[1]);
8792
8793 if ($classname && !class_exists($classname)) {
8794 // from V19 of Dolibarr, In some cases link use element instead of class, example project_task
8795 // TODO use newObjectByElement() introduce in V20 by PR #30036 for better errors management
8796 $element_prop = getElementProperties($classname);
8797 if ($element_prop) {
8798 $classname = $element_prop['classname'];
8799 }
8800 }
8801
8802
8803 if ($classname && class_exists($classname)) {
8804 $object = new $classname($this->db);
8805 '@phan-var-force CommonObject $object';
8806 if ($object->element === 'product') { // Special case for product because default valut of fetch are wrong
8807 '@phan-var-force Product $object';
8808 $result = $object->fetch($value, '', '', '', 0, 1, 1);
8809 } else {
8810 $result = $object->fetch($value);
8811 }
8812 if ($result > 0) {
8813 if ($object->element === 'product') {
8814 '@phan-var-force Product $object';
8815 $get_name_url_param_arr = array($getnomurlparam, $getnomurlparam2, 0, -1, 0, '', 0);
8816 if (isset($val['get_name_url_params'])) {
8817 $get_name_url_params = explode(':', $val['get_name_url_params']);
8818 if (!empty($get_name_url_params)) {
8819 $param_num_max = count($get_name_url_param_arr) - 1;
8820 foreach ($get_name_url_params as $param_num => $param_value) {
8821 if ($param_num > $param_num_max) {
8822 break;
8823 }
8824 $get_name_url_param_arr[$param_num] = $param_value;
8825 }
8826 }
8827 }
8828
8832 $value = $object->getNomUrl($get_name_url_param_arr[0], $get_name_url_param_arr[1], $get_name_url_param_arr[2], $get_name_url_param_arr[3], $get_name_url_param_arr[4], $get_name_url_param_arr[5], $get_name_url_param_arr[6]);
8833 } else {
8834 $value = $object->getNomUrl($getnomurlparam, $getnomurlparam2);
8835 }
8836 } else {
8837 $value = '';
8838 }
8839 }
8840 } else {
8841 dol_syslog('Error bad setup of extrafield', LOG_WARNING);
8842 return 'Error bad setup of extrafield';
8843 }
8844 } else {
8845 $value = '';
8846 }
8847 } elseif ($type == 'password') {
8848 $value = '<span class="opacitymedium">'.$langs->trans("Encrypted").'</span>';
8849 //$value = preg_replace('/./i', '*', $value);
8850 } elseif ($type == 'array') {
8851 if (is_array($value)) {
8852 $value = implode('<br>', $value);
8853 } else {
8854 dol_syslog(__METHOD__.' Expected array from dol_eval, but got '.gettype($value), LOG_ERR);
8855 return 'Error unexpected result from code evaluation';
8856 }
8857 } else { // text|html|varchar
8858 if (!empty($value) && preg_match('/^text/', (string) $type) && !preg_match('/search_/', $keyprefix) && !empty($param['options'])) {
8859 $value = str_replace(',', "\n", $value);
8860 }
8861 $value = dol_htmlentitiesbr($value);
8862 }
8863
8864 //print $type.'-'.$size.'-'.$value;
8865 $out = $value;
8866
8867 return is_null($out) ? '' : $out;
8868 }
8869
8876 public function clearFieldError($fieldKey)
8877 {
8878 $this->error = '';
8879 unset($this->validateFieldsErrors[$fieldKey]);
8880 }
8881
8889 public function setFieldError($fieldKey, $msg = '')
8890 {
8891 global $langs;
8892 if (empty($msg)) {
8893 $msg = $langs->trans("UnknownError");
8894 }
8895
8896 $this->error = $this->validateFieldsErrors[$fieldKey] = $msg;
8897 }
8898
8905 public function getFieldError($fieldKey)
8906 {
8907 if (!empty($this->validateFieldsErrors[$fieldKey])) {
8908 return $this->validateFieldsErrors[$fieldKey];
8909 }
8910 return '';
8911 }
8912
8921 public function validateField($fields, $fieldKey, $fieldValue)
8922 {
8923 global $langs;
8924
8925 if (!class_exists('Validate')) {
8926 require_once DOL_DOCUMENT_ROOT . '/core/class/validate.class.php';
8927 }
8928
8929 $this->clearFieldError($fieldKey);
8930
8931 if (!array_key_exists($fieldKey, $fields) || !is_array($fields[$fieldKey])) {
8932 $this->setFieldError($fieldKey, $langs->trans('FieldNotFoundInObject'));
8933 return false;
8934 }
8935
8936 $val = $fields[$fieldKey];
8937
8938 $param = array();
8939 $param['options'] = array();
8940 $type = $val['type'];
8941
8942 $required = false;
8943 if (isset($val['notnull']) && $val['notnull'] === 1) {
8944 // 'notnull' is set to 1 if not null in database. Set to -1 if we must set data to null if empty ('' or 0).
8945 $required = true;
8946 }
8947
8948 $maxSize = 0;
8949 $minSize = 0;
8950
8951 //
8952 // PREPARE Elements
8953 //
8954 $reg = array();
8955
8956 // Convert var to be able to share same code than showOutputField of extrafields
8957 if (preg_match('/varchar\‍((\d+)\‍)/', $type, $reg)) {
8958 $type = 'varchar'; // convert varchar(xx) int varchar
8959 $maxSize = $reg[1];
8960 } elseif (preg_match('/varchar/', $type)) {
8961 $type = 'varchar'; // convert varchar(xx) int varchar
8962 }
8963
8964 if (!empty($val['arrayofkeyval']) && is_array($val['arrayofkeyval'])) {
8965 $type = 'select';
8966 }
8967
8968 if (!empty($val['type']) && preg_match('/^integer:(.*):(.*)/i', $val['type'], $reg)) {
8969 $type = 'link';
8970 }
8971
8972 if (!empty($val['arrayofkeyval']) && is_array($val['arrayofkeyval'])) {
8973 $param['options'] = $val['arrayofkeyval'];
8974 }
8975
8976 if (preg_match('/^integer:(.*):(.*)/i', $val['type'], $reg)) {
8977 $type = 'link';
8978 $param['options'] = array($reg[1].':'.$reg[2] => $reg[1].':'.$reg[2]);
8979 } elseif (preg_match('/^sellist:(.*):(.*):(.*):(.*)/i', $val['type'], $reg)) {
8980 $param['options'] = array($reg[1].':'.$reg[2].':'.$reg[3].':'.$reg[4] => 'N');
8981 $type = 'sellist';
8982 } elseif (preg_match('/^sellist:(.*):(.*):(.*)/i', $val['type'], $reg)) {
8983 $param['options'] = array($reg[1].':'.$reg[2].':'.$reg[3] => 'N');
8984 $type = 'sellist';
8985 } elseif (preg_match('/^sellist:(.*):(.*)/i', $val['type'], $reg)) {
8986 $param['options'] = array($reg[1].':'.$reg[2] => 'N');
8987 $type = 'sellist';
8988 }
8989
8990 //
8991 // TEST Value
8992 //
8993
8994 // Use Validate class to allow external Modules to use data validation part instead of concentrate all test here (factoring) or just for reuse
8995 $validate = new Validate($this->db, $langs);
8996
8997
8998 // little trick : to perform tests with good performances sort tests by quick to low
8999
9000 //
9001 // COMMON TESTS
9002 //
9003
9004 // Required test and empty value
9005 if ($required && !$validate->isNotEmptyString($fieldValue)) {
9006 $this->setFieldError($fieldKey, $validate->error);
9007 return false;
9008 } elseif (!$required && !$validate->isNotEmptyString($fieldValue)) {
9009 // if no value sent and the field is not mandatory, no need to perform tests
9010 return true;
9011 }
9012
9013 // MAX Size test
9014 if (!empty($maxSize) && !$validate->isMaxLength($fieldValue, $maxSize)) {
9015 $this->setFieldError($fieldKey, $validate->error);
9016 return false;
9017 }
9018
9019 // MIN Size test
9020 if (!empty($minSize) && !$validate->isMinLength($fieldValue, $minSize)) {
9021 $this->setFieldError($fieldKey, $validate->error);
9022 return false;
9023 }
9024
9025 //
9026 // TESTS for TYPE
9027 //
9028
9029 if (in_array($type, array('date', 'datetime', 'timestamp'))) {
9030 if (!$validate->isTimestamp($fieldValue)) {
9031 $this->setFieldError($fieldKey, $validate->error);
9032 return false;
9033 } else {
9034 return true;
9035 }
9036 } elseif ($type == 'duration') {
9037 if (!$validate->isDuration($fieldValue)) {
9038 $this->setFieldError($fieldKey, $validate->error);
9039 return false;
9040 } else {
9041 return true;
9042 }
9043 } elseif (in_array($type, array('double', 'real', 'price'))) {
9044 // is numeric
9045 if (!$validate->isNumeric($fieldValue)) {
9046 $this->setFieldError($fieldKey, $validate->error);
9047 return false;
9048 } else {
9049 return true;
9050 }
9051 } elseif ($type == 'boolean') {
9052 if (!$validate->isBool($fieldValue)) {
9053 $this->setFieldError($fieldKey, $validate->error);
9054 return false;
9055 } else {
9056 return true;
9057 }
9058 } elseif ($type == 'mail') {
9059 if (!$validate->isEmail($fieldValue)) {
9060 $this->setFieldError($fieldKey, $validate->error);
9061 return false;
9062 }
9063 } elseif ($type == 'url') {
9064 if (!$validate->isUrl($fieldValue)) {
9065 $this->setFieldError($fieldKey, $validate->error);
9066 return false;
9067 } else {
9068 return true;
9069 }
9070 } elseif ($type == 'phone') {
9071 if (!$validate->isPhone($fieldValue)) {
9072 $this->setFieldError($fieldKey, $validate->error);
9073 return false;
9074 } else {
9075 return true;
9076 }
9077 } elseif ($type == 'select' || $type == 'radio') {
9078 if (!isset($param['options'][$fieldValue])) {
9079 $this->error = $langs->trans('RequireValidValue');
9080 return false;
9081 } else {
9082 return true;
9083 }
9084 } elseif ($type == 'sellist' || $type == 'chkbxlst') {
9085 $param_list = array_keys($param['options']);
9086 $InfoFieldList = explode(":", $param_list[0]);
9087 $value_arr = explode(',', $fieldValue);
9088 $value_arr = array_map(array($this->db, 'escape'), $value_arr);
9089
9090 $selectkey = "rowid";
9091 if (count($InfoFieldList) > 4 && !empty($InfoFieldList[4])) {
9092 $selectkey = $InfoFieldList[2];
9093 }
9094
9095 if (!$validate->isInDb($value_arr, $InfoFieldList[0], $selectkey)) {
9096 $this->setFieldError($fieldKey, $validate->error);
9097 return false;
9098 } else {
9099 return true;
9100 }
9101 } elseif ($type == 'link') {
9102 $param_list = array_keys($param['options']); // $param_list='ObjectName:classPath'
9103 $InfoFieldList = explode(":", $param_list[0]);
9104 $classname = $InfoFieldList[0];
9105 $classpath = $InfoFieldList[1];
9106 if (!$validate->isFetchable($fieldValue, $classname, $classpath)) {
9107 $lastIsFetchableError = $validate->error;
9108
9109 // from V19 of Dolibarr, In some cases link use element instead of class, example project_task
9110 if ($validate->isFetchableElement($fieldValue, $classname)) {
9111 return true;
9112 }
9113
9114 $this->setFieldError($fieldKey, $lastIsFetchableError);
9115 return false;
9116 } else {
9117 return true;
9118 }
9119 }
9120
9121 // if no test failed all is ok
9122 return true;
9123 }
9124
9138 public function showOptionals($extrafields, $mode = 'view', $params = null, $keysuffix = '', $keyprefix = '', $onetrtd = '', $display_type = 'card')
9139 {
9140 global $db, $conf, $langs, $action, $form, $hookmanager;
9141
9142 if (!is_object($form)) {
9143 $form = new Form($db);
9144 }
9145 if (!is_object($extrafields)) {
9146 dol_syslog('Bad parameter extrafields for showOptionals', LOG_ERR);
9147 return 'Bad parameter extrafields for showOptionals';
9148 }
9149 if (!is_array($extrafields->attributes[$this->table_element])) {
9150 dol_syslog("extrafields->attributes was not loaded with extrafields->fetch_name_optionals_label(table_element);", LOG_WARNING);
9151 }
9152
9153 $out = '';
9154
9155 $parameters = array('mode' => $mode, 'params' => $params, 'keysuffix' => $keysuffix, 'keyprefix' => $keyprefix, 'display_type' => $display_type);
9156 $reshook = $hookmanager->executeHooks('showOptionals', $parameters, $this, $action); // Note that $action and $object may have been modified by hook
9157
9158 if (empty($reshook)) {
9159 if (is_array($extrafields->attributes[$this->table_element]) && array_key_exists('label', $extrafields->attributes[$this->table_element]) && is_array($extrafields->attributes[$this->table_element]['label']) && count($extrafields->attributes[$this->table_element]['label']) > 0) {
9160 $out .= "\n";
9161 $out .= '<!-- commonobject:showOptionals --> ';
9162 $out .= "\n";
9163
9164 $nbofextrafieldsshown = 0;
9165 $e = 0; // var to manage the modulo (odd/even)
9166
9167 $lastseparatorkeyfound = '';
9168 $extrafields_collapse_num = '';
9169 $extrafields_collapse_num_old = '';
9170 $i = 0;
9171
9172 foreach ($extrafields->attributes[$this->table_element]['label'] as $key => $label) {
9173 $i++;
9174
9175 // Show only the key field in params @phan-suppress-next-line PhanTypeArraySuspiciousNullable
9176 if (is_array($params) && array_key_exists('onlykey', $params) && $key != $params['onlykey']) {
9177 continue;
9178 }
9179
9180 // Test on 'enabled' ('enabled' is different than 'list' = 'visibility')
9181 $enabled = 1;
9182 if ($enabled && isset($extrafields->attributes[$this->table_element]['enabled'][$key])) {
9183 $enabled = (int) dol_eval((string) $extrafields->attributes[$this->table_element]['enabled'][$key], 1, 1, '2');
9184 }
9185 if (empty($enabled)) {
9186 continue;
9187 }
9188
9189 $visibility = 1;
9190 if (isset($extrafields->attributes[$this->table_element]['list'][$key])) {
9191 $visibility = (int) dol_eval($extrafields->attributes[$this->table_element]['list'][$key], 1, 1, '2');
9192 }
9193
9194 $perms = 1;
9195 if ($perms && isset($extrafields->attributes[$this->table_element]['perms'][$key])) {
9196 $perms = (int) dol_eval($extrafields->attributes[$this->table_element]['perms'][$key], 1, 1, '2');
9197 }
9198
9199 if (($mode == 'create') && !in_array(abs($visibility), array(1, 3))) {
9200 continue; // <> -1 and <> 1 and <> 3 = not visible on forms, only on list
9201 } elseif (($mode == 'edit') && !in_array(abs($visibility), array(1, 3, 4))) {
9202 continue; // <> -1 and <> 1 and <> 3 = not visible on forms, only on list and <> 4 = not visible at the creation
9203 } elseif ($mode == 'view' && empty($visibility)) {
9204 continue;
9205 }
9206 if (empty($perms)) {
9207 continue;
9208 }
9209
9210 // Load language if required
9211 if (!empty($extrafields->attributes[$this->table_element]['langfile'][$key])) {
9212 $langs->load($extrafields->attributes[$this->table_element]['langfile'][$key]);
9213 }
9214
9215 $colspan = 0;
9216 $value = null;
9217 if (is_array($params) && count($params) > 0 && $display_type == 'card') {
9218 if (array_key_exists('cols', $params)) {
9219 $colspan = $params['cols'];
9220 } elseif (array_key_exists('colspan', $params)) { // For backward compatibility. Use cols instead now.
9221 $reg = array();
9222 if (preg_match('/colspan="(\d+)"/', $params['colspan'], $reg)) {
9223 $colspan = $reg[1];
9224 } else {
9225 $colspan = $params['colspan'];
9226 }
9227 }
9228 }
9229 $colspan = intval($colspan);
9230
9231 switch ($mode) {
9232 case "view":
9233 $value = ((!empty($this->array_options) && array_key_exists("options_".$key.$keysuffix, $this->array_options)) ? $this->array_options["options_".$key.$keysuffix] : null); // Value may be cleaned or formatted later
9234 break;
9235 case "create":
9236 case "edit":
9237 // We get the value of property found with GETPOST so it takes into account:
9238 // default values overwrite, restore back to list link, ... (but not 'default value in database' of field)
9239 $check = 'alphanohtml';
9240 if (in_array($extrafields->attributes[$this->table_element]['type'][$key], array('html', 'text'))) {
9241 $check = 'restricthtml';
9242 }
9243 $getposttemp = GETPOST($keyprefix.'options_'.$key.$keysuffix, $check, 3); // GETPOST can get value from GET, POST or setup of default values overwrite.
9244 // GETPOST("options_" . $key) can be 'abc' or array(0=>'abc')
9245 if (is_array($getposttemp) || $getposttemp != '' || GETPOSTISSET($keyprefix.'options_'.$key.$keysuffix)) {
9246 if (is_array($getposttemp)) {
9247 // $getposttemp is an array but following code expects a comma separated string
9248 $value = implode(",", $getposttemp);
9249 } else {
9250 $value = $getposttemp;
9251 }
9252 } elseif (in_array($extrafields->attributes[$this->table_element]['type'][$key], array('int'))) {
9253 $value = (!empty($this->array_options["options_".$key]) || (isset($this->array_options["options_".$key]) && $this->array_options["options_".$key] === '0')) ? $this->array_options["options_".$key] : '';
9254 } else {
9255 $value = (!empty($this->array_options["options_".$key]) ? $this->array_options["options_".$key] : ''); // No GET, no POST, no default value, so we take value of object.
9256 }
9257 //var_dump($keyprefix.' - '.$key.' - '.$keysuffix.' - '.$keyprefix.'options_'.$key.$keysuffix.' - '.$this->array_options["options_".$key.$keysuffix].' - '.$getposttemp.' - '.$value);
9258 break;
9259 }
9260
9261 $nbofextrafieldsshown++;
9262
9263 // Output value of the current field
9264 if ($extrafields->attributes[$this->table_element]['type'][$key] == 'separate') {
9265 $extrafields_collapse_num = $key;
9266 /*
9267 $extrafield_param = $extrafields->attributes[$this->table_element]['param'][$key];
9268 if (!empty($extrafield_param) && is_array($extrafield_param)) {
9269 $extrafield_param_list = array_keys($extrafield_param['options']);
9270
9271 if (count($extrafield_param_list) > 0) {
9272 $extrafield_collapse_display_value = intval($extrafield_param_list[0]);
9273
9274 if ($extrafield_collapse_display_value == 1 || $extrafield_collapse_display_value == 2) {
9275 //$extrafields_collapse_num = $extrafields->attributes[$this->table_element]['pos'][$key];
9276 $extrafields_collapse_num = $key;
9277 }
9278 }
9279 }
9280 */
9281
9282 // if colspan=0 or 1, the second column is not extended, so the separator must be on 2 columns
9283 $out .= $extrafields->showSeparator($key, $this, ($colspan ? $colspan + 1 : 2), $display_type, $mode);
9284
9285 $lastseparatorkeyfound = $key;
9286 } else {
9287 $collapse_group = $extrafields_collapse_num.(!empty($this->id) ? '_'.$this->id : '');
9288
9289 $class = (!empty($extrafields->attributes[$this->table_element]['hidden'][$key]) ? 'hideobject ' : '');
9290 $csstyle = '';
9291 if (is_array($params) && count($params) > 0) {
9292 if (array_key_exists('class', $params)) {
9293 $class .= $params['class'].' ';
9294 }
9295 if (array_key_exists('style', $params)) {
9296 $csstyle = $params['style'];
9297 }
9298 }
9299
9300 // add html5 elements
9301 $domData = ' data-element="extrafield"';
9302 $domData .= ' data-targetelement="'.$this->element.'"';
9303 $domData .= ' data-targetid="'.$this->id.'"';
9304
9305 $html_id = (empty($this->id) ? '' : 'extrarow-'.$this->element.'_'.$key.'_'.$this->id);
9306 if ($display_type == 'card') {
9307 if (getDolGlobalString('MAIN_EXTRAFIELDS_USE_TWO_COLUMS') && ($e % 2) == 0) {
9308 $colspan = 0;
9309 }
9310
9311 if ($action == 'selectlines') {
9312 $colspan++;
9313 }
9314 }
9315
9316 // Convert date into timestamp format (value in memory must be a timestamp)
9317 if (in_array($extrafields->attributes[$this->table_element]['type'][$key], array('date'))) {
9318 $datenotinstring = null;
9319 if (array_key_exists('options_'.$key, $this->array_options)) {
9320 $datenotinstring = $this->array_options['options_'.$key];
9321 if (!is_numeric($this->array_options['options_'.$key])) { // For backward compatibility
9322 $datenotinstring = $this->db->jdate($datenotinstring);
9323 }
9324 }
9325 $datekey = $keyprefix.'options_'.$key.$keysuffix;
9326 $value = (GETPOSTISSET($datekey) && $this->id == GETPOST('elrowid', 'int')) ? dol_mktime(12, 0, 0, GETPOSTINT($datekey.'month', 3), GETPOSTINT($datekey.'day', 3), GETPOSTINT($datekey.'year', 3)) : $datenotinstring;
9327 }
9328 if (in_array($extrafields->attributes[$this->table_element]['type'][$key], array('datetime'))) {
9329 $datenotinstring = null;
9330 if (array_key_exists('options_'.$key, $this->array_options)) {
9331 $datenotinstring = $this->array_options['options_'.$key];
9332 if (!is_numeric($this->array_options['options_'.$key])) { // For backward compatibility
9333 $datenotinstring = $this->db->jdate($datenotinstring);
9334 }
9335 }
9336 $timekey = $keyprefix.'options_'.$key.$keysuffix;
9337 $value = (GETPOSTISSET($timekey)) ? dol_mktime(GETPOSTINT($timekey.'hour', 3), GETPOSTINT($timekey.'min', 3), GETPOSTINT($timekey.'sec', 3), GETPOSTINT($timekey.'month', 3), GETPOSTINT($timekey.'day', 3), GETPOSTINT($timekey.'year', 3), 'tzuserrel') : $datenotinstring;
9338 }
9339 // Convert float submitted string into real php numeric (value in memory must be a php numeric)
9340 if (in_array($extrafields->attributes[$this->table_element]['type'][$key], array('price', 'double'))) {
9341 if (GETPOSTISSET($keyprefix.'options_'.$key.$keysuffix) || $value) {
9342 $value = price2num($value);
9343 } elseif (isset($this->array_options['options_'.$key])) {
9344 $value = $this->array_options['options_'.$key];
9345 }
9346 }
9347
9348 // HTML, text, select, integer and varchar: take into account default value in database if in create mode
9349 if (in_array($extrafields->attributes[$this->table_element]['type'][$key], array('html', 'text', 'varchar', 'select', 'radio', 'int', 'boolean'))) {
9350 if ($action == 'create' || $mode == 'create') {
9351 $value = (GETPOSTISSET($keyprefix.'options_'.$key.$keysuffix) || $value) ? $value : $extrafields->attributes[$this->table_element]['default'][$key];
9352 }
9353 }
9354
9355 $labeltoshow = $langs->trans($label);
9356 $helptoshow = $langs->trans($extrafields->attributes[$this->table_element]['help'][$key]);
9357 if ($display_type == 'card') {
9358 $out .= '<tr '.($html_id ? 'id="'.$html_id.'" ' : '').$csstyle.' class="field_options_'.$key.' '.$class.$this->element.'_extras_'.$key.' trextrafields_collapse'.$collapse_group.'" '.$domData.' >';
9359 if (getDolGlobalString('MAIN_VIEW_LINE_NUMBER') && ($action == 'view' || $action == 'valid' || $action == 'editline' || $action == 'confirm_valid' || $action == 'confirm_cancel')) {
9360 $out .= '<td></td>';
9361 }
9362 $out .= '<td class="'.(empty($params['tdclass']) ? 'titlefieldmax45' : $params['tdclass']).' wordbreak';
9363 if ($extrafields->attributes[$this->table_element]['type'][$key] == 'text') {
9364 $out .= ' tdtop';
9365 }
9366 } elseif ($display_type == 'line') {
9367 $out .= '<div '.($html_id ? 'id="'.$html_id.'" ' : '').$csstyle.' class="fieldline_options_'.$key.' '.$class.$this->element.'_extras_'.$key.' trextrafields_collapse'.$collapse_group.'" '.$domData.' >';
9368 $out .= '<div style="display: inline-block; padding-right:4px" class="wordbreak';
9369 }
9370 //$out .= "titlefield";
9371 //if (GETPOST('action', 'restricthtml') == 'create') $out.='create';
9372 // BUG #11554 : For public page, use red dot for required fields, instead of bold label
9373 $tpl_context = isset($params["tpl_context"]) ? $params["tpl_context"] : "none";
9374 if ($tpl_context != "public") { // Public page : red dot instead of fieldrequired characters
9375 if ($mode != 'view' && !empty($extrafields->attributes[$this->table_element]['required'][$key])) {
9376 $out .= ' fieldrequired';
9377 }
9378 }
9379 $out .= '">';
9380 if ($tpl_context == "public") { // Public page : red dot instead of fieldrequired characters
9381 if (!empty($extrafields->attributes[$this->table_element]['help'][$key])) {
9382 $out .= $form->textwithpicto($labeltoshow, $helptoshow);
9383 } else {
9384 $out .= $labeltoshow;
9385 }
9386 if ($mode != 'view' && !empty($extrafields->attributes[$this->table_element]['required'][$key])) {
9387 $out .= '&nbsp;<span style="color: red">*</span>';
9388 }
9389 } else {
9390 if (!empty($extrafields->attributes[$this->table_element]['help'][$key])) {
9391 $out .= $form->textwithpicto($labeltoshow, $helptoshow);
9392 } else {
9393 $out .= $labeltoshow;
9394 }
9395 }
9396
9397 $out .= ($display_type == 'card' ? '</td>' : '</div>');
9398
9399 // Second column
9400 $html_id = !empty($this->id) ? $this->element.'_extras_'.$key.'_'.$this->id : '';
9401 if ($display_type == 'card') {
9402 // a first td column was already output (and may be another on before if MAIN_VIEW_LINE_NUMBER set), so this td is the next one
9403 $out .= '<td '.($html_id ? 'id="'.$html_id.'" ' : '').' class="valuefieldcreate '.$this->element.'_extras_'.$key;
9404 $out .= '" '.($colspan ? ' colspan="'.$colspan.'"' : '');
9405 $out .= '>';
9406 } elseif ($display_type == 'line') {
9407 $out .= '<div '.($html_id ? 'id="'.$html_id.'" ' : '').' style="display: inline-block" class="valuefieldcreate '.$this->element.'_extras_'.$key.' extra_inline_'.$extrafields->attributes[$this->table_element]['type'][$key].'">';
9408 }
9409
9410 switch ($mode) {
9411 case "view":
9412 $out .= $extrafields->showOutputField($key, $value, '', $this->table_element);
9413 break;
9414 case "create":
9415 $listoftypestoshowpicto = explode(',', getDolGlobalString('MAIN_TYPES_TO_SHOW_PICTO', 'email,phone,ip,password'));
9416 if (in_array($extrafields->attributes[$this->table_element]['type'][$key], $listoftypestoshowpicto)) {
9417 $out .= getPictoForType($extrafields->attributes[$this->table_element]['type'][$key], ($extrafields->attributes[$this->table_element]['type'][$key] == 'text' ? 'tdtop' : ''));
9418 }
9419 //$out .= '<!-- type = '.$extrafields->attributes[$this->table_element]['type'][$key].' -->';
9420 $out .= $extrafields->showInputField($key, $value, '', $keysuffix, '', 0, $this, $this->table_element);
9421 break;
9422 case "edit":
9423 $listoftypestoshowpicto = explode(',', getDolGlobalString('MAIN_TYPES_TO_SHOW_PICTO', 'email,phone,ip,password'));
9424 if (in_array($extrafields->attributes[$this->table_element]['type'][$key], $listoftypestoshowpicto)) {
9425 $out .= getPictoForType($extrafields->attributes[$this->table_element]['type'][$key], ($extrafields->attributes[$this->table_element]['type'][$key] == 'text' ? 'tdtop' : ''));
9426 }
9427 $out .= $extrafields->showInputField($key, $value, '', $keysuffix, '', '', $this, $this->table_element);
9428 break;
9429 }
9430
9431 $out .= ($display_type == 'card' ? '</td>' : '</div>');
9432 $out .= ($display_type == 'card' ? '</tr>'."\n" : '</div>');
9433 $e++;
9434 }
9435 }
9436 $out .= "\n";
9437 // Add code to manage list depending on others
9438 if (!empty($conf->use_javascript_ajax)) {
9439 $out .= $this->getJSListDependancies();
9440 }
9441
9442 $out .= '<!-- commonobject:showOptionals end --> '."\n";
9443
9444 if (empty($nbofextrafieldsshown)) {
9445 $out = '';
9446 }
9447 }
9448 }
9449
9450 $out .= $hookmanager->resPrint;
9451
9452 return $out;
9453 }
9454
9459 public function getJSListDependancies($type = '_extra')
9460 {
9461 $out = '
9462 <script nonce="'.getNonce().'">
9463 jQuery(document).ready(function() {
9464 function showOptions'.$type.'(child_list, parent_list, orig_select)
9465 {
9466 var val = $("select[name=\""+parent_list+"\"]").val();
9467 var parentVal = parent_list + ":" + val;
9468 if(typeof val == "string"){
9469 if(val != "") {
9470 var options = orig_select.find("option[parent=\""+parentVal+"\"]").clone();
9471 $("select[name=\""+child_list+"\"] option[parent]").remove();
9472 $("select[name=\""+child_list+"\"]").append(options);
9473 } else {
9474 var options = orig_select.find("option[parent]").clone();
9475 $("select[name=\""+child_list+"\"] option[parent]").remove();
9476 $("select[name=\""+child_list+"\"]").append(options);
9477 }
9478 } else if(val > 0) {
9479 var options = orig_select.find("option[parent=\""+parentVal+"\"]").clone();
9480 $("select[name=\""+child_list+"\"] option[parent]").remove();
9481 $("select[name=\""+child_list+"\"]").append(options);
9482 } else {
9483 var options = orig_select.find("option[parent]").clone();
9484 $("select[name=\""+child_list+"\"] option[parent]").remove();
9485 $("select[name=\""+child_list+"\"]").append(options);
9486 }
9487 }
9488 function setListDependencies'.$type.'() {
9489 jQuery("select option[parent]").parent().each(function() {
9490 var orig_select = {};
9491 var child_list = $(this).attr("name");
9492 orig_select[child_list] = $(this).clone();
9493 var parent = $(this).find("option[parent]:first").attr("parent");
9494 var infos = parent.split(":");
9495 var parent_list = infos[0];
9496
9497 //Hide daughters lists
9498 if ($("#"+child_list).val() == 0 && $("#"+parent_list).val() == 0){
9499 $("#"+child_list).hide();
9500 //Show mother lists
9501 } else if ($("#"+parent_list).val() != 0){
9502 $("#"+parent_list).show();
9503 }
9504 //Show the child list if the parent list value is selected
9505 $("select[name=\""+parent_list+"\"]").click(function() {
9506 if ($(this).val() != 0){
9507 $("#"+child_list).show()
9508 }
9509 });
9510
9511 //When we change parent list
9512 $("select[name=\""+parent_list+"\"]").change(function() {
9513 showOptions'.$type.'(child_list, parent_list, orig_select[child_list]);
9514 //Select the value 0 on child list after a change on the parent list
9515 $("#"+child_list).val(0).trigger("change");
9516 //Hide child lists if the parent value is set to 0
9517 if ($(this).val() == 0){
9518 $("#"+child_list).hide();
9519 }
9520 });
9521 });
9522 }
9523
9524 setListDependencies'.$type.'();
9525 });
9526 </script>'."\n";
9527 return $out;
9528 }
9529
9535 public function getRights()
9536 {
9537 global $user;
9538
9539 $module = empty($this->module) ? '' : $this->module;
9540 $element = $this->element;
9541
9542 if ($element == 'facturerec') {
9543 $element = 'facture';
9544 } elseif ($element == 'invoice_supplier_rec') {
9545 return !$user->hasRight('fournisseur', 'facture') ? null : $user->hasRight('fournisseur', 'facture');
9546 } elseif ($module && $user->hasRight($module, $element)) {
9547 // for modules built with ModuleBuilder
9548 return $user->hasRight($module, $element);
9549 }
9550
9551 return $user->rights->$element;
9552 }
9553
9566 public static function commonReplaceThirdparty(DoliDB $dbs, $origin_id, $dest_id, array $tables, $ignoreerrors = 0)
9567 {
9568 global $hookmanager;
9569
9570 $parameters = array(
9571 'origin_id' => $origin_id,
9572 'dest_id' => $dest_id,
9573 'tables' => $tables,
9574 );
9575 $reshook = $hookmanager->executeHooks('commonReplaceThirdparty', $parameters);
9576 if ($reshook) {
9577 return true; // replacement code
9578 } elseif ($reshook < 0) {
9579 return $ignoreerrors === 1; // failure
9580 } // reshook = 0 => execute normal code
9581
9582 foreach ($tables as $table) {
9583 $sql = 'UPDATE '.$dbs->prefix().$table.' SET fk_soc = '.((int) $dest_id).' WHERE fk_soc = '.((int) $origin_id);
9584
9585 if (!$dbs->query($sql)) {
9586 if ($ignoreerrors) {
9587 return true; // FIXME Not enough. If there is A-B on the kept thirdparty and B-C on the old one, we must get A-B-C after merge. Not A-B.
9588 }
9589 //$this->errors = $db->lasterror();
9590 return false;
9591 }
9592 }
9593
9594 return true;
9595 }
9596
9609 public static function commonReplaceProduct(DoliDB $dbs, $origin_id, $dest_id, array $tables, $ignoreerrors = 0)
9610 {
9611 foreach ($tables as $table) {
9612 $sql = 'UPDATE '.MAIN_DB_PREFIX.$table.' SET fk_product = '.((int) $dest_id).' WHERE fk_product = '.((int) $origin_id);
9613
9614 if (!$dbs->query($sql)) {
9615 if ($ignoreerrors) {
9616 return true; // TODO Not enough. If there is A-B on kept product and B-C on old one, we must get A-B-C after merge. Not A-B.
9617 }
9618 //$this->errors = $db->lasterror();
9619 return false;
9620 }
9621 }
9622
9623 return true;
9624 }
9625
9638 public function defineBuyPrice($unitPrice = 0.0, $discountPercent = 0.0, $fk_product = 0)
9639 {
9640 global $conf;
9641
9642 $buyPrice = 0;
9643
9644 if (($unitPrice > 0) && (isset($conf->global->ForceBuyingPriceIfNull) && getDolGlobalInt('ForceBuyingPriceIfNull') > 0)) {
9645 // When ForceBuyingPriceIfNull is set
9646 $buyPrice = $unitPrice * (1 - $discountPercent / 100);
9647 } else {
9648 // Get cost price for margin calculation
9649 if (!empty($fk_product) && $fk_product > 0) {
9650 $result = 0;
9651 if (getDolGlobalString('MARGIN_TYPE') == 'costprice') {
9652 require_once DOL_DOCUMENT_ROOT.'/product/class/product.class.php';
9653 $product = new Product($this->db);
9654 $result = $product->fetch($fk_product);
9655 if ($result <= 0) {
9656 $this->errors[] = 'ErrorProductIdDoesNotExists';
9657 return -1;
9658 }
9659 if ($product->cost_price > 0) {
9660 $buyPrice = $product->cost_price;
9661 } elseif ($product->pmp > 0) {
9662 $buyPrice = $product->pmp;
9663 }
9664 } elseif (getDolGlobalString('MARGIN_TYPE') == 'pmp') {
9665 require_once DOL_DOCUMENT_ROOT.'/product/class/product.class.php';
9666 $product = new Product($this->db);
9667 $result = $product->fetch($fk_product);
9668 if ($result <= 0) {
9669 $this->errors[] = 'ErrorProductIdDoesNotExists';
9670 return -1;
9671 }
9672 if ($product->pmp > 0) {
9673 $buyPrice = $product->pmp;
9674 }
9675 }
9676
9677 if (empty($buyPrice) && isset($conf->global->MARGIN_TYPE) && in_array($conf->global->MARGIN_TYPE, array('1', 'pmp', 'costprice'))) {
9678 require_once DOL_DOCUMENT_ROOT.'/fourn/class/fournisseur.product.class.php';
9679 $productFournisseur = new ProductFournisseur($this->db);
9680 if (($result = $productFournisseur->find_min_price_product_fournisseur($fk_product)) > 0) {
9681 $buyPrice = $productFournisseur->fourn_unitprice;
9682 } elseif ($result < 0) {
9683 $this->errors[] = $productFournisseur->error;
9684 return -2;
9685 }
9686 }
9687 }
9688 }
9689 return $buyPrice;
9690 }
9691
9699 public function getDataToShowPhoto($modulepart, $imagesize)
9700 {
9701 // See getDataToShowPhoto() implemented by Product for example.
9702 return array('dir' => '', 'file' => '', 'originalfile' => '', 'altfile' => '', 'email' => '', 'capture' => '');
9703 }
9704
9705
9706 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
9726 public function show_photos($modulepart, $sdir, $size = 0, $nbmax = 0, $nbbyrow = 5, $showfilename = 0, $showaction = 0, $maxHeight = 120, $maxWidth = 160, $nolink = 0, $overwritetitle = 0, $usesharelink = 0, $cache = '', $addphotorefcss = 'photoref')
9727 {
9728 // phpcs:enable
9729 global $user, $langs;
9730
9731 include_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
9732 include_once DOL_DOCUMENT_ROOT.'/core/lib/images.lib.php';
9733
9734 $sortfield = 'position_name';
9735 $sortorder = 'asc';
9736
9737 $dir = $sdir.'/';
9738 $pdir = '/';
9739
9740 $dir .= get_exdir(0, 0, 0, 0, $this, $modulepart);
9741 $pdir .= get_exdir(0, 0, 0, 0, $this, $modulepart);
9742
9743 // For backward compatibility
9744 if ($modulepart == 'product') {
9745 if (getDolGlobalInt('PRODUCT_USE_OLD_PATH_FOR_PHOTO')) {
9746 $dir = $sdir.'/'.get_exdir($this->id, 2, 0, 0, $this, $modulepart).$this->id."/photos/";
9747 $pdir = '/'.get_exdir($this->id, 2, 0, 0, $this, $modulepart).$this->id."/photos/";
9748 }
9749 }
9750 if ($modulepart == 'category') {
9751 $dir = $sdir.'/'.get_exdir($this->id, 2, 0, 0, $this, $modulepart).$this->id."/photos/";
9752 $pdir = '/'.get_exdir($this->id, 2, 0, 0, $this, $modulepart).$this->id."/photos/";
9753 }
9754
9755 // Defined relative dir to DOL_DATA_ROOT
9756 $relativedir = '';
9757 if ($dir) {
9758 $relativedir = preg_replace('/^'.preg_quote(DOL_DATA_ROOT, '/').'/', '', $dir);
9759 $relativedir = preg_replace('/^[\\/]/', '', $relativedir);
9760 $relativedir = preg_replace('/[\\/]$/', '', $relativedir);
9761 }
9762
9763 $dirthumb = $dir.'thumbs/';
9764 $pdirthumb = $pdir.'thumbs/';
9765
9766 $return = '<!-- Photo -->'."\n";
9767 $nbphoto = 0;
9768
9769 $filearray = dol_dir_list($dir, "files", 0, '', '(\.meta|_preview.*\.png)$', $sortfield, (strtolower($sortorder) == 'desc' ? SORT_DESC : SORT_ASC), 1);
9770
9771 /*if (getDolGlobalInt('PRODUCT_USE_OLD_PATH_FOR_PHOTO')) // For backward compatibility, we scan also old dirs
9772 {
9773 $filearrayold=dol_dir_list($dirold,"files",0,'','(\.meta|_preview.*\.png)$',$sortfield,(strtolower($sortorder)=='desc'?SORT_DESC:SORT_ASC),1);
9774 $filearray=array_merge($filearray, $filearrayold);
9775 }*/
9776
9777 completeFileArrayWithDatabaseInfo($filearray, $relativedir);
9778 '@phan-var-force array<array{name:string,path:string,level1name:string,relativename:string,fullname:string,date:string,size:int,perm:int,type:string,position_name:string,cover:string,keywords:string,acl:string,rowid:int,label:string,share:string}> $filearray';
9779
9780 if (count($filearray)) {
9781 if ($sortfield && $sortorder) {
9782 $filearray = dol_sort_array($filearray, $sortfield, $sortorder);
9783 }
9784
9785 foreach ($filearray as $key => $val) {
9786 $photo = '';
9787 $file = $val['name'];
9788
9789 //if (dol_is_file($dir.$file) && image_format_supported($file) >= 0)
9790 if (image_format_supported($file) >= 0) {
9791 $nbphoto++;
9792 $photo = $file;
9793 $viewfilename = $file;
9794
9795 if ($size == 1 || $size == 'small') { // Format vignette
9796 // Find name of thumb file
9797 $photo_vignette = basename(getImageFileNameForSize($dir.$file, '_small'));
9798 if (!dol_is_file($dirthumb.$photo_vignette)) {
9799 // The thumb does not exists, so we will use the original file
9800 $dirthumb = $dir;
9801 $pdirthumb = $pdir;
9802 $photo_vignette = basename($file);
9803 }
9804
9805 // Get filesize of original file
9806 $imgarray = dol_getImageSize($dir.$photo);
9807
9808 if ($nbbyrow > 0) {
9809 if ($nbphoto == 1) {
9810 $return .= '<table class="valigntop center centpercent" style="border: 0; padding: 2px; border-spacing: 2px; border-collapse: separate;">';
9811 }
9812
9813 if ($nbphoto % $nbbyrow == 1) {
9814 $return .= '<tr class="center valignmiddle" style="border: 1px">';
9815 }
9816 $return .= '<td style="width: '.ceil(100 / $nbbyrow).'%" class="photo">'."\n";
9817 } elseif ($nbbyrow < 0) {
9818 $return .= '<div class="inline-block">'."\n";
9819 }
9820
9821 $relativefile = preg_replace('/^\//', '', $pdir.$photo);
9822 if (empty($nolink)) {
9823 $urladvanced = getAdvancedPreviewUrl($modulepart, $relativefile, 0, 'entity='.$this->entity);
9824 if ($urladvanced) {
9825 $return .= '<a href="'.$urladvanced.'">';
9826 } else {
9827 $return .= '<a href="'.DOL_URL_ROOT.'/viewimage.php?modulepart='.$modulepart.'&entity='.$this->entity.'&file='.urlencode($pdir.$photo).'" class="aphoto" target="_blank" rel="noopener noreferrer">';
9828 }
9829 }
9830
9831 // Show image (width height=$maxHeight)
9832 // Si fichier vignette disponible et image source trop grande, on utilise la vignette, sinon on utilise photo origine
9833 $alt = $langs->transnoentitiesnoconv('File').': '.$relativefile;
9834 $alt .= ' - '.$langs->transnoentitiesnoconv('Size').': '.$imgarray['width'].'x'.$imgarray['height'];
9835 if ($overwritetitle) {
9836 if (is_numeric($overwritetitle)) {
9837 $alt = '';
9838 } else {
9839 $alt = $overwritetitle;
9840 }
9841 }
9842 if (empty($cache) && !empty($val['label'])) {
9843 // label is md5 of file
9844 // use it in url to say we want to cache this version of the file
9845 $cache = $val['label'];
9846 }
9847 if ($usesharelink) {
9848 if (array_key_exists('share', $val) && $val['share']) {
9849 if (empty($maxHeight) || ($photo_vignette && $imgarray['height'] > $maxHeight)) {
9850 $return .= '<!-- Show original file (thumb not yet available with shared links) -->';
9851 $return .= '<img class="photo photowithmargin'.($addphotorefcss ? ' '.$addphotorefcss : '').'"'.($maxHeight ? ' height="'.$maxHeight.'"' : '').' src="'.DOL_URL_ROOT.'/viewimage.php?hashp='.urlencode($val['share']).($cache ? '&cache='.urlencode($cache) : '').'" title="'.dol_escape_htmltag($alt).'">';
9852 } else {
9853 $return .= '<!-- Show original file -->';
9854 $return .= '<img class="photo photowithmargin'.($addphotorefcss ? ' '.$addphotorefcss : '').'" height="'.$maxHeight.'" src="'.DOL_URL_ROOT.'/viewimage.php?hashp='.urlencode($val['share']).($cache ? '&cache='.urlencode($cache) : '').'" title="'.dol_escape_htmltag($alt).'">';
9855 }
9856 } else {
9857 $return .= '<!-- Show nophoto file (because file is not shared) -->';
9858 $return .= '<img class="photo photowithmargin'.($addphotorefcss ? ' '.$addphotorefcss : '').'" height="'.$maxHeight.'" src="'.DOL_URL_ROOT.'/public/theme/common/nophoto.png" title="'.dol_escape_htmltag($alt).'">';
9859 }
9860 } else {
9861 if (empty($maxHeight) || ($photo_vignette && $imgarray['height'] > $maxHeight)) {
9862 $return .= '<!-- Show thumb -->';
9863 $return .= '<img class="photo photowithmargin'.($addphotorefcss ? ' '.$addphotorefcss : '').' maxwidth150onsmartphone maxwidth200"'.($maxHeight ? ' height="'.$maxHeight.'"' : '').' src="'.DOL_URL_ROOT.'/viewimage.php?modulepart='.$modulepart.'&entity='.$this->entity.($cache ? '&cache='.urlencode($cache) : '').'&file='.urlencode($pdirthumb.$photo_vignette).'" title="'.dol_escape_htmltag($alt).'">';
9864 } else {
9865 $return .= '<!-- Show original file -->';
9866 $return .= '<img class="photo photowithmargin'.($addphotorefcss ? ' '.$addphotorefcss : '').'" height="'.$maxHeight.'" src="'.DOL_URL_ROOT.'/viewimage.php?modulepart='.$modulepart.'&entity='.$this->entity.($cache ? '&cache='.urlencode($cache) : '').'&file='.urlencode($pdir.$photo).'" title="'.dol_escape_htmltag($alt).'">';
9867 }
9868 }
9869
9870 if (empty($nolink)) {
9871 $return .= '</a>';
9872 }
9873
9874 if ($showfilename) {
9875 $return .= '<br>'.$viewfilename;
9876 }
9877 if ($showaction) {
9878 $return .= '<br>';
9879 // If $photo_vignette set, we add a link to generate thumbs if file is an image and width or height higher than limits
9880 if ($photo_vignette && (image_format_supported($photo) > 0) && ((isset($imgarray['width']) && $imgarray['width'] > $maxWidth) || (isset($imgarray['width']) && $imgarray['width'] > $maxHeight))) {
9881 $return .= '<a href="'.$_SERVER["PHP_SELF"].'?id='.$this->id.'&action=addthumb&token='.newToken().'&file='.urlencode($pdir.$viewfilename).'">'.img_picto($langs->trans('GenerateThumb'), 'refresh').'&nbsp;&nbsp;</a>';
9882 }
9883 // Special case for product
9884 if ($modulepart == 'product' && ($user->hasRight('produit', 'creer') || $user->hasRight('service', 'creer'))) {
9885 // Link to resize
9886 $return .= '<a href="'.DOL_URL_ROOT.'/core/photos_resize.php?modulepart='.urlencode('produit|service').'&id='.$this->id.'&file='.urlencode($pdir.$viewfilename).'" title="'.dol_escape_htmltag($langs->trans("Resize")).'">'.img_picto($langs->trans("Resize"), 'resize', '').'</a> &nbsp; ';
9887
9888 // Link to delete
9889 $return .= '<a href="'.$_SERVER["PHP_SELF"].'?id='.$this->id.'&action=delete&token='.newToken().'&file='.urlencode($pdir.$viewfilename).'">';
9890 $return .= img_delete().'</a>';
9891 }
9892 }
9893 $return .= "\n";
9894
9895 if ($nbbyrow > 0) {
9896 $return .= '</td>';
9897 if (($nbphoto % $nbbyrow) == 0) {
9898 $return .= '</tr>';
9899 }
9900 } elseif ($nbbyrow < 0) {
9901 $return .= '</div>'."\n";
9902 }
9903 }
9904
9905 if (empty($size)) { // Format origine
9906 $return .= '<img class="photo photowithmargin" src="'.DOL_URL_ROOT.'/viewimage.php?modulepart='.$modulepart.'&entity='.$this->entity.'&file='.urlencode($pdir.$photo).'">';
9907
9908 if ($showfilename) {
9909 $return .= '<br>'.$viewfilename;
9910 }
9911 if ($showaction) {
9912 // Special case for product
9913 if ($modulepart == 'product' && ($user->hasRight('produit', 'creer') || $user->hasRight('service', 'creer'))) {
9914 // Link to resize
9915 $return .= '<a href="'.DOL_URL_ROOT.'/core/photos_resize.php?modulepart='.urlencode('produit|service').'&id='.$this->id.'&file='.urlencode($pdir.$viewfilename).'" title="'.dol_escape_htmltag($langs->trans("Resize")).'">'.img_picto($langs->trans("Resize"), 'resize', '').'</a> &nbsp; ';
9916
9917 // Link to delete
9918 $return .= '<a href="'.$_SERVER["PHP_SELF"].'?id='.$this->id.'&action=delete&token='.newToken().'&file='.urlencode($pdir.$viewfilename).'">';
9919 $return .= img_delete().'</a>';
9920 }
9921 }
9922 }
9923
9924 // On continue ou on arrete de boucler ?
9925 if ($nbmax && $nbphoto >= $nbmax) {
9926 break;
9927 }
9928 }
9929 }
9930
9931 if ($size == 1 || $size == 'small') {
9932 if ($nbbyrow > 0) {
9933 // Ferme tableau
9934 while ($nbphoto % $nbbyrow) {
9935 $return .= '<td style="width: '.ceil(100 / $nbbyrow).'%">&nbsp;</td>';
9936 $nbphoto++;
9937 }
9938
9939 if ($nbphoto) {
9940 $return .= '</table>';
9941 }
9942 }
9943 }
9944 }
9945
9946 $this->nbphoto = $nbphoto;
9947
9948 return $return;
9949 }
9950
9951
9958 protected function isArray($info)
9959 {
9960 if (is_array($info)) {
9961 if (isset($info['type']) && $info['type'] == 'array') {
9962 return true;
9963 } else {
9964 return false;
9965 }
9966 }
9967 return false;
9968 }
9969
9976 public function isDate($info)
9977 {
9978 if (isset($info['type']) && ($info['type'] == 'date' || $info['type'] == 'datetime' || $info['type'] == 'timestamp')) {
9979 return true;
9980 }
9981 return false;
9982 }
9983
9990 public function isDuration($info)
9991 {
9992 if (is_array($info)) {
9993 if (isset($info['type']) && ($info['type'] == 'duration')) {
9994 return true;
9995 } else {
9996 return false;
9997 }
9998 } else {
9999 return false;
10000 }
10001 }
10002
10009 public function isInt($info)
10010 {
10011 if (is_array($info)) {
10012 if (isset($info['type']) && (preg_match('/(^int|int$)/i', $info['type']))) {
10013 return true;
10014 } else {
10015 return false;
10016 }
10017 } else {
10018 return false;
10019 }
10020 }
10021
10028 public function isFloat($info)
10029 {
10030 if (is_array($info)) {
10031 if (isset($info['type']) && (preg_match('/^(double|real|price)/i', $info['type']))) {
10032 return true;
10033 } else {
10034 return false;
10035 }
10036 }
10037 return false;
10038 }
10039
10046 public function isText($info)
10047 {
10048 if (is_array($info)) {
10049 if (isset($info['type']) && $info['type'] == 'text') {
10050 return true;
10051 } else {
10052 return false;
10053 }
10054 }
10055 return false;
10056 }
10057
10064 protected function canBeNull($info)
10065 {
10066 if (is_array($info)) {
10067 if (array_key_exists('notnull', $info) && $info['notnull'] != '1') {
10068 return true;
10069 } else {
10070 return false;
10071 }
10072 }
10073 return true;
10074 }
10075
10082 protected function isForcedToNullIfZero($info)
10083 {
10084 if (is_array($info)) {
10085 if (array_key_exists('notnull', $info) && $info['notnull'] == '-1') {
10086 return true;
10087 } else {
10088 return false;
10089 }
10090 }
10091 return false;
10092 }
10093
10100 protected function isIndex($info)
10101 {
10102 if (is_array($info)) {
10103 if (array_key_exists('index', $info) && $info['index'] == true) {
10104 return true;
10105 } else {
10106 return false;
10107 }
10108 }
10109 return false;
10110 }
10111
10112
10121 protected function setSaveQuery()
10122 {
10123 global $conf;
10124
10125 $queryarray = array();
10126 foreach ($this->fields as $field => $info) { // Loop on definition of fields
10127 // Depending on field type ('datetime', ...)
10128 if ($this->isDate($info)) {
10129 if (empty($this->{$field})) {
10130 $queryarray[$field] = null;
10131 } else {
10132 $queryarray[$field] = $this->db->idate($this->{$field});
10133 }
10134 } elseif ($this->isDuration($info)) {
10135 // $this->{$field} may be null, '', 0, '0', 123, '123'
10136 if ((isset($this->{$field}) && $this->{$field} != '') || !empty($info['notnull'])) {
10137 if (!isset($this->{$field})) {
10138 if (!empty($info['default'])) {
10139 $queryarray[$field] = $info['default'];
10140 } else {
10141 $queryarray[$field] = 0;
10142 }
10143 } else {
10144 $queryarray[$field] = (int) $this->{$field}; // If '0', it may be set to null later if $info['notnull'] == -1
10145 }
10146 } else {
10147 $queryarray[$field] = null;
10148 }
10149 } elseif ($this->isInt($info) || $this->isFloat($info)) {
10150 if ($field == 'entity' && is_null($this->{$field})) {
10151 $queryarray[$field] = ((int) $conf->entity);
10152 } else {
10153 // $this->{$field} may be null, '', 0, '0', 123, '123'
10154 if ((isset($this->{$field}) && ((string) $this->{$field}) != '') || !empty($info['notnull'])) {
10155 if (!isset($this->{$field})) {
10156 $queryarray[$field] = 0;
10157 } elseif ($this->isInt($info)) {
10158 $queryarray[$field] = (int) $this->{$field}; // If '0', it may be set to null later if $info['notnull'] == -1
10159 } elseif ($this->isFloat($info)) {
10160 $queryarray[$field] = (float) $this->{$field}; // If '0', it may be set to null later if $info['notnull'] == -1
10161 }
10162 } else {
10163 $queryarray[$field] = null;
10164 }
10165 }
10166 } else {
10167 // Note: If $this->{$field} is not defined, it means there is a bug into definition of ->fields or a missing declaration of property
10168 // We should keep the warning generated by this because it is a bug somewhere else in code, not here.
10169 $queryarray[$field] = $this->{$field};
10170 }
10171
10172 if (array_key_exists('type', $info) && $info['type'] == 'timestamp' && empty($queryarray[$field])) {
10173 unset($queryarray[$field]);
10174 }
10175 if (!empty($info['notnull']) && $info['notnull'] == -1 && empty($queryarray[$field])) {
10176 $queryarray[$field] = null; // May force 0 to null
10177 }
10178 }
10179
10180 return $queryarray;
10181 }
10182
10189 public function setVarsFromFetchObj(&$obj)
10190 {
10191 global $db;
10192
10193 foreach ($this->fields as $field => $info) {
10194 if ($this->isDate($info)) {
10195 if (!isset($obj->$field) || is_null($obj->$field) || $obj->$field === '' || $obj->$field === '0000-00-00 00:00:00' || $obj->$field === '1000-01-01 00:00:00') {
10196 $this->$field = '';
10197 } else {
10198 $this->$field = $db->jdate($obj->$field);
10199 }
10200 } elseif ($this->isInt($info)) {
10201 if ($field == 'rowid') {
10202 $this->id = (int) $obj->$field;
10203 } else {
10204 if ($this->isForcedToNullIfZero($info)) {
10205 if (empty($obj->$field)) {
10206 $this->$field = null;
10207 } else {
10208 $this->$field = (int) $obj->$field;
10209 }
10210 } else {
10211 if (isset($obj->$field) && (!is_null($obj->$field) || (array_key_exists('notnull', $info) && $info['notnull'] == 1))) {
10212 $this->$field = (int) $obj->$field;
10213 } else {
10214 $this->$field = null;
10215 }
10216 }
10217 }
10218 } elseif ($this->isFloat($info)) {
10219 if ($this->isForcedToNullIfZero($info)) {
10220 if (empty($obj->$field)) {
10221 $this->$field = null;
10222 } else {
10223 $this->$field = (float) $obj->$field;
10224 }
10225 } else {
10226 if (isset($obj->$field) && (!is_null($obj->$field) || (array_key_exists('notnull', $info) && $info['notnull'] == 1))) {
10227 $this->$field = (float) $obj->$field;
10228 } else {
10229 $this->$field = null;
10230 }
10231 }
10232 } else {
10233 $this->$field = isset($obj->$field) ? $obj->$field : null;
10234 }
10235 }
10236
10237 // If there is no 'ref' field, we force property ->ref to ->id for a better compatibility with common functions.
10238 if (!isset($this->fields['ref']) && isset($this->id)) {
10239 $this->ref = (string) $this->id;
10240 }
10241 }
10242
10247 public function emtpyObjectVars()
10248 {
10249 foreach ($this->fields as $field => $arr) {
10250 $this->$field = null;
10251 }
10252 }
10253
10261 public function getFieldList($alias = '', $excludefields = array())
10262 {
10263 $keys = array_keys($this->fields);
10264 if (!empty($alias)) {
10265 $keys_with_alias = array();
10266 foreach ($keys as $fieldname) {
10267 if (!empty($excludefields)) {
10268 if (in_array($fieldname, $excludefields)) { // The field is excluded and must not be in output
10269 continue;
10270 }
10271 }
10272 $keys_with_alias[] = $alias . '.' . $fieldname;
10273 }
10274 return implode(',', $keys_with_alias);
10275 } else {
10276 return implode(',', $keys);
10277 }
10278 }
10279
10287 protected function quote($value, $fieldsentry)
10288 {
10289 if (is_null($value)) {
10290 return 'NULL';
10291 } elseif (preg_match('/^(int|double|real|price)/i', $fieldsentry['type'])) {
10292 return price2num((string) $value);
10293 } elseif (preg_match('/int$/i', $fieldsentry['type'])) {
10294 return (int) $value;
10295 } elseif ($fieldsentry['type'] == 'boolean') {
10296 if ($value) {
10297 return 'true';
10298 } else {
10299 return 'false';
10300 }
10301 } else {
10302 return "'".$this->db->escape($value)."'";
10303 }
10304 }
10305
10306
10314 public function createCommon(User $user, $notrigger = 0)
10315 {
10316 global $langs;
10317
10318 dol_syslog(get_class($this)."::createCommon create", LOG_DEBUG);
10319
10320 $error = 0;
10321
10322 $now = dol_now();
10323
10324 $fieldvalues = $this->setSaveQuery();
10325
10326 // Note: Here, $fieldvalues contains same keys (or less) that are inside ->fields
10327
10328 if (array_key_exists('date_creation', $fieldvalues) && empty($fieldvalues['date_creation'])) {
10329 $fieldvalues['date_creation'] = $this->db->idate($now);
10330 }
10331 if (array_key_exists('fk_user_creat', $fieldvalues) && !($fieldvalues['fk_user_creat'] > 0)) {
10332 $fieldvalues['fk_user_creat'] = $user->id;
10333 $this->fk_user_creat = $user->id;
10334 }
10335 if (array_key_exists('user_creation_id', $fieldvalues) && !($fieldvalues['user_creation_id'] > 0)) {
10336 $fieldvalues['user_creation_id'] = $user->id;
10337 $this->user_creation_id = $user->id;
10338 }
10339 if (array_key_exists('pass_crypted', $fieldvalues) && property_exists($this, 'pass')) {
10340 // @phan-suppress-next-line PhanUndeclaredProperty
10341 $fieldvalues['pass_crypted'] = dol_hash($this->pass);
10342 }
10343 if (array_key_exists('ref', $fieldvalues)) {
10344 $fieldvalues['ref'] = dol_string_nospecial($fieldvalues['ref']); // If field is a ref, we sanitize data
10345 }
10346
10347 unset($fieldvalues['rowid']); // The field 'rowid' is reserved field name for autoincrement field so we don't need it into insert.
10348
10349 $keys = array();
10350 $values = array(); // Array to store string forged for SQL syntax
10351 foreach ($fieldvalues as $k => $v) {
10352 $keys[$k] = $k;
10353 $value = $this->fields[$k];
10354 // @phan-suppress-next-line PhanPluginSuspiciousParamPosition
10355 $values[$k] = $this->quote($v, $value); // May return string 'NULL' if $value is null
10356 }
10357
10358 // Clean and check mandatory
10359 foreach ($keys as $key) {
10360 if (!isset($this->fields[$key])) {
10361 continue;
10362 }
10363 $key_fields = $this->fields[$key];
10364
10365 // If field is an implicit foreign key field (so type = 'integer:...')
10366 if (preg_match('/^integer:/i', $key_fields['type']) && $values[$key] == '-1') {
10367 $values[$key] = '';
10368 }
10369 if (!empty($key_fields['foreignkey']) && $values[$key] == '-1') {
10370 $values[$key] = '';
10371 }
10372
10373 if (isset($key_fields['notnull']) && $key_fields['notnull'] == 1 && (!isset($values[$key]) || $values[$key] === 'NULL') && (!isset($key_fields['default']) || is_null($key_fields['default']))) {
10374 $error++;
10375 $langs->load("errors");
10376 dol_syslog("Mandatory field '".$key."' is empty and required into ->fields definition of class");
10377 $this->errors[] = $langs->trans("ErrorFieldRequired", isset($key_fields['label']) ? $key_fields['label'] : $key);
10378 }
10379
10380 // If value is null and there is a default value for field @phan-suppress-next-line PhanTypePossiblyInvalidDimOffset
10381 if (isset($key_fields['notnull']) && $key_fields['notnull'] == 1 && (!isset($values[$key]) || $values[$key] === 'NULL') && !is_null($key_fields['default'])) {
10382 $values[$key] = $this->quote($key_fields['default'], $key_fields);
10383 }
10384
10385 // If field is an implicit foreign key field (so type = 'integer:...')
10386 if (isset($key_fields['type']) && preg_match('/^integer:/i', $key_fields['type']) && empty($values[$key])) {
10387 if (isset($key_fields['default'])) {
10388 $values[$key] = ((int) $key_fields['default']);
10389 } else {
10390 $values[$key] = 'null';
10391 }
10392 }
10393 if (!empty($key_fields['foreignkey']) && empty($values[$key])) {
10394 $values[$key] = 'null';
10395 }
10396 }
10397
10398 if ($error) {
10399 return -1;
10400 }
10401
10402 $this->db->begin();
10403
10404 if (!$error) {
10405 $sql = "INSERT INTO ".$this->db->prefix().$this->table_element;
10406 $sql .= " (".implode(", ", $keys).')';
10407 $sql .= " VALUES (".implode(", ", $values).")"; // $values can contains 'abc' or 123
10408
10409 $res = $this->db->query($sql);
10410 if (!$res) {
10411 $error++;
10412 if ($this->db->lasterrno() == 'DB_ERROR_RECORD_ALREADY_EXISTS') {
10413 $this->errors[] = "ErrorRefAlreadyExists";
10414 } else {
10415 $this->errors[] = $this->db->lasterror();
10416 }
10417 }
10418 }
10419
10420 if (!$error) {
10421 $this->id = $this->db->last_insert_id($this->db->prefix().$this->table_element);
10422 }
10423
10424 // If we have a field ref with a default value of (PROV)
10425 if (!$error) {
10426 // @phan-suppress-next-line PhanTypePossiblyInvalidDimOffset
10427 if (array_key_exists('ref', $this->fields) && array_key_exists('notnull', $this->fields['ref']) && $this->fields['ref']['notnull'] > 0 && array_key_exists('default', $this->fields['ref']) && $this->fields['ref']['default'] == '(PROV)') {
10428 $sql = "UPDATE ".$this->db->prefix().$this->table_element." SET ref = '(PROV".((int) $this->id).")' WHERE (ref = '(PROV)' OR ref = '') AND rowid = ".((int) $this->id);
10429 $resqlupdate = $this->db->query($sql);
10430
10431 if ($resqlupdate === false) {
10432 $error++;
10433 $this->errors[] = $this->db->lasterror();
10434 } else {
10435 $this->ref = '(PROV'.$this->id.')';
10436 }
10437 }
10438 }
10439
10440 // Create extrafields
10441 if (!$error) {
10442 $result = $this->insertExtraFields();
10443 if ($result < 0) {
10444 $error++;
10445 }
10446 }
10447
10448 // Create lines
10449 if (!empty($this->table_element_line) && !empty($this->fk_element)) {
10450 foreach ($this->lines as $line) {
10451 $keyforparent = $this->fk_element;
10452 $line->$keyforparent = $this->id;
10453
10454 // Test and convert into object this->lines[$i]. When coming from REST API, we may still have an array
10455 //if (! is_object($line)) $line=json_decode(json_encode($line), false); // convert recursively array into object.
10456 if (!is_object($line)) {
10457 $line = (object) $line;
10458 }
10459
10460 $result = 0;
10461 if (method_exists($line, 'insert')) {
10462 $result = $line->insert($user, 1);
10463 } elseif (method_exists($line, 'create')) {
10464 $result = $line->create($user, 1);
10465 }
10466 if ($result < 0) {
10467 $this->error = $line->error;
10468 $this->db->rollback();
10469 return -1;
10470 }
10471 }
10472 }
10473
10474 // Triggers
10475 if (!$error && !$notrigger) {
10476 // Call triggers
10477 $result = $this->call_trigger(strtoupper(get_class($this)).'_CREATE', $user);
10478 if ($result < 0) {
10479 $error++;
10480 }
10481 // End call triggers
10482 }
10483
10484 // Commit or rollback
10485 if ($error) {
10486 $this->db->rollback();
10487 return -1;
10488 } else {
10489 $this->db->commit();
10490 return $this->id;
10491 }
10492 }
10493
10494
10504 public function fetchCommon($id, $ref = null, $morewhere = '', $noextrafields = 0)
10505 {
10506 if (empty($id) && empty($ref) && empty($morewhere)) {
10507 return -1;
10508 }
10509
10510 $fieldlist = $this->getFieldList('t');
10511 if (empty($fieldlist)) {
10512 return 0;
10513 }
10514
10515 $sql = "SELECT ".$fieldlist;
10516 $sql .= " FROM ".$this->db->prefix().$this->table_element.' as t';
10517
10518 if (!empty($id)) {
10519 $sql .= ' WHERE t.rowid = '.((int) $id);
10520 } elseif (!empty($ref)) {
10521 $sql .= " WHERE t.ref = '".$this->db->escape($ref)."'";
10522 } else {
10523 $sql .= ' WHERE 1 = 1'; // usage with empty id and empty ref is very rare
10524 }
10525 if (empty($id) && isset($this->ismultientitymanaged) && $this->ismultientitymanaged == 1) {
10526 $sql .= ' AND t.entity IN ('.getEntity($this->element).')';
10527 }
10528 if ($morewhere) {
10529 $sql .= $morewhere;
10530 }
10531 $sql .= ' LIMIT 1'; // This is a fetch, to be certain to get only one record
10532
10533 $res = $this->db->query($sql);
10534 if ($res) {
10535 $obj = $this->db->fetch_object($res);
10536 if ($obj) {
10537 $this->setVarsFromFetchObj($obj);
10538
10539 // Retrieve all extrafield
10540 // fetch optionals attributes and labels
10541 if (empty($noextrafields)) {
10542 $result = $this->fetch_optionals();
10543 if ($result < 0) {
10544 $this->error = $this->db->lasterror();
10545 $this->errors[] = $this->error;
10546 return -4;
10547 }
10548 }
10549
10550 return $this->id;
10551 } else {
10552 return 0;
10553 }
10554 } else {
10555 $this->error = $this->db->lasterror();
10556 $this->errors[] = $this->error;
10557 return -1;
10558 }
10559 }
10560
10568 public function fetchLinesCommon($morewhere = '', $noextrafields = 0)
10569 {
10570 $objectlineclassname = get_class($this).'Line';
10571 if (!class_exists($objectlineclassname)) {
10572 $this->error = 'Error, class '.$objectlineclassname.' not found during call of fetchLinesCommon';
10573 return -1;
10574 }
10575
10576 $objectline = new $objectlineclassname($this->db);
10577 '@phan-var-force CommonObjectLine $objectline';
10578
10579 $sql = "SELECT ".$objectline->getFieldList('l');
10580 $sql .= " FROM ".$this->db->prefix().$objectline->table_element." as l";
10581 $sql .= " WHERE l.fk_".$this->db->escape($this->element)." = ".((int) $this->id);
10582 if ($morewhere) {
10583 $sql .= $morewhere;
10584 }
10585 if (isset($objectline->fields['position'])) {
10586 $sql .= $this->db->order('position', 'ASC');
10587 }
10588
10589 $resql = $this->db->query($sql);
10590 if ($resql) {
10591 $num_rows = $this->db->num_rows($resql);
10592 $i = 0;
10593 $this->lines = array();
10594 while ($i < $num_rows) {
10595 $obj = $this->db->fetch_object($resql);
10596 if ($obj) {
10597 $newline = new $objectlineclassname($this->db);
10598 '@phan-var-force CommonObjectLine $newline';
10599 $newline->setVarsFromFetchObj($obj);
10600
10601 // Note: extrafields load of line not yet supported
10602 /*
10603 if (empty($noextrafields)) {
10604 // Load extrafields of line
10605 }*/
10606
10607 $this->lines[] = $newline;
10608 }
10609 $i++;
10610 }
10611
10612 return 1;
10613 } else {
10614 $this->error = $this->db->lasterror();
10615 $this->errors[] = $this->error;
10616 return -1;
10617 }
10618 }
10619
10627 public function updateCommon(User $user, $notrigger = 0)
10628 {
10629 dol_syslog(get_class($this)."::updateCommon update", LOG_DEBUG);
10630
10631 $error = 0;
10632
10633 $now = dol_now();
10634
10635 // $this->oldcopy should have been set by the caller of update
10636 //if (empty($this->oldcopy)) {
10637 // dol_syslog("this->oldcopy should have been set by the caller of update (here properties were already modified)", LOG_WARNING);
10638 // $this->oldcopy = dol_clone($this, 2);
10639 //}
10640
10641 $fieldvalues = $this->setSaveQuery();
10642
10643 // Note: Here, $fieldvalues contains same keys (or less) that are inside ->fields
10644
10645 if (array_key_exists('date_modification', $fieldvalues) && empty($fieldvalues['date_modification'])) {
10646 $fieldvalues['date_modification'] = $this->db->idate($now);
10647 }
10648 if (array_key_exists('fk_user_modif', $fieldvalues) && !($fieldvalues['fk_user_modif'] > 0)) {
10649 $fieldvalues['fk_user_modif'] = $user->id;
10650 }
10651 if (array_key_exists('user_modification_id', $fieldvalues) && !($fieldvalues['user_modification_id'] > 0)) {
10652 $fieldvalues['user_modification_id'] = $user->id;
10653 }
10654 if (array_key_exists('ref', $fieldvalues)) {
10655 $fieldvalues['ref'] = dol_string_nospecial($fieldvalues['ref']); // If field is a ref, we sanitize data
10656 }
10657
10658 unset($fieldvalues['rowid']); // The field 'rowid' is reserved field name for autoincrement field so we don't need it into update.
10659
10660 // Add quotes and escape on fields with type string
10661 $keys = array();
10662 $values = array();
10663 $tmp = array();
10664 foreach ($fieldvalues as $k => $v) {
10665 $keys[$k] = $k;
10666 $value = $this->fields[$k];
10667 // @phan-suppress-next-line PhanPluginSuspiciousParamPosition
10668 $values[$k] = $this->quote($v, $value);
10669 if (($value["type"] == "text") && !empty($value['arrayofkeyval']) && is_array($value['arrayofkeyval'])) {
10670 // Clean values for text with selectbox
10671 $v = preg_replace('/\s/', ',', $v);
10672 $v = preg_replace('/,+/', ',', $v);
10673 }
10674 // @phan-suppress-next-line PhanPluginSuspiciousParamPosition
10675 $tmp[] = $k.'='.$this->quote($v, $this->fields[$k]);
10676 }
10677
10678 // Clean and check mandatory fields
10679 foreach ($keys as $key) {
10680 if (preg_match('/^integer:/i', $this->fields[$key]['type']) && $values[$key] == '-1') {
10681 $values[$key] = ''; // This is an implicit foreign key field
10682 }
10683 if (!empty($this->fields[$key]['foreignkey']) && $values[$key] == '-1') {
10684 $values[$key] = ''; // This is an explicit foreign key field
10685 }
10686
10687 //var_dump($key.'-'.$values[$key].'-'.($this->fields[$key]['notnull'] == 1));
10688 /*
10689 if ($this->fields[$key]['notnull'] == 1 && empty($values[$key]))
10690 {
10691 $error++;
10692 $this->errors[]=$langs->trans("ErrorFieldRequired", $this->fields[$key]['label']);
10693 }*/
10694 }
10695
10696 $sql = 'UPDATE '.$this->db->prefix().$this->table_element.' SET '.implode(', ', $tmp).' WHERE rowid='.((int) $this->id);
10697
10698 $this->db->begin();
10699
10700 if (!$error) {
10701 $res = $this->db->query($sql);
10702 if (!$res) {
10703 $error++;
10704 $this->errors[] = $this->db->lasterror();
10705 }
10706 }
10707
10708 // Update extrafield
10709 if (!$error) {
10710 $result = $this->insertExtraFields(); // This delete and reinsert extrafields
10711 if ($result < 0) {
10712 $error++;
10713 }
10714 }
10715
10716 // Triggers
10717 if (!$error && !$notrigger) {
10718 // Call triggers
10719 $result = $this->call_trigger(strtoupper(get_class($this)).'_MODIFY', $user);
10720 if ($result < 0) {
10721 $error++;
10722 } //Do also here what you must do to rollback action if trigger fail
10723 // End call triggers
10724 }
10725
10726 // Commit or rollback
10727 if ($error) {
10728 $this->db->rollback();
10729 return -1;
10730 } else {
10731 $this->db->commit();
10732 return $this->id;
10733 }
10734 }
10735
10744 public function deleteCommon(User $user, $notrigger = 0, $forcechilddeletion = 0)
10745 {
10746 dol_syslog(get_class($this)."::deleteCommon delete", LOG_DEBUG);
10747
10748 $error = 0;
10749
10750 $this->db->begin();
10751
10752 if ($forcechilddeletion) { // Force also delete of childtables that should lock deletion in standard case when option force is off
10753 foreach ($this->childtables as $table) {
10754 $sql = "DELETE FROM ".$this->db->prefix().$table." WHERE ".$this->fk_element." = ".((int) $this->id);
10755 $resql = $this->db->query($sql);
10756 if (!$resql) {
10757 $this->error = $this->db->lasterror();
10758 $this->errors[] = $this->error;
10759 $this->db->rollback();
10760 return -1;
10761 }
10762 }
10763 } elseif (!empty($this->childtables)) { // If object has children linked with a foreign key field, we check all child tables.
10764 $objectisused = $this->isObjectUsed($this->id);
10765 if (!empty($objectisused)) {
10766 dol_syslog(get_class($this)."::deleteCommon Can't delete record as it has some child", LOG_WARNING);
10767 $this->error = 'ErrorRecordHasChildren';
10768 $this->errors[] = $this->error;
10769 $this->db->rollback();
10770 return 0;
10771 }
10772 }
10773
10774 // Delete cascade first
10775 if (is_array($this->childtablesoncascade) && !empty($this->childtablesoncascade)) {
10776 foreach ($this->childtablesoncascade as $tabletodelete) {
10777 $deleteFromObject = explode(':', $tabletodelete, 4);
10778 if (count($deleteFromObject) >= 2) {
10779 $className = str_replace('@', '', $deleteFromObject[0]);
10780 $filePath = $deleteFromObject[1];
10781 $columnName = $deleteFromObject[2];
10782 $filter = '';
10783 if (!empty($deleteFromObject[3])) {
10784 $filter = $deleteFromObject[3];
10785 }
10786 if (dol_include_once($filePath)) {
10787 $childObject = new $className($this->db);
10788 if (method_exists($childObject, 'deleteByParentField')) {
10789 '@phan-var-force CommonObject $childObject';
10790 $result = $childObject->deleteByParentField($this->id, $columnName, $filter);
10791 if ($result < 0) {
10792 $error++;
10793 $this->errors[] = $childObject->error;
10794 break;
10795 }
10796 } else {
10797 $error++;
10798 $this->errors[] = "You defined a cascade delete on an object $className/$this->id but there is no method deleteByParentField for it";
10799 break;
10800 }
10801 } else {
10802 $error++;
10803 $this->errors[] = 'Cannot include child class file '.$filePath;
10804 break;
10805 }
10806 } else {
10807 // Delete record in child table
10808 $sql = "DELETE FROM ".$this->db->prefix().$tabletodelete." WHERE ".$this->fk_element." = ".((int) $this->id);
10809
10810 $resql = $this->db->query($sql);
10811 if (!$resql) {
10812 $error++;
10813 $this->error = $this->db->lasterror();
10814 $this->errors[] = $this->error;
10815 break;
10816 }
10817 }
10818 }
10819 }
10820
10821 if (!$error) {
10822 if (!$notrigger) {
10823 // Call triggers
10824 $result = $this->call_trigger(strtoupper(get_class($this)).'_DELETE', $user);
10825 if ($result < 0) {
10826 $error++;
10827 } // Do also here what you must do to rollback action if trigger fail
10828 // End call triggers
10829 }
10830 }
10831
10832 // Delete llx_ecm_files
10833 if (!$error) {
10834 $res = $this->deleteEcmFiles(1); // Deleting files physically is done later with the dol_delete_dir_recursive
10835 if (!$res) {
10836 $error++;
10837 }
10838 }
10839
10840 // Delete linked object
10841 $res = $this->deleteObjectLinked();
10842 if ($res < 0) {
10843 $error++;
10844 }
10845
10846 if (!$error && !empty($this->isextrafieldmanaged)) {
10847 $result = $this->deleteExtraFields();
10848 if ($result < 0) {
10849 $error++;
10850 }
10851 }
10852
10853 if (!$error) {
10854 $sql = 'DELETE FROM '.$this->db->prefix().$this->table_element.' WHERE rowid='.((int) $this->id);
10855
10856 $resql = $this->db->query($sql);
10857 if (!$resql) {
10858 $error++;
10859 $this->errors[] = $this->db->lasterror();
10860 }
10861 }
10862
10863 // Commit or rollback
10864 if ($error) {
10865 $this->db->rollback();
10866 return -1;
10867 } else {
10868 $this->db->commit();
10869 return 1;
10870 }
10871 }
10872
10884 public function deleteByParentField($parentId = 0, $parentField = '', $filter = '', $filtermode = "AND")
10885 {
10886 global $user;
10887
10888 $error = 0;
10889 $deleted = 0;
10890
10891 if (!empty($parentId) && !empty($parentField)) {
10892 $this->db->begin();
10893
10894 $sql = "SELECT rowid FROM ".$this->db->prefix().$this->table_element;
10895 $sql .= " WHERE ".$this->db->sanitize($parentField)." = ".(int) $parentId;
10896
10897 // Manage filter
10898 $errormessage = '';
10899 $sql .= forgeSQLFromUniversalSearchCriteria($filter, $errormessage);
10900 if ($errormessage) {
10901 $this->errors[] = $errormessage;
10902 dol_syslog(__METHOD__.' '.implode(',', $this->errors), LOG_ERR);
10903 return -1;
10904 }
10905
10906 $resql = $this->db->query($sql);
10907 if (!$resql) {
10908 $this->errors[] = $this->db->lasterror();
10909 $error++;
10910 } else {
10911 while ($obj = $this->db->fetch_object($resql)) {
10912 $result = $this->fetch($obj->rowid); // @phpstan-ignore-line
10913 if ($result < 0) {
10914 $error++;
10915 $this->errors[] = $this->error;
10916 } else {
10917 $result = $this->delete($user); // @phpstan-ignore-line
10918 if ($result < 0) {
10919 $error++;
10920 $this->errors[] = $this->error;
10921 } else {
10922 $deleted++;
10923 }
10924 }
10925 }
10926 }
10927
10928 if (empty($error)) {
10929 $this->db->commit();
10930 return $deleted;
10931 } else {
10932 $this->error = implode(', ', $this->errors);
10933 $this->db->rollback();
10934 return $error * -1;
10935 }
10936 }
10937
10938 return $deleted;
10939 }
10940
10949 public function deleteLineCommon(User $user, $idline, $notrigger = 0)
10950 {
10951 $error = 0;
10952
10953 $tmpforobjectclass = get_class($this);
10954 $tmpforobjectlineclass = ucfirst($tmpforobjectclass).'Line';
10955
10956 $this->db->begin();
10957
10958 // Call trigger
10959 $result = $this->call_trigger('LINE'.strtoupper($tmpforobjectclass).'_DELETE', $user);
10960 if ($result < 0) {
10961 $error++;
10962 }
10963 // End call triggers
10964
10965 if (empty($error)) {
10966 $sql = "DELETE FROM ".$this->db->prefix().$this->table_element_line;
10967 $sql .= " WHERE rowid = ".((int) $idline);
10968
10969 $resql = $this->db->query($sql);
10970 if (!$resql) {
10971 $this->error = "Error ".$this->db->lasterror();
10972 $error++;
10973 }
10974 }
10975
10976 if (empty($error)) {
10977 // Remove extrafields
10978 $tmpobjectline = new $tmpforobjectlineclass($this->db);
10979 '@phan-var-force CommonObjectLine $tmpobjectline';
10980 if (!isset($tmpobjectline->isextrafieldmanaged) || !empty($tmpobjectline->isextrafieldmanaged)) {
10981 $tmpobjectline->id = $idline;
10982 $result = $tmpobjectline->deleteExtraFields();
10983 if ($result < 0) {
10984 $error++;
10985 $this->error = "Error ".get_class($this)."::deleteLineCommon deleteExtraFields error -4 ".$tmpobjectline->error;
10986 }
10987 }
10988 }
10989
10990 if (empty($error)) {
10991 $this->db->commit();
10992 return 1;
10993 } else {
10994 dol_syslog(get_class($this)."::deleteLineCommon ERROR:".$this->error, LOG_ERR);
10995 $this->db->rollback();
10996 return -1;
10997 }
10998 }
10999
11000
11010 public function setStatusCommon($user, $status, $notrigger = 0, $triggercode = '')
11011 {
11012 $error = 0;
11013
11014 $this->db->begin();
11015
11016 $statusfield = 'status';
11017 if (in_array($this->element, array('don', 'donation', 'shipping'))) {
11018 $statusfield = 'fk_statut';
11019 }
11020
11021 $sql = "UPDATE ".$this->db->prefix().$this->table_element;
11022 $sql .= " SET ".$statusfield." = ".((int) $status);
11023 $sql .= " WHERE rowid = ".((int) $this->id);
11024
11025 if ($this->db->query($sql)) {
11026 if (!$error) {
11027 $this->oldcopy = clone $this;
11028 }
11029
11030 if (!$error && !$notrigger) {
11031 // Call trigger
11032 $result = $this->call_trigger($triggercode, $user);
11033 if ($result < 0) {
11034 $error++;
11035 }
11036 }
11037
11038 if (!$error) {
11039 $this->status = $status;
11040 if (property_exists($this, 'statut')) { // For backward compatibility
11041 $this->statut = $status;
11042 }
11043 $this->db->commit();
11044 return 1;
11045 } else {
11046 $this->db->rollback();
11047 return -1;
11048 }
11049 } else {
11050 $this->error = $this->db->error();
11051 $this->db->rollback();
11052 return -1;
11053 }
11054 }
11055
11062 public function initAsSpecimenCommon()
11063 {
11064 global $user;
11065
11066 $this->id = 0;
11067 $this->specimen = 1;
11068 $fields = array(
11069 'label' => 'This is label',
11070 'ref' => 'ABCD1234',
11071 'description' => 'This is a description',
11072 'qty' => 123.12,
11073 'note_public' => 'Public note',
11074 'note_private' => 'Private note',
11075 'date_creation' => (dol_now() - 3600 * 48),
11076 'date_modification' => (dol_now() - 3600 * 24),
11077 'fk_user_creat' => $user->id,
11078 'fk_user_modif' => $user->id,
11079 'date' => dol_now(),
11080 );
11081 foreach ($fields as $key => $value) {
11082 if (array_key_exists($key, $this->fields)) {
11083 $this->{$key} = $value; // @phpstan-ignore-line
11084 }
11085 }
11086
11087 // Force values to default values when known
11088 if (property_exists($this, 'fields')) {
11089 foreach ($this->fields as $key => $value) {
11090 // If fields are already set, do nothing
11091 if (array_key_exists($key, $fields)) {
11092 continue;
11093 }
11094
11095 if (!empty($value['default'])) {
11096 $this->$key = $value['default'];
11097 }
11098 }
11099 }
11100
11101 return 1;
11102 }
11103
11104
11105 /* Part for comments */
11106
11112 public function fetchComments()
11113 {
11114 require_once DOL_DOCUMENT_ROOT.'/core/class/comment.class.php';
11115
11116 $comment = new Comment($this->db);
11117 $result = $comment->fetchAllFor($this->element, $this->id);
11118 if ($result < 0) {
11119 $this->errors = array_merge($this->errors, $comment->errors);
11120 return -1;
11121 } else {
11122 $this->comments = $comment->comments;
11123 }
11124 return count($this->comments);
11125 }
11126
11132 public function getNbComments()
11133 {
11134 return count($this->comments);
11135 }
11136
11143 public function trimParameters($parameters)
11144 {
11145 if (!is_array($parameters)) {
11146 return;
11147 }
11148 foreach ($parameters as $parameter) {
11149 if (isset($this->$parameter)) {
11150 $this->$parameter = trim($this->$parameter);
11151 }
11152 }
11153 }
11154
11155 /* Part for categories/tags */
11156
11167 public function getCategoriesCommon($type_categ)
11168 {
11169 require_once DOL_DOCUMENT_ROOT.'/categories/class/categorie.class.php';
11170
11171 // Get current categories
11172 $c = new Categorie($this->db);
11173 $existing = $c->containing($this->id, $type_categ, 'id');
11174
11175 return $existing;
11176 }
11177
11190 public function setCategoriesCommon($categories, $type_categ = '', $remove_existing = true)
11191 {
11192 // Handle single category
11193 if (!is_array($categories)) {
11194 $categories = array($categories);
11195 }
11196
11197 dol_syslog(get_class($this)."::setCategoriesCommon Object Id:".$this->id.' type_categ:'.$type_categ.' nb tag add:'.count($categories), LOG_DEBUG);
11198
11199 require_once DOL_DOCUMENT_ROOT.'/categories/class/categorie.class.php';
11200
11201 if (empty($type_categ)) {
11202 dol_syslog(__METHOD__.': Type '.$type_categ.'is an unknown category type. Done nothing.', LOG_ERR);
11203 return -1;
11204 }
11205
11206 // Get current categories
11207 $c = new Categorie($this->db);
11208 $existing = $c->containing($this->id, $type_categ, 'id');
11209 if ($remove_existing) {
11210 // Diff
11211 if (is_array($existing)) {
11212 $to_del = array_diff($existing, $categories);
11213 $to_add = array_diff($categories, $existing);
11214 } else {
11215 $to_del = array(); // Nothing to delete
11216 $to_add = $categories;
11217 }
11218 } else {
11219 $to_del = array(); // Nothing to delete
11220 $to_add = array_diff($categories, $existing);
11221 }
11222
11223 $error = 0;
11224 $ok = 0;
11225
11226 // Process
11227 foreach ($to_del as $del) {
11228 if ($c->fetch($del) > 0) {
11229 $result = $c->del_type($this, $type_categ);
11230 if ($result < 0) {
11231 $error++;
11232 $this->error = $c->error;
11233 $this->errors = $c->errors;
11234 break;
11235 } else {
11236 $ok += $result;
11237 }
11238 }
11239 }
11240 foreach ($to_add as $add) {
11241 if ($c->fetch($add) > 0) {
11242 $result = $c->add_type($this, $type_categ);
11243 if ($result < 0) {
11244 $error++;
11245 $this->error = $c->error;
11246 $this->errors = $c->errors;
11247 break;
11248 } else {
11249 $ok += $result;
11250 }
11251 }
11252 }
11253
11254 return $error ? (-1 * $error) : $ok;
11255 }
11256
11265 public function cloneCategories($fromId, $toId, $type = '')
11266 {
11267 $this->db->begin();
11268
11269 if (empty($type)) {
11270 $type = $this->table_element;
11271 }
11272
11273 require_once DOL_DOCUMENT_ROOT.'/categories/class/categorie.class.php';
11274 $categorystatic = new Categorie($this->db);
11275
11276 $sql = "INSERT INTO ".$this->db->prefix()."categorie_".(empty($categorystatic->MAP_CAT_TABLE[$type]) ? $type : $categorystatic->MAP_CAT_TABLE[$type])." (fk_categorie, fk_product)";
11277 $sql .= " SELECT fk_categorie, $toId FROM ".$this->db->prefix()."categorie_".(empty($categorystatic->MAP_CAT_TABLE[$type]) ? $type : $categorystatic->MAP_CAT_TABLE[$type]);
11278 $sql .= " WHERE fk_product = ".((int) $fromId);
11279
11280 if (!$this->db->query($sql)) {
11281 $this->error = $this->db->lasterror();
11282 $this->db->rollback();
11283 return -1;
11284 }
11285
11286 $this->db->commit();
11287 return 1;
11288 }
11289
11296 public function deleteEcmFiles($mode = 0)
11297 {
11298 global $conf;
11299
11300 $this->db->begin();
11301
11302 // Delete in database with mode 0
11303 if ($mode == 0) {
11304 switch ($this->element) {
11305 case 'propal':
11306 $element = 'propale';
11307 break;
11308 case 'product':
11309 $element = 'produit';
11310 break;
11311 case 'order_supplier':
11312 $element = 'fournisseur/commande';
11313 break;
11314 case 'invoice_supplier':
11315 // Special cases that need to use get_exdir to get real dir of object
11316 // In future, all object should use this to define path of documents.
11317 $element = 'fournisseur/facture/'.get_exdir($this->id, 2, 0, 1, $this, 'invoice_supplier');
11318 break;
11319 case 'shipping':
11320 $element = 'expedition/sending';
11321 break;
11322 case 'task':
11323 case 'project_task':
11324 require_once DOL_DOCUMENT_ROOT.'/projet/class/task.class.php';
11325
11326 $project_result = $this->fetchProject();
11327 if ($project_result >= 0) {
11328 $element = 'projet/'.dol_sanitizeFileName($this->project->ref).'/';
11329 }
11330 // no break
11331 default:
11332 $element = $this->element;
11333 }
11334 '@phan-var-force string $element';
11335
11336 // Delete ecm_files_extrafields with mode 0 (using name)
11337 $sql = "DELETE FROM ".$this->db->prefix()."ecm_files_extrafields WHERE fk_object IN (";
11338 $sql .= " SELECT rowid FROM ".$this->db->prefix()."ecm_files WHERE filename LIKE '".$this->db->escape($this->ref)."%'";
11339 $sql .= " AND filepath = '".$this->db->escape($element)."/".$this->db->escape($this->ref)."' AND entity = ".((int) $conf->entity); // No need of getEntity here
11340 $sql .= ")";
11341
11342 if (!$this->db->query($sql)) {
11343 $this->error = $this->db->lasterror();
11344 $this->db->rollback();
11345 return false;
11346 }
11347
11348 // Delete ecm_files with mode 0 (using name)
11349 $sql = "DELETE FROM ".$this->db->prefix()."ecm_files";
11350 $sql .= " WHERE filename LIKE '".$this->db->escape($this->ref)."%'";
11351 $sql .= " AND filepath = '".$this->db->escape($element)."/".$this->db->escape($this->ref)."' AND entity = ".((int) $conf->entity); // No need of getEntity here
11352
11353 if (!$this->db->query($sql)) {
11354 $this->error = $this->db->lasterror();
11355 $this->db->rollback();
11356 return false;
11357 }
11358 }
11359
11360 // Delete in database with mode 1
11361 if ($mode == 1) {
11362 $sql = 'DELETE FROM '.$this->db->prefix()."ecm_files_extrafields";
11363 $sql .= " WHERE fk_object IN (SELECT rowid FROM ".$this->db->prefix()."ecm_files WHERE src_object_type = '".$this->db->escape($this->table_element.(empty($this->module) ? "" : "@".$this->module))."' AND src_object_id = ".((int) $this->id).")";
11364 $resql = $this->db->query($sql);
11365 if (!$resql) {
11366 $this->error = $this->db->lasterror();
11367 $this->db->rollback();
11368 return false;
11369 }
11370
11371 $sql = 'DELETE FROM '.$this->db->prefix()."ecm_files";
11372 $sql .= " WHERE src_object_type = '".$this->db->escape($this->table_element.(empty($this->module) ? "" : "@".$this->module))."' AND src_object_id = ".((int) $this->id);
11373 $resql = $this->db->query($sql);
11374 if (!$resql) {
11375 $this->error = $this->db->lasterror();
11376 $this->db->rollback();
11377 return false;
11378 }
11379 }
11380
11381 $this->db->commit();
11382 return true;
11383 }
11384}
$id
Definition account.php:48
if( $user->socid > 0) if(! $user->hasRight('accounting', 'chartofaccount')) $object
Definition card.php:66
ajax_combobox($htmlname, $events=array(), $minLengthToAutocomplete=0, $forcefocus=0, $widthTypeOfAutocomplete='resolve', $idforemptyvalue='-1', $morecss='')
Convert a html select field into an ajax combobox.
Definition ajax.lib.php:459
$object ref
Definition info.php:89
Class to manage categories.
Class to manage comment.
Parent class of all other business classes (invoices, contracts, proposals, orders,...
fetch_optionals($rowid=null, $optionsArray=null)
Function to get extra fields of an object into $this->array_options This method is in most cases call...
getCategoriesCommon($type_categ)
Sets object to given categories.
indexFile($destfull, $update_main_doc_field)
Index a file into the ECM database.
getFormatedSupplierRef($objref)
Return supplier ref for screen output.
line_order($renum=false, $rowidorder='ASC', $fk_parent_line=true)
Save a new position (field rang) for details lines.
deleteLineCommon(User $user, $idline, $notrigger=0)
Delete a line of object in database.
isEmpty()
isEmpty We consider CommonObject isEmpty if this->id is empty
clearFieldError($fieldKey)
clear validation message result for a field
static getCountOfItemsLinkedByObjectID($fk_object_where, $field_where, $table_element)
Count items linked to an object id in association table.
deleteEcmFiles($mode=0)
Delete related files of object in database.
getLastMainDocLink($modulepart, $initsharekey=0, $relativelink=0)
Return the link of last main doc file for direct public download.
liste_type_contact($source='internal', $order='position', $option=0, $activeonly=0, $code='')
Return array with list of possible values for type of contacts.
getTooltipContent($params)
getTooltipContent
update_price($exclspec=0, $roundingadjust='auto', $nodatabaseupdate=0, $seller=null)
Update total_ht, total_ttc, total_vat, total_localtax1, total_localtax2 for an object (sum of lines).
swapContactStatus($rowid)
Update status of a contact linked to object.
getFieldError($fieldKey)
get field error message
add_object_linked($origin=null, $origin_id=null, $f_user=null, $notrigger=0)
Add an object link into llx_element_element.
updateObjectLinked($sourceid=null, $sourcetype='', $targetid=null, $targettype='', $f_user=null, $notrigger=0)
Update object linked of a current object.
defineBuyPrice($unitPrice=0.0, $discountPercent=0.0, $fk_product=0)
Get buy price to use for margin calculation.
commonGenerateDocument($modelspath, $modele, $outputlangs, $hidedetails, $hidedesc, $hideref, $moreparams=null)
Common function for all objects extending CommonObject for generating documents.
liste_contact($statusoflink=-1, $source='external', $list=0, $code='', $status=-1, $arrayoftcids=array())
Get array of all contacts for an object.
fetchObjectFrom($table, $field, $key, $element=null)
Load object from specific field.
fetchProject()
Load the project with id $this->fk_project into this->project.
fetch_thirdparty($force_thirdparty_id=0)
Load the third party of object, from id $this->socid or $this->fk_soc, into this->thirdparty.
static deleteAllItemsLinkedByObjectID($fk_object_where, $field_where, $table_element)
Function used to remove all items linked to an object id in association table.
setFieldError($fieldKey, $msg='')
set validation error message a field
validateField($fields, $fieldKey, $fieldValue)
Return validation test result for a field.
getDataToShowPhoto($modulepart, $imagesize)
Function used to get the logos or photos of an object.
setMulticurrencyCode($code)
Change the multicurrency code.
add_element_resource($resource_id, $resource_type, $busy=0, $mandatory=0)
Add resources to the current object : add entry into llx_element_resources Need $this->element & $thi...
emtpyObjectVars()
Sets all object fields to null.
fetch_projet()
Load the project with id $this->fk_project into this->project.
getIdContact($source, $code, $status=0)
Return id of contacts for a source and a contact code.
setExtraField($key, $value)
Convenience method for setting the value of an extrafield without actually updating it in the databas...
setDocModel($user, $modelpdf)
Set last model used by doc generator.
deleteObjectLinked($sourceid=null, $sourcetype='', $targetid=null, $targettype='', $rowid=0, $f_user=null, $notrigger=0)
Delete all links between an object $this.
getExtraField($key)
Convenience method for retrieving the value of an extrafield without actually fetching it from the da...
updateExtraField($key, $trigger=null, $userused=null)
Update 1 extra field value for the current object.
setPaymentTerms($id, $deposit_percent=null)
Change the payments terms.
isFloat($info)
Function test if type is float.
setBankAccount($fk_account, $notrigger=0, $userused=null)
Change the bank account.
setExtraParameters()
Set extra parameters.
setErrorsFromObject($object)
setErrorsFromObject
setShippingMethod($shipping_method_id, $notrigger=0, $userused=null)
Change the shipping method.
update_note_public($note)
Update public note (kept for backward compatibility)
getSpecialCode($lineid)
Get special code of a line.
clearObjectLinkedCache()
Clear the cache saying that all linked object were already loaded.
update_ref_ext($ref_ext)
Update external ref of element.
fetchOneLike($ref)
Looks for an object with ref matching the wildcard provided It does only work when $this->table_ref_f...
hasProductsOrServices($predefined=-1)
Function to say how many lines object contains.
static isExistingObject($element, $id, $ref='', $ref_ext='')
Check if an object id or ref exists If you don't need or want to instantiate the object and just need...
isObjectUsed($id=0, $entity=0)
Function to check if an object is used by others (by children).
updateRangOfLine($rowid, $rang)
Update position of line (rang)
getDefaultCreateValueFor($fieldname, $alternatevalue=null, $type='alphanohtml')
Return the default value to use for a field when showing the create form of object.
createCommon(User $user, $notrigger=0)
Create object in the database.
getTotalWeightVolume()
Return into unit=0, the calculated total of weight and volume of all lines * qty Calculate by adding ...
update_note($note, $suffix='', $notrigger=0)
Update note of element.
getFullAddress($withcountry=0, $sep="\n", $withregion=0, $extralangcode='')
Return full address of contact.
fetch_project()
Load the project with id $this->fk_project into this->project.
setStatut($status, $elementId=null, $elementType='', $trigkey='', $fieldstatus='fk_statut')
Set status of an object.
getFieldList($alias='', $excludefields=array())
Function to concat keys of fields.
getNbComments()
Return nb comments already posted.
setVarsFromFetchObj(&$obj)
Function to load data from a SQL pointer into properties of current object $this.
printObjectLines($action, $seller, $buyer, $selected=0, $dateSelector=0, $defaulttpldir='/core/tpl')
Return HTML table for object lines TODO Move this into an output class file (htmlline....
getChildrenOfLine($id, $includealltree=0)
Get children of line.
updateCommon(User $user, $notrigger=0)
Update object into database.
updateExtraLanguages($key, $trigger=null, $userused=null)
Update an extra language value for the current object.
deleteExtraFields()
Delete all extra fields values for the current object.
setStatusCommon($user, $status, $notrigger=0, $triggercode='')
Set to a status.
deprecatedProperties()
Provide list of deprecated properties and replacements.
addThumbs($file)
Build thumb.
setSaveQuery()
Function to return the array of data key-value from the ->fields and all the ->properties of an objec...
setValuesForExtraLanguages($onlykey='')
Fill array_options property of object by extrafields value (using for data sent by forms)
insertExtraLanguages($trigger='', $userused=null)
Add/Update all extra fields values for the current object.
setTransportMode($id)
Change the transport mode methods.
isArray($info)
Function test if type is array.
isInt($info)
Function test if type is integer.
fetchObjectLinked($sourceid=null, $sourcetype='', $targetid=null, $targettype='', $clause='OR', $alsosametype=1, $orderby='sourcetype', $loadalsoobjects=1)
Fetch array of objects linked to current object (object of enabled modules only).
delete_contact($rowid, $notrigger=0)
Delete a link to contact line.
updateLineUp($rowid, $rang)
Update position of line up (rang)
fetch_user($userid)
Load the user with id $userid into this->user.
errorsToString()
Method to output saved errors.
getListContactId($source='external')
Return list of id of contacts of object.
setWarehouse($warehouse_id)
Change the warehouse.
setDeliveryAddress($id)
Define delivery address.
fetchBarCode()
Load data for barcode into properties ->barcode_type* Properties ->barcode_type that is id of barcode...
getTotalDiscount()
Function that returns the total amount HT of discounts applied for all lines.
initAsSpecimenCommon()
Initialise object with example values Id must be 0 if object instance is a specimen.
printObjectLine($action, $line, $var, $num, $i, $dateSelector, $seller, $buyer, $selected=0, $extrafields=null, $defaulttpldir='/core/tpl')
Return HTML content of a detail line TODO Move this into an output class file (htmlline....
copy_linked_contact($objFrom, $source='internal')
Copy contact from one element to current.
static commonReplaceThirdparty(DoliDB $dbs, $origin_id, $dest_id, array $tables, $ignoreerrors=0)
Function used to replace a thirdparty id with another one.
getValueFrom($table, $id, $field)
Getter generic.
trimParameters($parameters)
Trim object parameters.
fetch_product()
Load the product with id $this->fk_product into this->product.
isIndex($info)
Function test if is indexed.
quote($value, $fieldsentry)
Add quote to field value if necessary.
formAddObjectLine($dateSelector, $seller, $buyer, $defaulttpldir='/core/tpl')
Show add free and predefined products/services form.
fetchComments()
Load comments linked with current task.
line_down($rowid, $fk_parent_line=true)
Update a line to have a higher rank.
setValueFrom($field, $value, $table='', $id=null, $format='', $id_field='', $fuser=null, $trigkey='', $fk_user_field='fk_user_modif')
Setter generic.
fetch_contact($contactid=null)
Load object contact with id=$this->contact_id into $this->contact.
setRetainedWarrantyPaymentTerms($id)
Change the retained warranty payments terms.
delThumbs($file)
Delete thumbs.
show_photos($modulepart, $sdir, $size=0, $nbmax=0, $nbbyrow=5, $showfilename=0, $showaction=0, $maxHeight=120, $maxWidth=160, $nolink=0, $overwritetitle=0, $usesharelink=0, $cache='', $addphotorefcss='photoref')
Show photos of an object (nbmax maximum), into several columns.
fetchLinesCommon($morewhere='', $noextrafields=0)
Load object in memory from the database.
static commonReplaceProduct(DoliDB $dbs, $origin_id, $dest_id, array $tables, $ignoreerrors=0)
Function used to replace a product id with another one.
getRangOfLine($rowid)
Get position of line (rang)
showInputField($val, $key, $value, $moreparam='', $keysuffix='', $keyprefix='', $morecss=0, $nonewbutton=0)
Return HTML string to put an input field into a page Code very similar with showInputField of extra f...
delete_resource($rowid, $element, $notrigger=0)
Delete a link to resource line.
update_contact($rowid, $statut, $type_contact_id=0, $fk_socpeople=0)
Update a link to contact line.
getElementType()
Return an element type string formatted like element_element target_type and source_type.
load_previous_next_ref($filter, $fieldid, $nodbprefix=0)
Load properties id_previous and id_next by comparing $fieldid with $this->ref.
setCategoriesCommon($categories, $type_categ='', $remove_existing=true)
Sets object to given categories.
fetchValuesForExtraLanguages()
Function to get alternative languages of a data into $this->array_languages This method is NOT called...
fetchNoCompute($id)
Function to make a fetch but set environment to avoid to load computed values before.
line_max($fk_parent_line=0)
Get max value used for position of line (rang)
getJSListDependancies($type='_extra')
setProject($projectid, $notrigger=0)
Link element with a project.
isForcedToNullIfZero($info)
Function test if field is forced to null if zero or empty.
line_ajaxorder($rows)
Update position of line with ajax (rang)
printOriginLinesList($restrictlist='', $selectedLines=array())
Return HTML table table of source object lines TODO Move this and previous function into output html ...
fetch_origin()
Read linked origin object.
getIdOfLine($rang)
Get rowid of the line relative to its position.
insertExtraFields($trigger='', $userused=null)
Add/Update all extra fields values for the current object.
deleteByParentField($parentId=0, $parentField='', $filter='', $filtermode="AND")
Delete all child object from a parent ID.
static getAllItemsLinkedByObjectID($fk_object_where, $field_select, $field_where, $table_element)
Function used to get an array with all items linked to an object id in association table.
__clone()
Overwrite magic function to solve problem of cloning object that are kept as references.
setPaymentMethods($id)
Change the payments methods.
updateLineDown($rowid, $rang, $max)
Update position of line down (rang)
delete_linked_contact($source='', $code='')
Delete all links between an object $this and all its contacts in llx_element_contact.
fetchCommon($id, $ref=null, $morewhere='', $noextrafields=0)
Load object in memory from the database.
deleteCommon(User $user, $notrigger=0, $forcechilddeletion=0)
Delete object in database.
getFormatedCustomerRef($objref)
Return customer ref for screen output.
getTooltipContentArray($params)
Return array of data to show into a tooltip.
isText($info)
Function test if type is text.
isDate($info)
Function test if type is date.
printOriginLine($line, $var, $restrictlist='', $defaulttpldir='/core/tpl', $selectedLines=array())
Return HTML with a line of table array of source object lines TODO Move this and previous function in...
showOptionals($extrafields, $mode='view', $params=null, $keysuffix='', $keyprefix='', $onetrtd='', $display_type='card')
Function to show lines of extrafields with output data.
getCanvas($id=0, $ref='')
Load type of canvas of an object if it exists.
line_up($rowid, $fk_parent_line=true)
Update a line to have a lower rank.
isDuration($info)
Function test if type is duration.
canBeNull($info)
Function test if field can be null.
listeTypeContacts($source='internal', $option=0, $activeonly=0, $code='', $element='', $excludeelement='')
Return array with list of possible values for type of contacts.
call_trigger($triggerName, $user)
Call trigger based on this instance.
getRights()
Returns the rights used for this class.
add_contact($fk_socpeople, $type_contact, $source='external', $notrigger=0)
Add a link between element $this->element and a contact.
cloneCategories($fromId, $toId, $type='')
Copy related categories to another object.
fetch_barcode()
Load data for barcode into properties ->barcode_type* Properties ->barcode_type that is id of barcode...
Class to manage contact/addresses.
Class to manage absolute discounts.
Class to manage a WYSIWYG editor.
Class to manage Dolibarr database access.
Class to manage ECM files.
Class to manage standard extra fields.
static isEmptyValue($v, string $type)
Return if a value is "empty" for a mandatory vision.
const TYPE_CREDIT_NOTE
Credit note invoice.
Class to manage generation of HTML components Only common components must be here.
Class to manage triggers.
Parent class to manage intervention document templates.
static getIdAndTxFromCode($dbs, $code, $date_document='')
Get id and rate of currency from code.
Class to manage predefined suppliers products.
Class to manage products or services.
const TYPE_SERVICE
Service.
Class to manage projects.
Class to manage third parties objects (customers, suppliers, prospects...)
Class to manage translations.
Class to manage Dolibarr users.
Class toolbox to validate values.
print $langs trans("Ref").' m titre as m m statut as status
Or an array listing all the potential status of the object: array: int of the status => translated la...
Definition index.php:171
getCountry($searchkey, $withcode='', $dbtouse=null, $outputlangs=null, $entconv=1, $searchlabel='')
Return country label, code or id from an id, code or label.
getState($id, $withcode='0', $dbtouse=null, $withregion=0, $outputlangs=null, $entconv=1)
Return state translated from an id.
convertSecondToTime($iSecond, $format='all', $lengthOfDay=86400, $lengthOfWeek=7)
Return, in clear text, value of a number of seconds in days, hours and minutes.
Definition date.lib.php:244
dol_meta_create($object)
Create a meta file with document file into same directory.
dol_delete_file($file, $disableglob=0, $nophperrors=0, $nohook=0, $object=null, $allowdotdot=false, $indexdatabase=1, $nolog=0)
Remove a file or several files with a mask.
dol_is_file($pathoffile)
Return if path is a file.
dol_dir_list($utf8_path, $types="all", $recursive=0, $filter="", $excludefilter=null, $sortcriteria="name", $sortorder=SORT_ASC, $mode=0, $nohook=0, $relativename="", $donotfollowsymlinks=0, $nbsecondsold=0)
Scan a directory and return a list of files/directories.
Definition files.lib.php:63
completeFileArrayWithDatabaseInfo(&$filearray, $relativedir)
Complete $filearray with data from database.
dol_delete_preview($object)
Delete all preview files linked to object instance.
dol_mktime($hour, $minute, $second, $month, $day, $year, $gm='auto', $check=1)
Return a timestamp date built from detailed information (by default a local PHP server timestamp) Rep...
img_object($titlealt, $picto, $moreatt='', $pictoisfullpath=0, $srconly=0, $notitle=0)
Show a picto called object_picto (generic function)
setEventMessages($mesg, $mesgs, $style='mesgs', $messagekey='', $noduplicate=0, $attop=0)
Set event messages in dol_events session object.
vatrate($rate, $addpercent=false, $info_bits=0, $usestarfornpr=0, $html=0)
Return a string with VAT rate label formatted for view output Used into pdf and HTML pages.
dol_print_ip($ip, $mode=0)
Return an IP formatted to be shown on screen.
img_delete($titlealt='default', $other='class="pictodelete"', $morecss='')
Show delete logo.
img_picto($titlealt, $picto, $moreatt='', $pictoisfullpath=0, $srconly=0, $notitle=0, $alt='', $morecss='', $marginleftonlyshort=2)
Show picto whatever it's its name (generic function)
GETPOSTINT($paramname, $method=0)
Return the value of a $_GET or $_POST supervariable, converted into integer.
dol_format_address($object, $withcountry=0, $sep="\n", $outputlangs=null, $mode=0, $extralangcode='')
Return a formatted address (part address/zip/town/state) according to country rules.
dol_print_phone($phone, $countrycode='', $cid=0, $socid=0, $addlink='', $separ="&nbsp;", $withpicto='', $titlealt='', $adddivfloat=0, $morecss='paddingright')
Format phone numbers according to country.
dol_osencode($str)
Return a string encoded into OS filesystem encoding.
price2num($amount, $rounding='', $option=0)
Function that return a number with universal decimal format (decimal separator is '.
dol_string_nospecial($str, $newstr='_', $badcharstoreplace='', $badcharstoremove='', $keepspaces=0)
Clean a string from all punctuation characters to use it as a ref or login.
dol_eval($s, $returnvalue=1, $hideerrors=1, $onlysimplestring='1')
Replace eval function to add more security.
dol_print_url($url, $target='_blank', $max=32, $withpicto=0, $morecss='')
Show Url link.
price($amount, $form=0, $outlangs='', $trunc=1, $rounding=-1, $forcerounding=-1, $currency_code='')
Function to format a value into an amount for visual output Function used into PDF and HTML pages.
getPictoForType($key, $morecss='')
Return the picto for a data type.
forgeSQLFromUniversalSearchCriteria($filter, &$errorstr='', $noand=0, $nopar=0, $noerror=0)
forgeSQLFromUniversalSearchCriteria
dol_now($mode='auto')
Return date for now.
getDolGlobalInt($key, $default=0)
Return a Dolibarr global constant int value.
getElementProperties($elementType)
Get an array with properties of an element.
dol_escape_js($stringtoescape, $mode=0, $noescapebackslashn=0)
Returns text escaped for inclusion into javascript code.
dol_print_date($time, $format='', $tzoutput='auto', $outputlangs=null, $encodetooutput=false)
Output date in a string format according to outputlangs (or langs if not defined).
dol_sort_array(&$array, $index, $order='asc', $natsort=0, $case_sensitive=0, $keepindex=0)
Advanced sort array by the value of a given key, which produces ascending (default) or descending out...
if(!function_exists( 'dol_getprefix')) dol_include_once($relpath, $classname='')
Make an include_once using default root and alternate root if it fails.
newToken()
Return the value of token currently saved into session with name 'newtoken'.
dol_print_email($email, $cid=0, $socid=0, $addlink=0, $max=64, $showinvalid=1, $withpicto=0, $morecss='paddingrightonly')
Show EMail link formatted for HTML output.
getImageFileNameForSize($file, $extName, $extImgTarget='')
Return the filename of file to get the thumbs.
yn($yesno, $format=1, $color=0)
Return yes or no in current language.
get_date_range($date_start, $date_end, $format='', $outputlangs=null, $withparenthesis=1)
Format output for start and end date.
getAdvancedPreviewUrl($modulepart, $relativepath, $alldata=0, $param='')
Return URL we can use for advanced preview links.
GETPOST($paramname, $check='alphanohtml', $method=0, $filter=null, $options=null, $noreplace=0)
Return value of a param into GET or POST supervariable.
dol_buildpath($path, $type=0, $returnemptyifnotfound=0)
Return path of url or filesystem.
dol_sanitizeFileName($str, $newstr='_', $unaccent=1)
Clean a string to use it as a file name.
dol_print_error($db=null, $error='', $errors=null)
Displays error message system with all the information to facilitate the diagnosis and the escalation...
dol_trunc($string, $size=40, $trunc='right', $stringencoding='UTF-8', $nodot=0, $display=0)
Truncate a string to a particular length adding '…' if string larger than length.
dol_htmlentitiesbr($stringtoencode, $nl2brmode=0, $pagecodefrom='UTF-8', $removelasteolbr=1)
This function is called to encode a string into a HTML string but differs from htmlentities because a...
getDolGlobalString($key, $default='')
Return a Dolibarr global constant string value.
getDictionaryValue($tablename, $field, $id, $checkentity=false, $rowidfield='rowid')
Return the value of a filed into a dictionary for the record $id.
get_exdir($num, $level, $alpha, $withoutslash, $object, $modulepart='')
Return a path to have a the directory according to object where files are stored.
dol_syslog($message, $level=LOG_INFO, $ident=0, $suffixinfilename='', $restricttologhandler='', $logcontext=null)
Write log message into outputs.
getEntity($element, $shared=1, $currentobject=null)
Get list of entity id to use.
dol_sanitizePathName($str, $newstr='_', $unaccent=1)
Clean a string to use it as a path name.
dol_escape_htmltag($stringtoescape, $keepb=0, $keepn=0, $noescapetags='', $escapeonlyhtmltags=0, $cleanalsojavascript=0)
Returns text escaped for inclusion in HTML alt or title or value tags, or into values of HTML input f...
vignette($file, $maxWidth=160, $maxHeight=120, $extName='_small', $quality=50, $outdir='thumbs', $targetformat=0)
Create a thumbnail from an image file (Supported extensions are gif, jpg, png and bmp).
if(!defined( 'IMAGETYPE_WEBP')) getDefaultImageSizes()
Return default values for image sizes.
dol_getImageSize($file, $url=false)
Return size of image file on disk (Supported extensions are gif, jpg, png, bmp and webp)
image_format_supported($file, $acceptsvg=0)
Return if a filename is file name of a supported image format.
query($query, $usesavepoint=0, $type='auto', $result_mode=0)
Execute a SQL request and return the resultset.
global $conf
The following vars must be defined: $type2label $form $conf, $lang, The following vars may also be de...
Definition member.php:79
calcul_price_total($qty, $pu, $remise_percent_ligne, $txtva, $uselocaltax1_rate, $uselocaltax2_rate, $remise_percent_global, $price_base_type, $info_bits, $type, $seller='', $localtaxes_array=[], $progress=100, $multicurrency_tx=1, $pu_devise=0, $multicurrency_code='')
Calculate totals (net, vat, ...) of a line.
Definition price.lib.php:90
$conf db user
Active Directory does not allow anonymous connections.
Definition repair.php:153
if(preg_match('/crypted:/i', $dolibarr_main_db_pass)||!empty($dolibarr_main_db_encrypted_pass)) $conf db type
Definition repair.php:149
getRandomPassword($generic=false, $replaceambiguouschars=null, $length=32)
Return a generated password using default module.
dolEncrypt($chain, $key='', $ciphering='', $forceseed='')
Encode a string with a symmetric encryption.
dolDecrypt($chain, $key='')
Decode a string with a symmetric encryption.
dol_hash($chain, $type='0', $nosalt=0)
Returns a hash (non reversible encryption) of a string.