dolibarr 21.0.4
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
4929 // Check if module is enabled (to avoid error if tables of module not created)
4930 if (isset($element['enabled']) && !empty($element['enabled'])) {
4931 $enabled = (int) dol_eval($element['enabled'], 1);
4932 if (empty($enabled)) {
4933 continue;
4934 }
4935 }
4936
4937 // Check if element can be deleted
4938 $sql = "SELECT COUNT(*) as nb";
4939 $sql .= " FROM ".$this->db->prefix().$table." as c";
4940 if (!empty($element['parent']) && !empty($element['parentkey'])) {
4941 $sql .= ", ".$this->db->prefix().$element['parent']." as p";
4942 }
4943 if (!empty($element['fk_element'])) {
4944 $sql .= " WHERE c.".$element['fk_element']." = ".((int) $id);
4945 } else {
4946 $sql .= " WHERE c.".$this->fk_element." = ".((int) $id);
4947 }
4948 if (!empty($element['parent']) && !empty($element['parentkey'])) {
4949 $sql .= " AND c.".$element['parentkey']." = p.rowid";
4950 }
4951 if (!empty($element['parent']) && !empty($element['parenttypefield']) && !empty($element['parenttypevalue'])) {
4952 $sql .= " AND c.".$element['parenttypefield']." = '".$this->db->escape($element['parenttypevalue'])."'";
4953 }
4954 if (!empty($entity)) {
4955 if (!empty($element['parent']) && !empty($element['parentkey'])) {
4956 $sql .= " AND p.entity = ".((int) $entity);
4957 } else {
4958 $sql .= " AND c.entity = ".((int) $entity);
4959 }
4960 }
4961
4962 $resql = $this->db->query($sql);
4963 if ($resql) {
4964 $obj = $this->db->fetch_object($resql);
4965 if ($obj->nb > 0) {
4966 $langs->load("errors");
4967 //print 'Found into table '.$table.', type '.$langs->transnoentitiesnoconv($elementname).', haschild='.$haschild;
4968 $haschild += $obj->nb;
4969 if (is_numeric($element)) { // very old usage array('table1', 'table2', ...)
4970 $this->errors[] = $langs->transnoentitiesnoconv("ErrorRecordHasAtLeastOneChildOfType", method_exists($this, 'getNomUrl') ? $this->getNomUrl() : $this->ref, $table);
4971 } elseif (is_string($element)) { // old usage array('table1' => 'TranslateKey1', 'table2' => 'TranslateKey2', ...)
4972 $this->errors[] = $langs->transnoentitiesnoconv("ErrorRecordHasAtLeastOneChildOfType", method_exists($this, 'getNomUrl') ? $this->getNomUrl() : $this->ref, $langs->transnoentitiesnoconv($element));
4973 } else { // new usage: $element['name']=Translation key
4974 $this->errors[] = $langs->transnoentitiesnoconv("ErrorRecordHasAtLeastOneChildOfType", method_exists($this, 'getNomUrl') ? $this->getNomUrl() : $this->ref, $langs->transnoentitiesnoconv($element['name']));
4975 }
4976 break; // We found at least one, we stop here
4977 }
4978 } else {
4979 $this->errors[] = $this->db->lasterror();
4980 return -1;
4981 }
4982 }
4983 if ($haschild > 0) {
4984 $this->errors[] = "ErrorRecordHasChildren";
4985 return $haschild;
4986 } else {
4987 return 0;
4988 }
4989 }
4990
4997 public function hasProductsOrServices($predefined = -1)
4998 {
4999 $nb = 0;
5000
5001 foreach ($this->lines as $key => $val) {
5002 $qualified = 0;
5003 if ($predefined == -1) {
5004 $qualified = 1;
5005 }
5006 if ($predefined == 1 && $val->fk_product > 0) {
5007 $qualified = 1;
5008 }
5009 if ($predefined == 0 && $val->fk_product <= 0) {
5010 $qualified = 1;
5011 }
5012 if ($predefined == 2 && $val->fk_product > 0 && $val->product_type == 0) {
5013 $qualified = 1;
5014 }
5015 if ($predefined == 3 && $val->fk_product > 0 && $val->product_type == 1) {
5016 $qualified = 1;
5017 }
5018 if ($qualified) {
5019 $nb++;
5020 }
5021 }
5022 dol_syslog(get_class($this).'::hasProductsOrServices we found '.$nb.' qualified lines of products/servcies');
5023 return $nb;
5024 }
5025
5031 public function getTotalDiscount()
5032 {
5033 if (!empty($this->table_element_line) && ($this->table_element_line != 'expeditiondet')) {
5034 $total_discount = 0.00;
5035
5036 $sql = "SELECT subprice as pu_ht, qty, remise_percent, total_ht";
5037 $sql .= " FROM ".$this->db->prefix().$this->table_element_line;
5038 $sql .= " WHERE ".$this->fk_element." = ".((int) $this->id);
5039
5040 dol_syslog(get_class($this).'::getTotalDiscount', LOG_DEBUG);
5041 $resql = $this->db->query($sql);
5042 if ($resql) {
5043 $num = $this->db->num_rows($resql);
5044 $i = 0;
5045 while ($i < $num) {
5046 $obj = $this->db->fetch_object($resql);
5047
5048 $pu_ht = $obj->pu_ht;
5049 $qty = $obj->qty;
5050 $total_ht = $obj->total_ht;
5051
5052 $total_discount_line = (float) price2num(($pu_ht * $qty) - $total_ht, 'MT');
5053 $total_discount += $total_discount_line;
5054
5055 $i++;
5056 }
5057 }
5058
5059 //print $total_discount; exit;
5060 return (float) price2num($total_discount);
5061 }
5062
5063 return null;
5064 }
5065
5066
5073 public function getTotalWeightVolume()
5074 {
5075 $totalWeight = 0;
5076 $totalVolume = 0;
5077 // defined for shipment only
5078 $totalOrdered = 0;
5079 // defined for shipment only
5080 $totalToShip = 0;
5081
5082 if (empty($this->lines)) {
5083 return array('weight' => $totalWeight, 'volume' => $totalVolume, 'ordered' => $totalOrdered, 'toship' => $totalToShip);
5084 }
5085
5086 foreach ($this->lines as $line) {
5087 if (isset($line->qty_asked)) {
5088 $totalOrdered += $line->qty_asked; // defined for shipment only
5089 }
5090 if (isset($line->qty_shipped)) {
5091 $totalToShip += $line->qty_shipped; // defined for shipment only
5092 } elseif ($line->element == 'commandefournisseurdispatch' && isset($line->qty)) {
5093 if (empty($totalToShip)) {
5094 $totalToShip = 0;
5095 }
5096 $totalToShip += $line->qty; // defined for reception only
5097 }
5098
5099 // Define qty, weight, volume, weight_units, volume_units
5100 if ($this->element == 'shipping') {
5101 // for shipments
5102 $qty = $line->qty_shipped ? $line->qty_shipped : 0;
5103 } else {
5104 $qty = $line->qty ? $line->qty : 0;
5105 }
5106
5107 $weight = !empty($line->weight) ? $line->weight : 0;
5108 ($weight == 0 && !empty($line->product->weight)) ? $weight = $line->product->weight : 0;
5109 $volume = !empty($line->volume) ? $line->volume : 0;
5110 ($volume == 0 && !empty($line->product->volume)) ? $volume = $line->product->volume : 0;
5111
5112 $weight_units = !empty($line->weight_units) ? $line->weight_units : 0;
5113 ($weight_units == 0 && !empty($line->product->weight_units)) ? $weight_units = $line->product->weight_units : 0;
5114 $volume_units = !empty($line->volume_units) ? $line->volume_units : 0;
5115 ($volume_units == 0 && !empty($line->product->volume_units)) ? $volume_units = $line->product->volume_units : 0;
5116
5117 $weightUnit = 0;
5118 $volumeUnit = 0;
5119 if (!empty($weight_units)) {
5120 $weightUnit = $weight_units;
5121 }
5122 if (!empty($volume_units)) {
5123 $volumeUnit = $volume_units;
5124 }
5125
5126 if (empty($totalWeight)) {
5127 $totalWeight = 0; // Avoid warning because $totalWeight is ''
5128 }
5129 if (empty($totalVolume)) {
5130 $totalVolume = 0; // Avoid warning because $totalVolume is ''
5131 }
5132
5133 //var_dump($line->volume_units);
5134 if ($weight_units < 50) { // < 50 means a standard unit (power of 10 of official unit), > 50 means an exotic unit (like inch)
5135 $trueWeightUnit = pow(10, $weightUnit);
5136 $totalWeight += $weight * $qty * $trueWeightUnit;
5137 } else {
5138 if ($weight_units == 99) {
5139 // conversion 1 Pound = 0.45359237 KG
5140 $trueWeightUnit = 0.45359237;
5141 $totalWeight += $weight * $qty * $trueWeightUnit;
5142 } elseif ($weight_units == 98) {
5143 // conversion 1 Ounce = 0.0283495 KG
5144 $trueWeightUnit = 0.0283495;
5145 $totalWeight += $weight * $qty * $trueWeightUnit;
5146 } else {
5147 $totalWeight += $weight * $qty; // This may be wrong if we mix different units
5148 }
5149 }
5150 if ($volume_units < 50) { // >50 means a standard unit (power of 10 of official unit), > 50 means an exotic unit (like inch)
5151 //print $line->volume."x".$line->volume_units."x".($line->volume_units < 50)."x".$volumeUnit;
5152 $trueVolumeUnit = pow(10, $volumeUnit);
5153 //print $line->volume;
5154 $totalVolume += $volume * $qty * $trueVolumeUnit;
5155 } else {
5156 $totalVolume += $volume * $qty; // This may be wrong if we mix different units
5157 }
5158 }
5159
5160 return array('weight' => $totalWeight, 'volume' => $totalVolume, 'ordered' => $totalOrdered, 'toship' => $totalToShip);
5161 }
5162
5163
5169 public function setExtraParameters()
5170 {
5171 $this->db->begin();
5172
5173 $extraparams = (!empty($this->extraparams) ? json_encode($this->extraparams) : null);
5174
5175 $sql = "UPDATE ".$this->db->prefix().$this->table_element;
5176 $sql .= " SET extraparams = ".(!empty($extraparams) ? "'".$this->db->escape($extraparams)."'" : "null");
5177 $sql .= " WHERE rowid = ".((int) $this->id);
5178
5179 dol_syslog(get_class($this)."::setExtraParameters", LOG_DEBUG);
5180 $resql = $this->db->query($sql);
5181 if (!$resql) {
5182 $this->error = $this->db->lasterror();
5183 $this->db->rollback();
5184 return -1;
5185 } else {
5186 $this->db->commit();
5187 return 1;
5188 }
5189 }
5190
5191
5192 // --------------------
5193 // TODO: All functions here must be redesigned and moved as they are not business functions but output functions
5194 // --------------------
5195
5196 /* This is to show add lines */
5197
5207 public function formAddObjectLine($dateSelector, $seller, $buyer, $defaulttpldir = '/core/tpl')
5208 {
5209 global $conf, $user, $langs, $object, $hookmanager, $extrafields, $form;
5210
5211 // Line extrafield
5212 if (!is_object($extrafields)) {
5213 require_once DOL_DOCUMENT_ROOT.'/core/class/extrafields.class.php';
5214 $extrafields = new ExtraFields($this->db);
5215 }
5216 $extrafields->fetch_name_optionals_label($this->table_element_line);
5217
5218 // Output template part (modules that overwrite templates must declare this into descriptor)
5219 // Use global variables + $dateSelector + $seller and $buyer
5220 // Note: This is deprecated. If you need to overwrite the tpl file, use instead the hook 'formAddObjectLine'.
5221 $dirtpls = array_merge($conf->modules_parts['tpl'], array($defaulttpldir));
5222 foreach ($dirtpls as $module => $reldir) {
5223 if (!empty($module)) {
5224 $tpl = dol_buildpath($reldir.'/objectline_create.tpl.php');
5225 } else {
5226 $tpl = DOL_DOCUMENT_ROOT.$reldir.'/objectline_create.tpl.php';
5227 }
5228
5229 if (empty($conf->file->strict_mode)) {
5230 $res = @include $tpl;
5231 } else {
5232 $res = include $tpl; // for debug
5233 }
5234 if ($res) {
5235 break;
5236 }
5237 }
5238 }
5239
5240
5241
5242 /* This is to show array of line of details */
5243
5244
5259 public function printObjectLines($action, $seller, $buyer, $selected = 0, $dateSelector = 0, $defaulttpldir = '/core/tpl')
5260 {
5261 global $conf, $hookmanager, $langs, $user, $form, $extrafields, $object;
5262 // TODO We should not use global var for this
5263 global $inputalsopricewithtax, $usemargins, $disableedit, $disablemove, $disableremove, $outputalsopricetotalwithtax;
5264
5265 // Define $usemargins (used by objectline_xxx.tpl.php files)
5266 $usemargins = 0;
5267 if (isModEnabled('margin') && !empty($this->element) && in_array($this->element, array('facture', 'facturerec', 'propal', 'commande'))) {
5268 $usemargins = 1;
5269 }
5270
5271 $num = count($this->lines);
5272
5273 // Line extrafield
5274 if (!is_object($extrafields)) {
5275 require_once DOL_DOCUMENT_ROOT.'/core/class/extrafields.class.php';
5276 $extrafields = new ExtraFields($this->db);
5277 }
5278 $extrafields->fetch_name_optionals_label($this->table_element_line);
5279
5280 if (method_exists($this, 'loadExpeditions')) {
5281 $this->loadExpeditions();
5282 }
5283
5284 $parameters = array('num' => $num, 'dateSelector' => $dateSelector, 'seller' => $seller, 'buyer' => $buyer, 'selected' => $selected, 'table_element_line' => $this->table_element_line);
5285 $reshook = $hookmanager->executeHooks('printObjectLineTitle', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
5286 if (empty($reshook)) {
5287 // Output template part (modules that overwrite templates must declare this into descriptor)
5288 // Use global variables + $dateSelector + $seller and $buyer
5289 // Note: This is deprecated. If you need to overwrite the tpl file, use instead the hook.
5290 $dirtpls = array_merge($conf->modules_parts['tpl'], array($defaulttpldir));
5291 foreach ($dirtpls as $module => $reldir) {
5292 $res = 0;
5293 if (!empty($module)) {
5294 $tpl = dol_buildpath($reldir.'/objectline_title.tpl.php');
5295 } else {
5296 $tpl = DOL_DOCUMENT_ROOT.$reldir.'/objectline_title.tpl.php';
5297 }
5298 if (file_exists($tpl)) {
5299 if (empty($conf->file->strict_mode)) {
5300 $res = @include $tpl;
5301 } else {
5302 $res = include $tpl; // for debug
5303 }
5304 }
5305 if ($res) {
5306 break;
5307 }
5308 }
5309 }
5310
5311 $i = 0;
5312
5313 print "<!-- begin printObjectLines() -->\n";
5314 foreach ($this->lines as $line) {
5315 //Line extrafield
5316 $line->fetch_optionals();
5317
5318 //if (is_object($hookmanager) && (($line->product_type == 9 && !empty($line->special_code)) || !empty($line->fk_parent_line)))
5319 if (is_object($hookmanager)) { // Old code is commented on preceding line.
5320 if (empty($line->fk_parent_line)) {
5321 $parameters = array('line' => $line, 'num' => $num, 'i' => $i, 'dateSelector' => $dateSelector, 'seller' => $seller, 'buyer' => $buyer, 'selected' => $selected, 'table_element_line' => $line->table_element, 'defaulttpldir' => $defaulttpldir);
5322 $reshook = $hookmanager->executeHooks('printObjectLine', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
5323 } else {
5324 $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);
5325 $reshook = $hookmanager->executeHooks('printObjectSubLine', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
5326 }
5327 }
5328 if (empty($reshook)) {
5329 $this->printObjectLine($action, $line, '', $num, $i, $dateSelector, $seller, $buyer, $selected, $extrafields, $defaulttpldir);
5330 }
5331
5332 $i++;
5333 }
5334 print "<!-- end printObjectLines() -->\n";
5335 }
5336
5354 public function printObjectLine($action, $line, $var, $num, $i, $dateSelector, $seller, $buyer, $selected = 0, $extrafields = null, $defaulttpldir = '/core/tpl')
5355 {
5356 global $conf, $langs, $user, $object, $hookmanager;
5357 global $form;
5358 global $disableedit, $disablemove, $disableremove; // TODO We should not use global var for this !
5359
5360 // var used into tpl
5361 $text = '';
5362 $description = '';
5363
5364 // Line in view mode
5365 if ($action != 'editline' || $selected != $line->id) {
5366 // Product
5367 if (!empty($line->fk_product) && $line->fk_product > 0) {
5368 $product_static = new Product($this->db);
5369 $product_static->fetch($line->fk_product);
5370
5371 $product_static->ref = $line->ref; //can change ref in hook
5372 $product_static->label = !empty($line->label) ? $line->label : ""; //can change label in hook
5373
5374 $text = $product_static->getNomUrl(1);
5375
5376 // Define output language and label
5377 if (getDolGlobalInt('MAIN_MULTILANGS')) {
5378 if (property_exists($this, 'socid') && !is_object($this->thirdparty)) {
5379 dol_print_error(null, 'Error: Method printObjectLine was called on an object and object->fetch_thirdparty was not done before');
5380 return;
5381 }
5382
5383 $prod = new Product($this->db);
5384 $prod->fetch($line->fk_product);
5385
5386 $outputlangs = $langs;
5387 $newlang = '';
5388 if (empty($newlang) && GETPOST('lang_id', 'aZ09')) {
5389 $newlang = GETPOST('lang_id', 'aZ09');
5390 }
5391 if (getDolGlobalString('PRODUIT_TEXTS_IN_THIRDPARTY_LANGUAGE') && empty($newlang) && is_object($this->thirdparty)) {
5392 $newlang = $this->thirdparty->default_lang; // To use language of customer
5393 }
5394 if (!empty($newlang)) {
5395 $outputlangs = new Translate("", $conf);
5396 $outputlangs->setDefaultLang($newlang);
5397 }
5398
5399 $label = (!empty($prod->multilangs[$outputlangs->defaultlang]["label"])) ? $prod->multilangs[$outputlangs->defaultlang]["label"] : $line->product_label;
5400 } else {
5401 $label = $line->product_label;
5402 }
5403
5404 $text .= ' - '.(!empty($line->label) ? $line->label : $label);
5405 $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.
5406 }
5407
5408 $line->pu_ttc = price2num((!empty($line->subprice) ? $line->subprice : 0) * (1 + ((!empty($line->tva_tx) ? $line->tva_tx : 0) / 100)), 'MU');
5409
5410 // Output template part (modules that overwrite templates must declare this into descriptor)
5411 // Use global variables + $dateSelector + $seller and $buyer
5412 // Note: This is deprecated. If you need to overwrite the tpl file, use instead the hook printObjectLine and printObjectSubLine.
5413
5414 $qty_shipped = 0;
5415 if (isset($this->expeditions[$line->id])) {
5416 $qty_shipped = $this->expeditions[$line->id];
5417 }
5418 $disableedit = ($qty_shipped > 0) && ($qty_shipped >= $line->qty);
5419
5420 $dirtpls = array_merge($conf->modules_parts['tpl'], array($defaulttpldir));
5421 foreach ($dirtpls as $module => $reldir) {
5422 $res = 0;
5423 if (!empty($module)) {
5424 $tpl = dol_buildpath($reldir.'/objectline_view.tpl.php');
5425 } else {
5426 $tpl = DOL_DOCUMENT_ROOT.$reldir.'/objectline_view.tpl.php';
5427 }
5428 //var_dump($tpl);
5429 if (file_exists($tpl)) {
5430 if (empty($conf->file->strict_mode)) {
5431 $res = @include $tpl;
5432 } else {
5433 $res = include $tpl; // for debug
5434 }
5435 }
5436 if ($res) {
5437 break;
5438 }
5439 }
5440 }
5441
5442 // Line in update mode
5443 if ($this->status == 0 && $action == 'editline' && $selected == $line->id) {
5444 $label = (!empty($line->label) ? $line->label : (($line->fk_product > 0) ? $line->product_label : ''));
5445
5446 $line->pu_ttc = price2num($line->subprice * (1 + ($line->tva_tx / 100)), 'MU');
5447
5448 // Output template part (modules that overwrite templates must declare this into descriptor)
5449 // Use global variables + $dateSelector + $seller and $buyer
5450 // Note: This is deprecated. If you need to overwrite the tpl file, use instead the hook printObjectLine and printObjectSubLine.
5451 $dirtpls = array_merge($conf->modules_parts['tpl'], array($defaulttpldir));
5452 foreach ($dirtpls as $module => $reldir) {
5453 if (!empty($module)) {
5454 $tpl = dol_buildpath($reldir.'/objectline_edit.tpl.php');
5455 } else {
5456 $tpl = DOL_DOCUMENT_ROOT.$reldir.'/objectline_edit.tpl.php';
5457 }
5458
5459 if (empty($conf->file->strict_mode)) {
5460 $res = @include $tpl;
5461 } else {
5462 $res = include $tpl; // for debug
5463 }
5464 if ($res) {
5465 break;
5466 }
5467 }
5468 }
5469 }
5470
5471
5472 /* This is to show array of line of details of source object */
5473
5474
5485 public function printOriginLinesList($restrictlist = '', $selectedLines = array())
5486 {
5487 global $langs, $hookmanager, $form, $action;
5488
5489 print '<tr class="liste_titre">';
5490 print '<td class="linecolref">'.$langs->trans('Ref').'</td>';
5491 print '<td class="linecoldescription">'.$langs->trans('Description').'</td>';
5492 print '<td class="linecolvat right">'.$langs->trans('VATRate').'</td>';
5493 print '<td class="linecoluht right">'.$langs->trans('PriceUHT').'</td>';
5494 if (isModEnabled("multicurrency")) {
5495 print '<td class="linecoluht_currency right">'.$langs->trans('PriceUHTCurrency').'</td>';
5496 }
5497 print '<td class="linecolqty right">'.$langs->trans('Qty').'</td>';
5498 if (getDolGlobalInt('PRODUCT_USE_UNITS')) {
5499 print '<td class="linecoluseunit left">'.$langs->trans('Unit').'</td>';
5500 }
5501 print '<td class="linecoldiscount right">'.$langs->trans('ReductionShort').'</td>';
5502 print '<td class="linecolht right">'.$langs->trans('TotalHT').'</td>';
5503 print '<td class="center">'.$form->showCheckAddButtons('checkforselect', 1).'</td>';
5504 print '</tr>';
5505 $i = 0;
5506
5507 if (!empty($this->lines)) {
5508 foreach ($this->lines as $line) {
5509 $reshook = 0;
5510 //if (is_object($hookmanager) && (($line->product_type == 9 && !empty($line->special_code)) || !empty($line->fk_parent_line))) {
5511 if (is_object($hookmanager)) { // Old code is commented on preceding line.
5512 $parameters = array('line' => $line, 'i' => $i, 'restrictlist' => $restrictlist, 'selectedLines' => $selectedLines);
5513 if (!empty($line->fk_parent_line)) {
5514 $parameters['fk_parent_line'] = $line->fk_parent_line;
5515 }
5516 $reshook = $hookmanager->executeHooks('printOriginObjectLine', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
5517 }
5518 if (empty($reshook)) {
5519 $this->printOriginLine($line, '', $restrictlist, '/core/tpl', $selectedLines);
5520 }
5521
5522 $i++;
5523 }
5524 }
5525 }
5526
5540 public function printOriginLine($line, $var, $restrictlist = '', $defaulttpldir = '/core/tpl', $selectedLines = array())
5541 {
5542 global $langs, $conf;
5543
5544 //var_dump($line);
5545 if (!empty($line->date_start)) {
5546 // @phan-suppress-next-line PhanUndeclaredProperty
5547 $date_start = $line->date_start;
5548 } else {
5549 $date_start = $line->date_debut_prevue;
5550 if ($line->date_debut_reel) {
5551 $date_start = $line->date_debut_reel;
5552 }
5553 }
5554 if (!empty($line->date_end)) {
5555 // @phan-suppress-next-line PhanUndeclaredProperty
5556 $date_end = $line->date_end;
5557 } else {
5558 $date_end = $line->date_fin_prevue;
5559 if ($line->date_fin_reel) {
5560 $date_end = $line->date_fin_reel;
5561 }
5562 }
5563
5564 $this->tpl['id'] = $line->id;
5565
5566 $this->tpl['label'] = '';
5567 if (!empty($line->fk_parent_line)) {
5568 $this->tpl['label'] .= img_picto('', 'rightarrow');
5569 }
5570
5571 if (($line->info_bits & 2) == 2) { // TODO Not sure this is used for source object
5572 $discount = new DiscountAbsolute($this->db);
5573 if (property_exists($this, 'socid')) {
5574 $discount->fk_soc = $this->socid;
5575 $discount->socid = $this->socid;
5576 }
5577 $this->tpl['label'] .= $discount->getNomUrl(0, 'discount');
5578 } elseif (!empty($line->fk_product)) {
5579 $productstatic = new Product($this->db);
5580 $productstatic->id = $line->fk_product;
5581 $productstatic->ref = $line->ref;
5582 $productstatic->type = $line->fk_product_type;
5583 if (empty($productstatic->ref)) {
5584 $line->fetch_product();
5585 $productstatic = $line->product;
5586 }
5587
5588 $this->tpl['label'] .= $productstatic->getNomUrl(1);
5589 $this->tpl['label'] .= ' - '.(!empty($line->label) ? $line->label : $line->product_label);
5590 // Dates
5591 if ($line->product_type == 1 && ($date_start || $date_end)) {
5592 $this->tpl['label'] .= get_date_range($date_start, $date_end);
5593 }
5594 } else {
5595 $this->tpl['label'] .= ($line->product_type == -1 ? '&nbsp;' : ($line->product_type == 1 ? img_object($langs->trans(''), 'service') : img_object($langs->trans(''), 'product')));
5596 if (!empty($line->desc)) {
5597 $this->tpl['label'] .= $line->desc;
5598 } else {
5599 $this->tpl['label'] .= ($line->label ? '&nbsp;'.$line->label : '');
5600 }
5601
5602 // Dates
5603 if ($line->product_type == 1 && ($date_start || $date_end)) {
5604 $this->tpl['label'] .= get_date_range($date_start, $date_end);
5605 }
5606 }
5607
5608 if (!empty($line->desc)) {
5609 '@phan-var-force OrderLine|FactureLigne|ContratLigne|FactureFournisseurLigneRec|SupplierInvoiceLine|SupplierProposalLine $line';
5610 if ($line->desc == '(CREDIT_NOTE)') { // TODO Not sure this is used for source object
5611 $discount = new DiscountAbsolute($this->db);
5612 $discount->fetch($line->fk_remise_except);
5613 $this->tpl['description'] = $langs->transnoentities("DiscountFromCreditNote", $discount->getNomUrl(0));
5614 } elseif ($line->desc == '(DEPOSIT)') { // TODO Not sure this is used for source object
5615 $discount = new DiscountAbsolute($this->db);
5616 $discount->fetch($line->fk_remise_except);
5617 $this->tpl['description'] = $langs->transnoentities("DiscountFromDeposit", $discount->getNomUrl(0));
5618 } elseif ($line->desc == '(EXCESS RECEIVED)') {
5619 $discount = new DiscountAbsolute($this->db);
5620 $discount->fetch($line->fk_remise_except);
5621 $this->tpl['description'] = $langs->transnoentities("DiscountFromExcessReceived", $discount->getNomUrl(0));
5622 } elseif ($line->desc == '(EXCESS PAID)') {
5623 $discount = new DiscountAbsolute($this->db);
5624 $discount->fetch($line->fk_remise_except);
5625 $this->tpl['description'] = $langs->transnoentities("DiscountFromExcessPaid", $discount->getNomUrl(0));
5626 } else {
5627 $this->tpl['description'] = dol_trunc($line->desc, 60);
5628 }
5629 } else {
5630 $this->tpl['description'] = '&nbsp;';
5631 }
5632
5633 // VAT Rate
5634 $this->tpl['vat_rate'] = vatrate($line->tva_tx, true);
5635 $this->tpl['vat_rate'] .= (($line->info_bits & 1) == 1) ? '*' : '';
5636 if (!empty($line->vat_src_code) && !preg_match('/\‍(/', $this->tpl['vat_rate'])) {
5637 $this->tpl['vat_rate'] .= ' ('.$line->vat_src_code.')';
5638 }
5639
5640 $this->tpl['price'] = price($line->subprice);
5641 $this->tpl['total_ht'] = price($line->total_ht);
5642 $this->tpl['multicurrency_price'] = price($line->multicurrency_subprice);
5643 $this->tpl['qty'] = (($line->info_bits & 2) != 2) ? $line->qty : '&nbsp;';
5644 if (getDolGlobalInt('PRODUCT_USE_UNITS')) {
5645 $this->tpl['unit'] = $line->getLabelOfUnit('long', $langs);
5646 $this->tpl['unit_short'] = $line->getLabelOfUnit('short', $langs);
5647 //$this->tpl['unit_code'] = $line->getLabelOfUnit('code');
5648 }
5649 $this->tpl['remise_percent'] = (($line->info_bits & 2) != 2) ? vatrate((string) $line->remise_percent, true) : '&nbsp;';
5650
5651 // Is the line strike or not
5652 $this->tpl['strike'] = 0;
5653 if ($restrictlist == 'services' && $line->product_type != Product::TYPE_SERVICE) {
5654 $this->tpl['strike'] = 1;
5655 }
5656
5657 // Output template part (modules that overwrite templates must declare this into descriptor)
5658 // Use global variables + $dateSelector + $seller and $buyer
5659 $dirtpls = array_merge($conf->modules_parts['tpl'], array($defaulttpldir));
5660 foreach ($dirtpls as $module => $reldir) {
5661 if (!empty($module)) {
5662 $tpl = dol_buildpath($reldir.'/originproductline.tpl.php');
5663 } else {
5664 $tpl = DOL_DOCUMENT_ROOT.$reldir.'/originproductline.tpl.php';
5665 }
5666
5667 if (empty($conf->file->strict_mode)) {
5668 $res = @include $tpl;
5669 } else {
5670 $res = include $tpl; // for debug
5671 }
5672 if ($res) {
5673 break;
5674 }
5675 }
5676 }
5677
5678
5679 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
5690 public function add_element_resource($resource_id, $resource_type, $busy = 0, $mandatory = 0)
5691 {
5692 // phpcs:enable
5693 $this->db->begin();
5694
5695 $sql = "INSERT INTO ".$this->db->prefix()."element_resources (";
5696 $sql .= "resource_id";
5697 $sql .= ", resource_type";
5698 $sql .= ", element_id";
5699 $sql .= ", element_type";
5700 $sql .= ", busy";
5701 $sql .= ", mandatory";
5702 $sql .= ") VALUES (";
5703 $sql .= ((int) $resource_id);
5704 $sql .= ", '".$this->db->escape($resource_type)."'";
5705 $sql .= ", '".$this->db->escape($this->id)."'";
5706 $sql .= ", '".$this->db->escape($this->element)."'";
5707 $sql .= ", '".$this->db->escape($busy)."'";
5708 $sql .= ", '".$this->db->escape($mandatory)."'";
5709 $sql .= ")";
5710
5711 dol_syslog(get_class($this)."::add_element_resource", LOG_DEBUG);
5712 if ($this->db->query($sql)) {
5713 $this->db->commit();
5714 return 1;
5715 } else {
5716 $this->error = $this->db->lasterror();
5717 $this->db->rollback();
5718 return 0;
5719 }
5720 }
5721
5722 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
5731 public function delete_resource($rowid, $element, $notrigger = 0)
5732 {
5733 // phpcs:enable
5734 global $user;
5735
5736 $this->db->begin();
5737
5738 $sql = "DELETE FROM ".$this->db->prefix()."element_resources";
5739 $sql .= " WHERE rowid = ".((int) $rowid);
5740
5741 dol_syslog(get_class($this)."::delete_resource", LOG_DEBUG);
5742
5743 $resql = $this->db->query($sql);
5744 if (!$resql) {
5745 $this->error = $this->db->lasterror();
5746 $this->db->rollback();
5747 return -1;
5748 } else {
5749 if (!$notrigger) {
5750 $result = $this->call_trigger(strtoupper($element).'_DELETE_RESOURCE', $user);
5751 if ($result < 0) {
5752 $this->db->rollback();
5753 return -1;
5754 }
5755 }
5756 $this->db->commit();
5757 return 1;
5758 }
5759 }
5760
5761
5767 public function __clone()
5768 {
5769 // Force a copy of this->lines, otherwise it will point to same object.
5770 if (isset($this->lines) && is_array($this->lines)) {
5771 $nboflines = count($this->lines);
5772 for ($i = 0; $i < $nboflines; $i++) {
5773 if (is_object($this->lines[$i])) {
5774 $this->lines[$i] = clone $this->lines[$i];
5775 }
5776 }
5777 }
5778 }
5779
5793 protected function commonGenerateDocument($modelspath, $modele, $outputlangs, $hidedetails, $hidedesc, $hideref, $moreparams = null)
5794 {
5795 global $conf, $langs, $user, $hookmanager, $action;
5796
5797 $srctemplatepath = '';
5798
5799 $parameters = array('modelspath' => $modelspath, 'modele' => $modele, 'outputlangs' => $outputlangs, 'hidedetails' => $hidedetails, 'hidedesc' => $hidedesc, 'hideref' => $hideref, 'moreparams' => $moreparams);
5800 $reshook = $hookmanager->executeHooks('commonGenerateDocument', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
5801
5802 if (!empty($reshook)) {
5803 return $reshook;
5804 }
5805
5806 dol_syslog("commonGenerateDocument modele=".$modele." outputlangs->defaultlang=".(is_object($outputlangs) ? $outputlangs->defaultlang : 'null'));
5807
5808 if (empty($modele)) {
5809 $this->error = 'BadValueForParameterModele';
5810 return -1;
5811 }
5812
5813 // Increase limit for PDF build
5814 $err = error_reporting();
5815 error_reporting(0);
5816 @set_time_limit(120);
5817 error_reporting($err);
5818
5819 // If selected model is a filename template (then $modele="modelname" or "modelname:filename")
5820 $tmp = explode(':', $modele, 2);
5821 $saved_model = $modele;
5822 if (!empty($tmp[1])) {
5823 $modele = $tmp[0];
5824 $srctemplatepath = $tmp[1];
5825 }
5826
5827 // Search template files
5828 $file = '';
5829 $classname = '';
5830 $filefound = '';
5831 $dirmodels = array('/');
5832 if (is_array($conf->modules_parts['models'])) {
5833 $dirmodels = array_merge($dirmodels, $conf->modules_parts['models']);
5834 }
5835 foreach ($dirmodels as $reldir) {
5836 foreach (array('doc', 'pdf') as $prefix) {
5837 if (in_array(get_class($this), array('Adherent'))) {
5838 // Member module use prefix_modele.class.php
5839 $file = $prefix."_".$modele.".class.php";
5840 } else {
5841 // Other module use prefix_modele.modules.php
5842 $file = $prefix."_".$modele.".modules.php";
5843 }
5844
5845 $file = dol_sanitizeFileName($file);
5846
5847 // We check if the file exists
5848 $file = dol_buildpath($reldir.$modelspath.$file, 0);
5849 if (file_exists($file)) {
5850 $filefound = $file;
5851 $classname = $prefix.'_'.$modele;
5852 break;
5853 }
5854 }
5855 if ($filefound) {
5856 break;
5857 }
5858 }
5859
5860 if ($filefound === '' || $classname === '') {
5861 $this->error = $langs->trans("Error").' Failed to load doc generator with modelpaths='.$modelspath.' - modele='.$modele;
5862 $this->errors[] = $this->error;
5863 dol_syslog($this->error, LOG_ERR);
5864 return -1;
5865 }
5866
5867 // Sanitize $filefound
5868 $filefound = dol_sanitizePathName($filefound);
5869
5870 // If generator was found
5871 global $db; // Required to solve a conception error making an include of some code that uses $db instead of $this->db just after.
5872
5873 require_once $filefound;
5874
5875 $obj = new $classname($this->db);
5876
5877 // TODO: Check the following classes that seem possible for $obj, but removed for compatibility:
5878 // ModeleBankAccountDoc|ModeleExpenseReport|ModelePDFBom|ModelePDFCommandes|ModelePDFContract|
5879 // ModelePDFDeliveryOrder|ModelePDFEvaluation|ModelePDFFactures|ModelePDFFicheinter|
5880 // ModelePDFMo|ModelePDFMovement|ModelePDFProduct|ModelePDFProjects|ModelePDFPropales|
5881 // ModelePDFRecruitmentJobPosition|ModelePDFSupplierProposal|ModelePDFSuppliersInvoices|
5882 // ModelePDFSuppliersOrders|ModelePDFSuppliersPayments|ModelePdfExpedition|ModelePdfReception|
5883 // ModelePDFStock|ModelePDFStockTransfer|
5884 // ModeleDon|ModelePDFTask|
5885 // ModelePDFAsset|ModelePDFTicket|ModelePDFUserGroup|ModeleThirdPartyDoc|ModelePDFUser
5886 // Has no write_file: ModeleBarCode|ModeleImports|ModeleExports|
5887 '@phan-var-force ModelePDFMember $obj';
5888 // '@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';
5889
5890 // If generator is ODT, we must have srctemplatepath defined, if not we set it.
5891 if ($obj->type == 'odt' && empty($srctemplatepath)) {
5892 $varfortemplatedir = $obj->scandir;
5893 if ($varfortemplatedir && getDolGlobalString($varfortemplatedir)) {
5894 $dirtoscan = getDolGlobalString($varfortemplatedir);
5895
5896 $listoffiles = array();
5897
5898 // Now we add first model found in directories scanned
5899 $listofdir = explode(',', $dirtoscan);
5900 foreach ($listofdir as $key => $tmpdir) {
5901 $tmpdir = trim($tmpdir);
5902 $tmpdir = preg_replace('/DOL_DATA_ROOT/', DOL_DATA_ROOT, $tmpdir);
5903 if (!$tmpdir) {
5904 unset($listofdir[$key]);
5905 continue;
5906 }
5907 if (is_dir($tmpdir)) {
5908 $tmpfiles = dol_dir_list($tmpdir, 'files', 0, '\.od(s|t)$', '', 'name', SORT_ASC, 0);
5909 if (count($tmpfiles)) {
5910 $listoffiles = array_merge($listoffiles, $tmpfiles);
5911 }
5912 }
5913 }
5914
5915 if (count($listoffiles)) {
5916 foreach ($listoffiles as $record) {
5917 $srctemplatepath = $record['fullname'];
5918 break;
5919 }
5920 }
5921 }
5922
5923 if (empty($srctemplatepath)) {
5924 $this->error = 'ErrorGenerationAskedForOdtTemplateWithSrcFileNotDefined';
5925 return -1;
5926 }
5927 }
5928
5929 if ($obj->type == 'odt' && !empty($srctemplatepath)) {
5930 if (!dol_is_file($srctemplatepath)) {
5931 dol_syslog("Failed to locate template file ".$srctemplatepath, LOG_WARNING);
5932 $this->error = 'ErrorGenerationAskedForOdtTemplateWithSrcFileNotFound';
5933 return -1;
5934 }
5935 }
5936
5937 // We save charset_output to restore it because write_file can change it if needed for
5938 // output format that does not support UTF8.
5939 $sav_charset_output = empty($outputlangs->charset_output) ? '' : $outputlangs->charset_output;
5940
5941 // update model_pdf in object
5942 $this->model_pdf = $saved_model;
5943
5944 if ($obj instanceof ModelePDFMember) {
5945 $resultwritefile = $obj->write_file($this, $outputlangs, $srctemplatepath, 'member', 1, 'tmp_cards');
5946 } else {
5947 // TODO: Try to set type above again
5948 '@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';
5949 $resultwritefile = $obj->write_file($this, $outputlangs, $srctemplatepath, $hidedetails, $hidedesc, $hideref, $moreparams);
5950 }
5951 // After call of write_file $obj->result['fullpath'] is set with generated file. It will be used to update the ECM database index.
5952
5953 if ($resultwritefile > 0) {
5954 $outputlangs->charset_output = $sav_charset_output;
5955
5956 // We delete old preview
5957 require_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
5958 dol_delete_preview($this);
5959
5960 // Index file in database
5961 if (!empty($obj->result['fullpath'])) {
5962 $destfull = $obj->result['fullpath'];
5963
5964 // Update the last_main_doc field into main object (if document generator has property ->update_main_doc_field set)
5965 $update_main_doc_field = 0;
5966 if (!empty($obj->update_main_doc_field)) {
5967 $update_main_doc_field = 1;
5968 }
5969
5970 // Check that the file exists, before indexing it.
5971 // Hint: It does not exist, if we create a PDF and auto delete the ODT File
5972 if (dol_is_file($destfull)) {
5973 $this->indexFile($destfull, $update_main_doc_field);
5974 }
5975 } else {
5976 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);
5977 }
5978
5979 // Success in building document. We build meta file.
5980 dol_meta_create($this);
5981
5982 return 1;
5983 } else {
5984 $outputlangs->charset_output = $sav_charset_output;
5985 $this->error = $obj->error;
5986 $this->errors = $obj->errors;
5987 dol_syslog("Error generating document for ".__CLASS__.". Error: ".$obj->error, LOG_ERR);
5988 return -1;
5989 }
5990 }
5991
6001 public function indexFile($destfull, $update_main_doc_field)
6002 {
6003 global $conf, $user;
6004
6005 $upload_dir = dirname($destfull);
6006 $destfile = basename($destfull);
6007 $rel_dir = preg_replace('/^'.preg_quote(DOL_DATA_ROOT, '/').'/', '', $upload_dir);
6008
6009 if (!preg_match('/[\\/]temp[\\/]|[\\/]thumbs|\.meta$/', $rel_dir)) { // If not a tmp dir
6010 $filename = basename($destfile);
6011 $rel_dir = preg_replace('/[\\/]$/', '', $rel_dir);
6012 $rel_dir = preg_replace('/^[\\/]/', '', $rel_dir);
6013
6014 include_once DOL_DOCUMENT_ROOT.'/ecm/class/ecmfiles.class.php';
6015 $ecmfile = new EcmFiles($this->db);
6016 $result = $ecmfile->fetch(0, '', ($rel_dir ? $rel_dir.'/' : '').$filename);
6017
6018 // Set the public "share" key
6019 $setsharekey = false;
6020 if ($this->element == 'propal' || $this->element == 'proposal') {
6021 if (getDolGlobalInt("PROPOSAL_ALLOW_ONLINESIGN")) {
6022 $setsharekey = true; // feature to make online signature is not set or set to on (default)
6023 }
6024 if (getDolGlobalInt("PROPOSAL_ALLOW_EXTERNAL_DOWNLOAD")) {
6025 $setsharekey = true;
6026 }
6027 }
6028 if ($this->element == 'commande' && getDolGlobalInt("ORDER_ALLOW_EXTERNAL_DOWNLOAD")) {
6029 $setsharekey = true;
6030 }
6031 if ($this->element == 'facture' && getDolGlobalInt("INVOICE_ALLOW_EXTERNAL_DOWNLOAD")) {
6032 $setsharekey = true;
6033 }
6034 if ($this->element == 'bank_account' && getDolGlobalInt("BANK_ACCOUNT_ALLOW_EXTERNAL_DOWNLOAD")) {
6035 $setsharekey = true;
6036 }
6037 if ($this->element == 'product' && getDolGlobalInt("PRODUCT_ALLOW_EXTERNAL_DOWNLOAD")) {
6038 $setsharekey = true;
6039 }
6040 if ($this->element == 'contrat' && getDolGlobalInt("CONTRACT_ALLOW_EXTERNAL_DOWNLOAD")) {
6041 $setsharekey = true;
6042 }
6043 if ($this->element == 'fichinter' && getDolGlobalInt("FICHINTER_ALLOW_EXTERNAL_DOWNLOAD")) {
6044 $setsharekey = true;
6045 }
6046 if ($this->element == 'supplier_proposal' && getDolGlobalInt("SUPPLIER_PROPOSAL_ALLOW_EXTERNAL_DOWNLOAD")) {
6047 $setsharekey = true;
6048 }
6049 if ($this->element == 'societe_rib' && getDolGlobalInt("SOCIETE_RIB_ALLOW_ONLINESIGN")) {
6050 $setsharekey = true;
6051 }
6052
6053 if ($setsharekey) {
6054 if (empty($ecmfile->share)) { // Because object not found or share not set yet
6055 require_once DOL_DOCUMENT_ROOT.'/core/lib/security2.lib.php';
6056 $ecmfile->share = getRandomPassword(true);
6057 }
6058 }
6059
6060 if ($result > 0) {
6061 $ecmfile->label = md5_file(dol_osencode($destfull)); // hash of file content
6062 $ecmfile->fullpath_orig = '';
6063 $ecmfile->gen_or_uploaded = 'generated';
6064 $ecmfile->description = ''; // indexed content
6065 $ecmfile->keywords = ''; // keyword content
6066 $ecmfile->src_object_type = $this->table_element;
6067 $ecmfile->src_object_id = $this->id;
6068 $result = $ecmfile->update($user);
6069 if ($result < 0) {
6070 setEventMessages($ecmfile->error, $ecmfile->errors, 'warnings');
6071 return -1;
6072 }
6073 } else {
6074 $ecmfile->entity = $conf->entity;
6075 $ecmfile->filepath = $rel_dir;
6076 $ecmfile->filename = $filename;
6077 $ecmfile->label = md5_file(dol_osencode($destfull)); // hash of file content
6078 $ecmfile->fullpath_orig = '';
6079 $ecmfile->gen_or_uploaded = 'generated';
6080 $ecmfile->description = ''; // indexed content
6081 $ecmfile->keywords = ''; // keyword content
6082 $ecmfile->src_object_type = $this->table_element; // $this->table_name is 'myobject' or 'mymodule_myobject'.
6083 $ecmfile->src_object_id = $this->id;
6084
6085 $result = $ecmfile->create($user);
6086 if ($result < 0) {
6087 setEventMessages($ecmfile->error, $ecmfile->errors, 'warnings');
6088 return -1;
6089 }
6090 }
6091
6092 /*$this->result['fullname']=$destfull;
6093 $this->result['filepath']=$ecmfile->filepath;
6094 $this->result['filename']=$ecmfile->filename;*/
6095 //var_dump($obj->update_main_doc_field);exit;
6096
6097 if ($update_main_doc_field && !empty($this->table_element)) {
6098 $sql = "UPDATE ".$this->db->prefix().$this->table_element." SET last_main_doc = '".$this->db->escape($ecmfile->filepath."/".$ecmfile->filename)."'";
6099 $sql .= " WHERE rowid = ".((int) $this->id);
6100
6101 $resql = $this->db->query($sql);
6102 if (!$resql) {
6103 dol_print_error($this->db);
6104 return -1;
6105 } else {
6106 $this->last_main_doc = $ecmfile->filepath.'/'.$ecmfile->filename;
6107 }
6108 }
6109 }
6110
6111 return 1;
6112 }
6113
6122 public function addThumbs($file, $quality = 50)
6123 {
6124 $file_osencoded = dol_osencode($file);
6125
6126 if (file_exists($file_osencoded)) {
6127 require_once DOL_DOCUMENT_ROOT.'/core/lib/images.lib.php';
6128
6129 $tmparraysize = getDefaultImageSizes();
6130 $maxwidthsmall = $tmparraysize['maxwidthsmall'];
6131 $maxheightsmall = $tmparraysize['maxheightsmall'];
6132 $maxwidthmini = $tmparraysize['maxwidthmini'];
6133 $maxheightmini = $tmparraysize['maxheightmini'];
6134 //$quality = $tmparraysize['quality'];
6135
6136 // Create small thumbs for company (Ratio is near 16/9)
6137 // Used on logon for example
6138 vignette($file_osencoded, $maxwidthsmall, $maxheightsmall, '_small', $quality);
6139
6140 // Create mini thumbs for company (Ratio is near 16/9)
6141 // Used on menu or for setup page for example
6142 vignette($file_osencoded, $maxwidthmini, $maxheightmini, '_mini', $quality);
6143 }
6144 }
6145
6153 public function delThumbs($file)
6154 {
6155 $imgThumbName = getImageFileNameForSize($file, '_small'); // Full path of thumb file
6156 dol_delete_file($imgThumbName);
6157 $imgThumbName = getImageFileNameForSize($file, '_mini'); // Full path of thumb file
6158 dol_delete_file($imgThumbName);
6159 }
6160
6161
6162 /* Functions common to commonobject and commonobjectline */
6163
6164 /* For default values */
6165
6179 public function getDefaultCreateValueFor($fieldname, $alternatevalue = null, $type = 'alphanohtml')
6180 {
6181 // If param here has been posted, we use this value first.
6182 if (GETPOSTISSET($fieldname)) {
6183 return GETPOST($fieldname, $type, 3);
6184 }
6185
6186 if (isset($alternatevalue)) {
6187 return $alternatevalue;
6188 }
6189
6190 $newelement = $this->element;
6191 if ($newelement == 'facture') {
6192 $newelement = 'invoice';
6193 }
6194 if ($newelement == 'commande') {
6195 $newelement = 'order';
6196 }
6197 if (empty($newelement)) {
6198 dol_syslog("Ask a default value using common method getDefaultCreateValueForField on an object with no property ->element defined. Return empty string.", LOG_WARNING);
6199 return '';
6200 }
6201
6202 $keyforfieldname = strtoupper($newelement.'_DEFAULT_'.$fieldname);
6203 //var_dump($keyforfieldname);
6204 if (getDolGlobalString($keyforfieldname)) {
6205 return getDolGlobalString($keyforfieldname);
6206 }
6207
6208 // TODO Ad here a scan into table llx_overwrite_default with a filter on $this->element and $fieldname
6209 // store content into $conf->cache['overwrite_default']
6210
6211 return '';
6212 }
6213
6214
6215 /* For triggers */
6216
6217
6218 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
6229 public function call_trigger($triggerName, $user)
6230 {
6231 // phpcs:enable
6232 global $langs, $conf;
6233
6234 if (!empty(self::TRIGGER_PREFIX) && strpos($triggerName, self::TRIGGER_PREFIX . '_') !== 0) {
6235 dol_print_error(null, 'The trigger "' . $triggerName . '" does not start with "' . self::TRIGGER_PREFIX . '_" as required.');
6236 exit;
6237 }
6238 if (!is_object($langs)) { // If lang was not defined, we set it. It is required by run_triggers().
6239 dol_syslog("call_trigger was called with no langs variable defined".getCallerInfoString(), LOG_WARNING);
6240 include_once DOL_DOCUMENT_ROOT.'/core/class/translate.class.php';
6241 $langs = new Translate('', $conf);
6242 $langs->load("main");
6243 }
6244
6245 include_once DOL_DOCUMENT_ROOT.'/core/class/interfaces.class.php';
6246 $interface = new Interfaces($this->db);
6247 $result = $interface->run_triggers($triggerName, $this, $user, $langs, $conf);
6248
6249 if ($result < 0) {
6250 if (!empty($this->errors)) {
6251 $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.
6252 } else {
6253 $this->errors = $interface->errors;
6254 }
6255 }
6256 return $result;
6257 }
6258
6259
6260 /* Functions for data in other language */
6261
6262
6271 {
6272 // To avoid SQL errors. Probably not the better solution though
6273 if (!$this->element) {
6274 return 0;
6275 }
6276 if (!($this->id > 0)) {
6277 return 0;
6278 }
6279 if (is_array($this->array_languages)) {
6280 return 1;
6281 }
6282
6283 $this->array_languages = array();
6284
6285 $element = $this->element;
6286 if ($element == 'categorie') {
6287 $element = 'categories'; // For compatibility
6288 }
6289
6290 // Request to get translation values for object
6291 $sql = "SELECT rowid, property, lang , value";
6292 $sql .= " FROM ".$this->db->prefix()."object_lang";
6293 $sql .= " WHERE type_object = '".$this->db->escape($element)."'";
6294 $sql .= " AND fk_object = ".((int) $this->id);
6295
6296 //dol_syslog(get_class($this)."::fetch_optionals get extrafields data for ".$this->table_element, LOG_DEBUG); // Too verbose
6297 $resql = $this->db->query($sql);
6298 if ($resql) {
6299 $numrows = $this->db->num_rows($resql);
6300 if ($numrows) {
6301 $i = 0;
6302 while ($i < $numrows) {
6303 $obj = $this->db->fetch_object($resql);
6304 $key = $obj->property;
6305 $value = $obj->value;
6306 $codelang = $obj->lang;
6307 $type = $this->fields[$key]['type'];
6308
6309 // we can add this attribute to object
6310 if (preg_match('/date/', $type)) {
6311 $this->array_languages[$key][$codelang] = $this->db->jdate($value);
6312 } else {
6313 $this->array_languages[$key][$codelang] = $value;
6314 }
6315
6316 $i++;
6317 }
6318 }
6319
6320 $this->db->free($resql);
6321
6322 if ($numrows) {
6323 return $numrows;
6324 } else {
6325 return 0;
6326 }
6327 } else {
6328 dol_print_error($this->db);
6329 return -1;
6330 }
6331 }
6332
6339 public function setValuesForExtraLanguages($onlykey = '')
6340 {
6341 // Get extra fields
6342 foreach ($_POST as $postfieldkey => $postfieldvalue) {
6343 $tmparray = explode('-', $postfieldkey);
6344 if ($tmparray[0] != 'field') {
6345 continue;
6346 }
6347
6348 $element = $tmparray[1];
6349 $key = $tmparray[2];
6350 $codelang = $tmparray[3];
6351 //var_dump("postfieldkey=".$postfieldkey." element=".$element." key=".$key." codelang=".$codelang);
6352
6353 if (!empty($onlykey) && $key != $onlykey) {
6354 continue;
6355 }
6356 if ($element != $this->element) {
6357 continue;
6358 }
6359
6360 $key_type = $this->fields[$key]['type'];
6361
6362 $enabled = 1;
6363 if (isset($this->fields[$key]['enabled'])) {
6364 $enabled = (int) dol_eval($this->fields[$key]['enabled'], 1, 1, '1');
6365 }
6366 /*$perms = 1;
6367 if (isset($this->fields[$key]['perms']))
6368 {
6369 $perms = (int) dol_eval($this->fields[$key]['perms'], 1, 1, '1');
6370 }*/
6371 if (empty($enabled)) {
6372 continue;
6373 }
6374 //if (empty($perms)) continue;
6375
6376 if (in_array($key_type, array('date'))) {
6377 // Clean parameters
6378 // TODO GMT date in memory must be GMT so we should add gm=true in parameters
6379 $value_key = dol_mktime(0, 0, 0, GETPOSTINT($postfieldkey."month"), GETPOSTINT($postfieldkey."day"), GETPOSTINT($postfieldkey."year"));
6380 } elseif (in_array($key_type, array('datetime'))) {
6381 // Clean parameters
6382 // TODO GMT date in memory must be GMT so we should add gm=true in parameters
6383 $value_key = dol_mktime(GETPOSTINT($postfieldkey."hour"), GETPOSTINT($postfieldkey."min"), 0, GETPOSTINT($postfieldkey."month"), GETPOSTINT($postfieldkey."day"), GETPOSTINT($postfieldkey."year"));
6384 } elseif (in_array($key_type, array('checkbox', 'chkbxlst'))) {
6385 $value_arr = GETPOST($postfieldkey, 'array'); // check if an array
6386 if (!empty($value_arr)) {
6387 $value_key = implode(',', $value_arr);
6388 } else {
6389 $value_key = '';
6390 }
6391 } elseif (in_array($key_type, array('price', 'double'))) {
6392 $value_arr = GETPOST($postfieldkey, 'alpha');
6393 $value_key = price2num($value_arr);
6394 } else {
6395 $value_key = GETPOST($postfieldkey);
6396 if (in_array($key_type, array('link')) && $value_key == '-1') {
6397 $value_key = '';
6398 }
6399 }
6400
6401 $this->array_languages[$key][$codelang] = $value_key;
6402
6403 /*if ($nofillrequired) {
6404 $langs->load('errors');
6405 setEventMessages($langs->trans('ErrorFieldsRequired').' : '.implode(', ', $error_field_required), null, 'errors');
6406 return -1;
6407 }*/
6408 }
6409
6410 return 1;
6411 }
6412
6413
6414 /* Functions for extrafields */
6415
6422 public function fetchNoCompute($id)
6423 {
6424 global $conf;
6425
6426 $savDisableCompute = $conf->disable_compute;
6427 $conf->disable_compute = 1;
6428
6429 $ret = $this->fetch($id); /* @phpstan-ignore-line */
6430
6431 $conf->disable_compute = $savDisableCompute;
6432
6433 return $ret;
6434 }
6435
6436 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
6446 public function fetch_optionals($rowid = null, $optionsArray = null)
6447 {
6448 // phpcs:enable
6449 global $conf, $extrafields;
6450
6451 if (empty($rowid)) {
6452 $rowid = $this->id;
6453 }
6454 if (empty($rowid) && isset($this->rowid)) { // @phan-suppress-current-line PhanUndeclaredProperty
6455 $rowid = $this->rowid; // deprecated @phan-suppress-current-line PhanUndeclaredProperty
6456 }
6457
6458 // To avoid SQL errors. Probably not the better solution though
6459 if (!$this->table_element) {
6460 return 0;
6461 }
6462
6463 $this->array_options = array();
6464
6465 if (!is_array($optionsArray)) {
6466 // If $extrafields is not a known object, we initialize it. Best practice is to have $extrafields defined into card.php or list.php page.
6467 if (!isset($extrafields) || !is_object($extrafields)) {
6468 require_once DOL_DOCUMENT_ROOT.'/core/class/extrafields.class.php';
6469 $extrafields = new ExtraFields($this->db);
6470 }
6471
6472 // Load array of extrafields for elementype = $this->table_element
6473 if (empty($extrafields->attributes[$this->table_element]['loaded'])) {
6474 $extrafields->fetch_name_optionals_label($this->table_element);
6475 }
6476 $optionsArray = (!empty($extrafields->attributes[$this->table_element]['label']) ? $extrafields->attributes[$this->table_element]['label'] : null);
6477 } else {
6478 global $extrafields;
6479 dol_syslog("Warning: fetch_optionals was called with param optionsArray defined when you should pass null now", LOG_WARNING);
6480 }
6481
6482 $table_element = $this->table_element;
6483 if ($table_element == 'categorie') {
6484 $table_element = 'categories'; // For compatibility
6485 }
6486
6487 // Request to get complementary values
6488 if (is_array($optionsArray) && count($optionsArray) > 0) {
6489 $sql = "SELECT rowid";
6490 foreach ($optionsArray as $name => $label) {
6491 if (empty($extrafields->attributes[$this->table_element]['type'][$name]) || (!in_array($extrafields->attributes[$this->table_element]['type'][$name], ['separate', 'point', 'multipts', 'linestrg','polygon']))) {
6492 $sql .= ", ".$name;
6493 }
6494 // use geo sql fonction to read as text
6495 if (empty($extrafields->attributes[$this->table_element]['type'][$name]) || $extrafields->attributes[$this->table_element]['type'][$name] == 'point') {
6496 $sql .= ", ST_AsWKT(".$name.") as ".$name;
6497 }
6498 if (empty($extrafields->attributes[$this->table_element]['type'][$name]) || $extrafields->attributes[$this->table_element]['type'][$name] == 'multipts') {
6499 $sql .= ", ST_AsWKT(".$name.") as ".$name;
6500 }
6501 if (empty($extrafields->attributes[$this->table_element]['type'][$name]) || $extrafields->attributes[$this->table_element]['type'][$name] == 'linestrg') {
6502 $sql .= ", ST_AsWKT(".$name.") as ".$name;
6503 }
6504 if (empty($extrafields->attributes[$this->table_element]['type'][$name]) || $extrafields->attributes[$this->table_element]['type'][$name] == 'polygon') {
6505 $sql .= ", ST_AsWKT(".$name.") as ".$name;
6506 }
6507 }
6508 $sql .= " FROM ".$this->db->prefix().$table_element."_extrafields";
6509 $sql .= " WHERE fk_object = ".((int) $rowid);
6510
6511 //dol_syslog(get_class($this)."::fetch_optionals get extrafields data for ".$this->table_element, LOG_DEBUG); // Too verbose
6512 $resql = $this->db->query($sql);
6513 if ($resql) {
6514 $numrows = $this->db->num_rows($resql);
6515 if ($numrows) {
6516 $tab = $this->db->fetch_array($resql);
6517
6518 foreach ($tab as $key => $value) {
6519 // 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)
6520 if ($key != 'rowid' && $key != 'tms' && $key != 'fk_member' && !is_int($key)) {
6521 // we can add this attribute to object
6522 if (!empty($extrafields->attributes[$this->table_element]) && in_array($extrafields->attributes[$this->table_element]['type'][$key], array('date', 'datetime'))) {
6523 //var_dump($extrafields->attributes[$this->table_element]['type'][$key]);
6524 $this->array_options["options_".$key] = $this->db->jdate($value);
6525 } else {
6526 $this->array_options["options_".$key] = $value;
6527 }
6528
6529 //var_dump('key '.$key.' '.$value.' type='.$extrafields->attributes[$this->table_element]['type'][$key].' '.$this->array_options["options_".$key]);
6530 }
6531 if (!empty($extrafields->attributes[$this->table_element]['type'][$key]) && $extrafields->attributes[$this->table_element]['type'][$key] == 'password') {
6532 if (!empty($value) && preg_match('/^dolcrypt:/', $value)) {
6533 $this->array_options["options_".$key] = dolDecrypt($value);
6534 }
6535 }
6536 }
6537 } else {
6542 if (is_array($extrafields->attributes[$this->table_element]['label'])) {
6543 foreach ($extrafields->attributes[$this->table_element]['label'] as $key => $val) {
6544 $this->array_options['options_' . $key] = null;
6545 }
6546 }
6547 }
6548
6549 // If field is a computed field, value must become result of compute (regardless of whether a row exists
6550 // in the element's extrafields table)
6551 if (is_array($extrafields->attributes[$this->table_element]['label'])) {
6552 foreach ($extrafields->attributes[$this->table_element]['label'] as $key => $val) {
6553 if (!empty($extrafields->attributes[$this->table_element]) && !empty($extrafields->attributes[$this->table_element]['computed'][$key])) {
6554 //var_dump($conf->disable_compute);
6555 if (empty($conf->disable_compute)) {
6556 global $objectoffield; // We set a global variable to $objectoffield so
6557 $objectoffield = $this; // we can use it inside computed formula
6558 $this->array_options['options_' . $key] = dol_eval($extrafields->attributes[$this->table_element]['computed'][$key], 1, 0, '2');
6559 }
6560 }
6561 }
6562 }
6563
6564 $this->db->free($resql);
6565
6566 if ($numrows) {
6567 return $numrows;
6568 } else {
6569 return 0;
6570 }
6571 } else {
6572 $this->errors[] = $this->db->lasterror;
6573 return -1;
6574 }
6575 }
6576 return 0;
6577 }
6578
6585 public function deleteExtraFields()
6586 {
6587 global $conf;
6588
6589 if (getDolGlobalString('MAIN_EXTRAFIELDS_DISABLED')) {
6590 return 0;
6591 }
6592
6593 $this->db->begin();
6594
6595 $table_element = $this->table_element;
6596 if ($table_element == 'categorie') {
6597 $table_element = 'categories'; // For compatibility
6598 }
6599
6600 dol_syslog(get_class($this)."::deleteExtraFields delete", LOG_DEBUG);
6601
6602 $sql_del = "DELETE FROM ".$this->db->prefix().$table_element."_extrafields WHERE fk_object = ".((int) $this->id);
6603
6604 $resql = $this->db->query($sql_del);
6605 if (!$resql) {
6606 $this->error = $this->db->lasterror();
6607 $this->db->rollback();
6608 return -1;
6609 } else {
6610 $this->db->commit();
6611 return 1;
6612 }
6613 }
6614
6625 public function insertExtraFields($trigger = '', $userused = null)
6626 {
6627 global $langs, $user;
6628
6629 if (getDolGlobalString('MAIN_EXTRAFIELDS_DISABLED')) {
6630 return 0;
6631 }
6632
6633 if (empty($userused)) {
6634 $userused = $user;
6635 }
6636
6637 $error = 0;
6638
6639 if (!empty($this->array_options)) {
6640 // Check parameters
6641 $langs->load('admin');
6642 require_once DOL_DOCUMENT_ROOT.'/core/class/extrafields.class.php';
6643 $extrafields = new ExtraFields($this->db);
6644 $target_extrafields = $extrafields->fetch_name_optionals_label($this->table_element);
6645
6646 // Eliminate copied source object extra fields that do not exist in target object
6647 $new_array_options = array();
6648 foreach ($this->array_options as $key => $value) {
6649 if (in_array(substr($key, 8), array_keys($target_extrafields))) { // We remove the 'options_' from $key for test
6650 $new_array_options[$key] = $value;
6651 } elseif (in_array($key, array_keys($target_extrafields))) { // We test on $key that does not contain the 'options_' prefix
6652 $new_array_options['options_'.$key] = $value;
6653 }
6654 }
6655
6656 foreach ($new_array_options as $key => $value) {
6657 $attributeKey = substr($key, 8); // Remove 'options_' prefix
6658 $attributeType = $extrafields->attributes[$this->table_element]['type'][$attributeKey];
6659 $attributeLabel = $langs->transnoentities($extrafields->attributes[$this->table_element]['label'][$attributeKey]);
6660 $attributeParam = $extrafields->attributes[$this->table_element]['param'][$attributeKey];
6661 $attributeRequired = $extrafields->attributes[$this->table_element]['required'][$attributeKey];
6662 $attributeUnique = $extrafields->attributes[$this->table_element]['unique'][$attributeKey];
6663 $attrfieldcomputed = $extrafields->attributes[$this->table_element]['computed'][$attributeKey];
6664
6665 // If we clone, we have to clean unique extrafields to prevent duplicates.
6666 // This behaviour can be prevented by external code by changing $this->context['createfromclone'] value in createFrom hook
6667 if (!empty($this->context['createfromclone']) && $this->context['createfromclone'] == 'createfromclone' && !empty($attributeUnique)) {
6668 $new_array_options[$key] = null;
6669 }
6670
6671 // If we create product combination, we have to clean unique extrafields to prevent duplicates.
6672 // This behaviour can be prevented by external code by changing $this->context['createproductcombination'] value in hook
6673 if (!empty($this->context['createproductcombination']) && $this->context['createproductcombination'] == 'createproductcombination' && !empty($attributeUnique)) {
6674 $new_array_options[$key] = null;
6675 }
6676
6677 // Similar code than into insertExtraFields
6678 if ($attributeRequired) {
6679 $v = $this->array_options[$key];
6680 if (ExtraFields::isEmptyValue($v, $attributeType)) {
6681 $langs->load("errors");
6682 dol_syslog("Mandatory field '".$key."' is empty during create and set to required into definition of extrafields");
6683 $this->errors[] = $langs->trans('ErrorFieldRequired', $attributeLabel);
6684 return -1;
6685 }
6686 }
6687
6688 //dol_syslog("attributeLabel=".$attributeLabel, LOG_DEBUG);
6689 //dol_syslog("attributeType=".$attributeType, LOG_DEBUG);
6690
6691 if (!empty($attrfieldcomputed)) {
6692 if (getDolGlobalString('MAIN_STORE_COMPUTED_EXTRAFIELDS')) {
6693 $value = dol_eval($attrfieldcomputed, 1, 0, '2');
6694 dol_syslog($langs->trans("Extrafieldcomputed")." on ".$attributeLabel."(".$value.")", LOG_DEBUG);
6695 $new_array_options[$key] = $value;
6696 } else {
6697 $new_array_options[$key] = null;
6698 }
6699 }
6700
6701 switch ($attributeType) {
6702 case 'int':
6703 if (!is_numeric($value) && $value != '') {
6704 $this->errors[] = $langs->trans("ExtraFieldHasWrongValue", $attributeLabel);
6705 return -1;
6706 } elseif ($value == '') {
6707 $new_array_options[$key] = null;
6708 }
6709 break;
6710 case 'price':
6711 case 'double':
6712 $value = price2num($value);
6713 if (!is_numeric($value) && $value != '') {
6714 dol_syslog($langs->trans("ExtraFieldHasWrongValue")." for ".$attributeLabel."(".$value."is not '".$attributeType."')", LOG_DEBUG);
6715 $this->errors[] = $langs->trans("ExtraFieldHasWrongValue", $attributeLabel);
6716 return -1;
6717 } elseif ($value == '') {
6718 $value = null;
6719 }
6720 //dol_syslog("double value"." on ".$attributeLabel."(".$value." is '".$attributeType."')", LOG_DEBUG);
6721 $new_array_options[$key] = $value;
6722 break;
6723 /*case 'select': // Not required, we chose value='0' for undefined values
6724 if ($value=='-1')
6725 {
6726 $this->array_options[$key] = null;
6727 }
6728 break;*/
6729 case 'password':
6730 $algo = '';
6731 if ($this->array_options[$key] != '' && is_array($extrafields->attributes[$this->table_element]['param'][$attributeKey]['options'])) {
6732 // If there is an encryption choice, we use it to encrypt data before insert
6733 $tmparrays = array_keys($extrafields->attributes[$this->table_element]['param'][$attributeKey]['options']);
6734 $algo = reset($tmparrays);
6735 if ($algo != '') {
6736 //global $action; // $action may be 'create', 'update', 'update_extras'...
6737 //var_dump($action);
6738 //var_dump($this->oldcopy);exit;
6739 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
6740 //var_dump('algo='.$algo.' '.$this->oldcopy->array_options[$key].' -> '.$this->array_options[$key]);
6741 if (isset($this->oldcopy->array_options[$key]) && $this->array_options[$key] == $this->oldcopy->array_options[$key]) {
6742 // If old value encrypted in database is same than submitted new value, it means we don't change it, so we don't update.
6743 if ($algo == 'dolcrypt') { // dolibarr reversible encryption
6744 if (!preg_match('/^dolcrypt:/', $this->array_options[$key])) {
6745 $new_array_options[$key] = dolEncrypt($this->array_options[$key]); // warning, must be called when on the master
6746 } else {
6747 $new_array_options[$key] = $this->array_options[$key]; // Value is kept
6748 }
6749 } else {
6750 $new_array_options[$key] = $this->array_options[$key]; // Value is kept
6751 }
6752 } else {
6753 // If value has changed
6754 if ($algo == 'dolcrypt') { // dolibarr reversible encryption
6755 if (!preg_match('/^dolcrypt:/', $this->array_options[$key])) {
6756 $new_array_options[$key] = dolEncrypt($this->array_options[$key]); // warning, must be called when on the master
6757 } else {
6758 $new_array_options[$key] = $this->array_options[$key]; // Value is kept
6759 }
6760 } else {
6761 $new_array_options[$key] = dol_hash($this->array_options[$key], $algo);
6762 }
6763 }
6764 } else {
6765 //var_dump('jjj'.$algo.' '.$this->oldcopy->array_options[$key].' -> '.$this->array_options[$key]);
6766 // If this->oldcopy is not defined, we can't know if we change attribute or not, so we must keep value
6767 if ($algo == 'dolcrypt' && !preg_match('/^dolcrypt:/', $this->array_options[$key])) { // dolibarr reversible encryption
6768 $new_array_options[$key] = dolEncrypt($this->array_options[$key]); // warning, must be called when on the master
6769 } else {
6770 $new_array_options[$key] = $this->array_options[$key]; // Value is kept
6771 }
6772 }
6773 } else {
6774 // No encryption
6775 $new_array_options[$key] = $this->array_options[$key]; // Value is kept
6776 }
6777 } else { // Common usage
6778 $new_array_options[$key] = $this->array_options[$key]; // Value is kept
6779 }
6780 break;
6781 case 'date':
6782 case 'datetime':
6783 // If data is a string instead of a timestamp, we convert it
6784 if (!is_numeric($this->array_options[$key]) || $this->array_options[$key] != intval($this->array_options[$key])) {
6785 $this->array_options[$key] = strtotime($this->array_options[$key]);
6786 }
6787 $new_array_options[$key] = $this->db->idate($this->array_options[$key]);
6788 break;
6789 case 'datetimegmt':
6790 // If data is a string instead of a timestamp, we convert it
6791 if (!is_numeric($this->array_options[$key]) || $this->array_options[$key] != intval($this->array_options[$key])) {
6792 $this->array_options[$key] = strtotime($this->array_options[$key]);
6793 }
6794 $new_array_options[$key] = $this->db->idate($this->array_options[$key], 'gmt');
6795 break;
6796 case 'link':
6797 $param_list = array_keys($attributeParam['options']);
6798 // 0 : ObjectName
6799 // 1 : classPath
6800 $InfoFieldList = explode(":", $param_list[0]);
6801 dol_include_once($InfoFieldList[1]);
6802 if ($InfoFieldList[0] && class_exists($InfoFieldList[0])) {
6803 if ($value == '-1') { // -1 is key for no defined in combo list of objects
6804 $new_array_options[$key] = '';
6805 } elseif ($value) {
6806 $object = new $InfoFieldList[0]($this->db);
6807 '@phan-var-force CommonObject $object';
6808 if (is_numeric($value)) {
6809 $res = $object->fetch($value); // Common case
6810 } else {
6811 $res = $object->fetch(0, $value); // For compatibility
6812 }
6813
6814 if ($res > 0) {
6815 $new_array_options[$key] = $object->id;
6816 } else {
6817 $this->error = "Id/Ref '".$value."' for object '".$object->element."' not found";
6818 return -1;
6819 }
6820 }
6821 } else {
6822 dol_syslog('Error bad setup of extrafield', LOG_WARNING);
6823 }
6824 break;
6825 case 'checkbox':
6826 case 'chkbxlst':
6827 if (is_array($this->array_options[$key])) {
6828 $new_array_options[$key] = implode(',', $this->array_options[$key]);
6829 } else {
6830 $new_array_options[$key] = $this->array_options[$key];
6831 }
6832 break;
6833 }
6834 }
6835
6836 $this->db->begin();
6837
6838 $table_element = $this->table_element;
6839 if ($table_element == 'categorie') {
6840 $table_element = 'categories'; // For compatibility
6841 }
6842
6843 dol_syslog(get_class($this)."::insertExtraFields delete then insert", LOG_DEBUG);
6844
6845 $sql_del = "DELETE FROM ".$this->db->prefix().$table_element."_extrafields WHERE fk_object = ".((int) $this->id);
6846 $this->db->query($sql_del);
6847
6848 $sql = "INSERT INTO ".$this->db->prefix().$table_element."_extrafields (fk_object";
6849 foreach ($new_array_options as $key => $value) {
6850 $attributeKey = substr($key, 8); // Remove 'options_' prefix
6851 // Add field of attribute
6852 if ($extrafields->attributes[$this->table_element]['type'][$attributeKey] != 'separate') { // Only for other type than separator
6853 $sql .= ",".$attributeKey;
6854 }
6855 }
6856 // We must insert a default value for fields for other entities that are mandatory to avoid not null error
6857 if (!empty($extrafields->attributes[$this->table_element]['mandatoryfieldsofotherentities']) && is_array($extrafields->attributes[$this->table_element]['mandatoryfieldsofotherentities'])) {
6858 foreach ($extrafields->attributes[$this->table_element]['mandatoryfieldsofotherentities'] as $tmpkey => $tmpval) {
6859 if (!isset($extrafields->attributes[$this->table_element]['type'][$tmpkey])) { // If field not already added previously
6860 $sql .= ",".$tmpkey;
6861 }
6862 }
6863 }
6864 $sql .= ") VALUES (".$this->id;
6865
6866 foreach ($new_array_options as $key => $value) {
6867 $attributeKey = substr($key, 8); // Remove 'options_' prefix
6868 // Add field of attribute
6869 if (!in_array($extrafields->attributes[$this->table_element]['type'][$attributeKey], ['separate', 'point', 'multipts', 'linestrg', 'polygon'])) { // Only for other type than separator)
6870 if ($new_array_options[$key] != '' || $new_array_options[$key] == '0') {
6871 $sql .= ",'".$this->db->escape($new_array_options[$key])."'";
6872 } else {
6873 $sql .= ",null";
6874 }
6875 }
6876 if ($extrafields->attributes[$this->table_element]['type'][$attributeKey] == 'point') { // for point type
6877 if (!empty($new_array_options[$key])) {
6878 if (!preg_match('/error/i', $new_array_options[$key])) {
6879 // Text must be a WKT string, so "POINT(15 20)"
6880 $sql .= ",ST_PointFromText('".$this->db->escape($new_array_options[$key])."')";
6881 } else {
6882 dol_syslog("Bad syntax string for point ".$new_array_options[$key]." to generate SQL request", LOG_WARNING);
6883 $sql .= ",null";
6884 }
6885 } else {
6886 $sql .= ",null";
6887 }
6888 }
6889 if ($extrafields->attributes[$this->table_element]['type'][$attributeKey] == 'multipts') { // for point type
6890 if (!empty($new_array_options[$key])) {
6891 if (!preg_match('/error/i', $new_array_options[$key])) {
6892 // Text must be a WKT string, so "MULTIPOINT(0 0, 20 20, 60 60)"
6893 $sql .= ",ST_MultiPointFromText('".$this->db->escape($new_array_options[$key])."')";
6894 } else {
6895 dol_syslog("Bad syntax string for multipoint ".$new_array_options[$key]." to generate SQL request", LOG_WARNING);
6896 $sql .= ",null";
6897 }
6898 } else {
6899 $sql .= ",null";
6900 }
6901 }
6902 if ($extrafields->attributes[$this->table_element]['type'][$attributeKey] == 'linestrg') { // for linestring type
6903 if (!empty($new_array_options[$key])) {
6904 if (!preg_match('/error/i', $new_array_options[$key])) {
6905 // Text must be a WKT string, so "LINESTRING(0 0, 10 10, 20 25, 50 60)"
6906 $sql .= ",ST_LineFromText('".$this->db->escape($new_array_options[$key])."')";
6907 } else {
6908 dol_syslog("Bad syntax string for line ".$new_array_options[$key]." to generate SQL request", LOG_WARNING);
6909 $sql .= ",null";
6910 }
6911 } else {
6912 $sql .= ",null";
6913 }
6914 }
6915 if ($extrafields->attributes[$this->table_element]['type'][$attributeKey] == 'polygon') { // for polygon type
6916 if (!empty($new_array_options[$key])) {
6917 if (!preg_match('/error/i', $new_array_options[$key])) {
6918 // 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))"
6919 $sql .= ",ST_PolyFromText('".$this->db->escape($new_array_options[$key])."')";
6920 } else {
6921 dol_syslog("Bad syntax string for polygon ".$new_array_options[$key]." to generate SQL request", LOG_WARNING);
6922 $sql .= ",null";
6923 }
6924 } else {
6925 $sql .= ",null";
6926 }
6927 }
6928 }
6929 // We must insert a default value for fields for other entities that are mandatory to avoid not null error
6930 if (!empty($extrafields->attributes[$this->table_element]['mandatoryfieldsofotherentities']) && is_array($extrafields->attributes[$this->table_element]['mandatoryfieldsofotherentities'])) {
6931 foreach ($extrafields->attributes[$this->table_element]['mandatoryfieldsofotherentities'] as $tmpkey => $tmpval) {
6932 if (!isset($extrafields->attributes[$this->table_element]['type'][$tmpkey])) { // If field not already added previously
6933 if (in_array($tmpval, array('int', 'double', 'price'))) {
6934 $sql .= ", 0";
6935 } else {
6936 $sql .= ", ''";
6937 }
6938 }
6939 }
6940 }
6941
6942 $sql .= ")";
6943
6944 $resql = $this->db->query($sql);
6945 if (!$resql) {
6946 $this->error = $this->db->lasterror();
6947 $error++;
6948 }
6949
6950 if (!$error && $trigger) {
6951 // Call trigger
6952 $this->context = array('extrafieldaddupdate' => 1);
6953 $result = $this->call_trigger($trigger, $userused);
6954 if ($result < 0) {
6955 $error++;
6956 }
6957 // End call trigger
6958 }
6959
6960 if ($error) {
6961 $this->db->rollback();
6962 return -1;
6963 } else {
6964 $this->db->commit();
6965 return 1;
6966 }
6967 } else {
6968 return 0;
6969 }
6970 }
6971
6982 public function insertExtraLanguages($trigger = '', $userused = null)
6983 {
6984 global $conf, $langs, $user;
6985
6986 if (empty($userused)) {
6987 $userused = $user;
6988 }
6989
6990 $error = 0;
6991
6992 if (getDolGlobalString('MAIN_EXTRALANGUAGES_DISABLED')) {
6993 return 0; // For avoid conflicts if trigger used
6994 }
6995
6996 if (is_array($this->array_languages)) {
6997 $new_array_languages = $this->array_languages;
6998
6999 foreach ($new_array_languages as $key => $value) {
7000 $attributeKey = $key;
7001 $attributeType = $this->fields[$attributeKey]['type'];
7002 $attributeLabel = $this->fields[$attributeKey]['label'];
7003
7004 //dol_syslog("attributeLabel=".$attributeLabel, LOG_DEBUG);
7005 //dol_syslog("attributeType=".$attributeType, LOG_DEBUG);
7006
7007 switch ($attributeType) {
7008 case 'int':
7009 if (is_array($value) || (!is_numeric($value) && $value != '')) {
7010 $this->errors[] = $langs->trans("ExtraLanguageHasWrongValue", $attributeLabel);
7011 return -1;
7012 } elseif ($value == '') { // @phan-suppress-current-line PhanTypeComparisonFromArray
7013 $new_array_languages[$key] = null;
7014 }
7015 break;
7016 case 'double':
7017 $value = price2num((string) $value);
7018 if (!is_numeric($value) && $value != '') {
7019 dol_syslog($langs->trans("ExtraLanguageHasWrongValue")." on ".$attributeLabel."(".$value."is not '".$attributeType."')", LOG_DEBUG);
7020 $this->errors[] = $langs->trans("ExtraLanguageHasWrongValue", $attributeLabel);
7021 return -1;
7022 } elseif ($value == '') {
7023 $new_array_languages[$key] = null;
7024 } else {
7025 $new_array_languages[$key] = $value;
7026 }
7027 break;
7028 /*case 'select': // Not required, we chose value='0' for undefined values
7029 if ($value=='-1')
7030 {
7031 $this->array_options[$key] = null;
7032 }
7033 break;*/
7034 }
7035 }
7036
7037 $this->db->begin();
7038
7039 $table_element = $this->table_element;
7040 if ($table_element == 'categorie') { // TODO Rename table llx_categories_extrafields into llx_categorie_extrafields so we can remove this.
7041 $table_element = 'categories'; // For compatibility
7042 }
7043
7044 dol_syslog(get_class($this)."::insertExtraLanguages delete then insert", LOG_DEBUG);
7045
7046 foreach ($new_array_languages as $key => $langcodearray) { // $key = 'name', 'town', ...
7047 foreach ($langcodearray as $langcode => $value) {
7048 $sql_del = "DELETE FROM ".$this->db->prefix()."object_lang";
7049 $sql_del .= " WHERE fk_object = ".((int) $this->id)." AND property = '".$this->db->escape($key)."' AND type_object = '".$this->db->escape($table_element)."'";
7050 $sql_del .= " AND lang = '".$this->db->escape($langcode)."'";
7051 $this->db->query($sql_del);
7052
7053 if ($value !== '') {
7054 $sql = "INSERT INTO ".$this->db->prefix()."object_lang (fk_object, property, type_object, lang, value";
7055 $sql .= ") VALUES (".$this->id.", '".$this->db->escape($key)."', '".$this->db->escape($table_element)."', '".$this->db->escape($langcode)."', '".$this->db->escape($value)."'";
7056 $sql .= ")";
7057
7058 $resql = $this->db->query($sql);
7059 if (!$resql) {
7060 $this->error = $this->db->lasterror();
7061 $error++;
7062 break;
7063 }
7064 }
7065 }
7066 }
7067
7068 if (!$error && $trigger) {
7069 // Call trigger
7070 $this->context = array('extralanguagesaddupdate' => 1);
7071 $result = $this->call_trigger($trigger, $userused);
7072 if ($result < 0) {
7073 $error++;
7074 }
7075 // End call trigger
7076 }
7077
7078 if ($error) {
7079 $this->db->rollback();
7080 return -1;
7081 } else {
7082 $this->db->commit();
7083 return 1;
7084 }
7085 } else {
7086 return 0;
7087 }
7088 }
7089
7100 public function updateExtraField($key, $trigger = null, $userused = null)
7101 {
7102 global $conf, $langs, $user, $hookmanager;
7103
7104 if (getDolGlobalString('MAIN_EXTRAFIELDS_DISABLED')) {
7105 return 0;
7106 }
7107
7108 if (empty($userused)) {
7109 $userused = $user;
7110 }
7111
7112 $error = 0;
7113
7114 if (!empty($this->array_options) && isset($this->array_options["options_".$key])) {
7115 // Check parameters
7116 $langs->load('admin');
7117 require_once DOL_DOCUMENT_ROOT.'/core/class/extrafields.class.php';
7118 $extrafields = new ExtraFields($this->db);
7119 $extrafields->fetch_name_optionals_label($this->table_element);
7120
7121 $value = $this->array_options["options_".$key];
7122
7123 $attributeKey = $key;
7124 $attributeType = $extrafields->attributes[$this->table_element]['type'][$key];
7125 $attributeLabel = $extrafields->attributes[$this->table_element]['label'][$key];
7126 $attributeParam = $extrafields->attributes[$this->table_element]['param'][$key];
7127 $attributeRequired = $extrafields->attributes[$this->table_element]['required'][$key];
7128 $attributeUnique = $extrafields->attributes[$this->table_element]['unique'][$attributeKey];
7129 $attrfieldcomputed = $extrafields->attributes[$this->table_element]['computed'][$key];
7130
7131 // Similar code than into insertExtraFields
7132 if ($attributeRequired) {
7133 $mandatorypb = false;
7134 if ($attributeType == 'link' && $this->array_options["options_".$key] == '-1') {
7135 $mandatorypb = true;
7136 }
7137 if ($this->array_options["options_".$key] === '') {
7138 $mandatorypb = true;
7139 }
7140 if ($mandatorypb) {
7141 $langs->load("errors");
7142 dol_syslog("Mandatory field 'options_".$key."' is empty during update and set to required into definition of extrafields");
7143 $this->errors[] = $langs->trans('ErrorFieldRequired', $attributeLabel);
7144 return -1;
7145 }
7146 }
7147
7148 // $new_array_options will be used for direct update, so must contains formatted data for the UPDATE.
7149 $new_array_options = $this->array_options;
7150
7151 //dol_syslog("attributeLabel=".$attributeLabel, LOG_DEBUG);
7152 //dol_syslog("attributeType=".$attributeType, LOG_DEBUG);
7153 if (!empty($attrfieldcomputed)) {
7154 if (getDolGlobalString('MAIN_STORE_COMPUTED_EXTRAFIELDS')) {
7155 $value = dol_eval($attrfieldcomputed, 1, 0, '2');
7156 dol_syslog($langs->trans("Extrafieldcomputed")." on ".$attributeLabel."(".$value.")", LOG_DEBUG);
7157
7158 $new_array_options["options_".$key] = $value;
7159
7160 $this->array_options["options_".$key] = $new_array_options["options_".$key];
7161 } else {
7162 $new_array_options["options_".$key] = null;
7163
7164 $this->array_options["options_".$key] = $new_array_options["options_".$key];
7165 }
7166 }
7167
7168 switch ($attributeType) {
7169 case 'int':
7170 if (!is_numeric($value) && $value != '') {
7171 $this->errors[] = $langs->trans("ExtraFieldHasWrongValue", $attributeLabel);
7172 return -1;
7173 } elseif ($value === '') {
7174 $new_array_options["options_".$key] = null;
7175
7176 $this->array_options["options_".$key] = $new_array_options["options_".$key];
7177 }
7178 break;
7179 case 'price':
7180 case 'double':
7181 $value = price2num($value);
7182 if (!is_numeric($value) && $value != '') {
7183 dol_syslog($langs->trans("ExtraFieldHasWrongValue")." on ".$attributeLabel."(".$value."is not '".$attributeType."')", LOG_DEBUG);
7184 $this->errors[] = $langs->trans("ExtraFieldHasWrongValue", $attributeLabel);
7185 return -1;
7186 } elseif ($value === '') {
7187 $value = null;
7188 }
7189 //dol_syslog("double value"." on ".$attributeLabel."(".$value." is '".$attributeType."')", LOG_DEBUG);
7190 $new_array_options["options_".$key] = $value;
7191
7192 $this->array_options["options_".$key] = $new_array_options["options_".$key];
7193 break;
7194 /*case 'select': // Not required, we chose value='0' for undefined values
7195 if ($value=='-1')
7196 {
7197 $new_array_options["options_".$key] = $value;
7198
7199 $this->array_options["options_".$key] = $new_array_options["options_".$key];
7200 }
7201 break;*/
7202 case 'password':
7203 $algo = '';
7204 if ($this->array_options["options_".$key] != '' && is_array($extrafields->attributes[$this->table_element]['param'][$attributeKey]['options'])) {
7205 // If there is an encryption choice, we use it to encrypt data before insert
7206 $tmparrays = array_keys($extrafields->attributes[$this->table_element]['param'][$attributeKey]['options']);
7207 $algo = reset($tmparrays);
7208 if ($algo != '') {
7209 //global $action; // $action may be 'create', 'update', 'update_extras'...
7210 //var_dump($action);
7211 //var_dump($this->oldcopy);exit;
7212 //var_dump($key.' '.$this->array_options["options_".$key].' '.$algo);
7213 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
7214 //var_dump($this->oldcopy->array_options["options_".$key]); var_dump($this->array_options["options_".$key]);
7215 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.
7216 if ($algo == 'dolcrypt') { // dolibarr reversible encryption
7217 if (!preg_match('/^dolcrypt:/', $this->array_options["options_".$key])) {
7218 $new_array_options["options_".$key] = dolEncrypt($this->array_options["options_".$key]); // warning, must be called when on the master
7219 } else {
7220 $new_array_options["options_".$key] = $this->array_options["options_".$key]; // Value is kept
7221 }
7222 } else {
7223 $new_array_options["options_".$key] = $this->array_options["options_".$key]; // Value is kept
7224 }
7225 } else {
7226 if ($algo == 'dolcrypt') { // dolibarr reversible encryption
7227 if (!preg_match('/^dolcrypt:/', $this->array_options["options_".$key])) {
7228 $new_array_options["options_".$key] = dolEncrypt($this->array_options["options_".$key]);
7229 } else {
7230 $new_array_options["options_".$key] = $this->array_options["options_".$key]; // Value is kept
7231 }
7232 } else {
7233 $new_array_options["options_".$key] = dol_hash($this->array_options["options_".$key], $algo);
7234 }
7235 }
7236 } else {
7237 if ($algo == 'dolcrypt' && !preg_match('/^dolcrypt:/', $this->array_options["options_".$key])) { // dolibarr reversible encryption
7238 $new_array_options["options_".$key] = dolEncrypt($this->array_options["options_".$key]); // warning, must be called when on the master
7239 } else {
7240 $new_array_options["options_".$key] = $this->array_options["options_".$key]; // Value is kept
7241 }
7242 }
7243 } else {
7244 // No encryption
7245 $new_array_options["options_".$key] = $this->array_options["options_".$key]; // Value is kept
7246 }
7247 } else { // Common usage
7248 $new_array_options["options_".$key] = $this->array_options["options_".$key]; // Value is kept
7249 }
7250
7251 $this->array_options["options_".$key] = $new_array_options["options_".$key];
7252 break;
7253 case 'date':
7254 case 'datetime':
7255 if (empty($this->array_options["options_".$key])) {
7256 $new_array_options["options_".$key] = null;
7257
7258 $this->array_options["options_".$key] = $new_array_options["options_".$key];
7259 } else {
7260 $new_array_options["options_".$key] = $this->db->idate($this->array_options["options_".$key]);
7261 }
7262 break;
7263 case 'datetimegmt':
7264 if (empty($this->array_options["options_".$key])) {
7265 $new_array_options["options_".$key] = null;
7266
7267 $this->array_options["options_".$key] = $new_array_options["options_".$key];
7268 } else {
7269 $new_array_options["options_".$key] = $this->db->idate($this->array_options["options_".$key], 'gmt');
7270 }
7271 break;
7272 case 'boolean':
7273 if (empty($this->array_options["options_".$key])) {
7274 $new_array_options["options_".$key] = null;
7275
7276 $this->array_options["options_".$key] = $new_array_options["options_".$key];
7277 }
7278 break;
7279 case 'link':
7280 if ($this->array_options["options_".$key] === '') {
7281 $new_array_options["options_".$key] = null;
7282
7283 $this->array_options["options_".$key] = $new_array_options["options_".$key];
7284 }
7285 break;
7286 /*
7287 case 'link':
7288 $param_list = array_keys($attributeParam['options']);
7289 // 0 : ObjectName
7290 // 1 : classPath
7291 $InfoFieldList = explode(":", $param_list[0]);
7292 dol_include_once($InfoFieldList[1]);
7293 if ($InfoFieldList[0] && class_exists($InfoFieldList[0]))
7294 {
7295 if ($value == '-1') // -1 is key for no defined in combo list of objects
7296 {
7297 $new_array_options[$key] = '';
7298 } elseif ($value) {
7299 $object = new $InfoFieldList[0]($this->db);
7300 if (is_numeric($value)) $res = $object->fetch($value); // Common case
7301 else $res = $object->fetch(0, $value); // For compatibility
7302
7303 if ($res > 0) $new_array_options[$key] = $object->id;
7304 else {
7305 $this->error = "Id/Ref '".$value."' for object '".$object->element."' not found";
7306 $this->db->rollback();
7307 return -1;
7308 }
7309 }
7310 } else {
7311 dol_syslog('Error bad setup of extrafield', LOG_WARNING);
7312 }
7313 break;
7314 */
7315 case 'checkbox':
7316 case 'chkbxlst':
7317 $new_array_options = array();
7318 if (is_array($this->array_options["options_".$key])) {
7319 $new_array_options["options_".$key] = implode(',', $this->array_options["options_".$key]);
7320 } else {
7321 $new_array_options["options_".$key] = $this->array_options["options_".$key];
7322 }
7323
7324 $this->array_options["options_".$key] = $new_array_options["options_".$key];
7325 break;
7326 }
7327
7328 $this->db->begin();
7329
7330 $linealreadyfound = 0;
7331
7332 // 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)
7333 $table_element = $this->table_element;
7334 if ($table_element == 'categorie') { // TODO Rename table llx_categories_extrafields into llx_categorie_extrafields so we can remove this.
7335 $table_element = 'categories'; // For compatibility
7336 }
7337
7338 $sql = "SELECT COUNT(rowid) as nb FROM ".$this->db->prefix().$table_element."_extrafields WHERE fk_object = ".((int) $this->id);
7339 $resql = $this->db->query($sql);
7340 if ($resql) {
7341 $tmpobj = $this->db->fetch_object($resql);
7342 if ($tmpobj) {
7343 $linealreadyfound = $tmpobj->nb;
7344 }
7345 }
7346
7347 //var_dump('linealreadyfound='.$linealreadyfound.' sql='.$sql); exit;
7348 if ($linealreadyfound) {
7349 if ($this->array_options["options_".$key] === null) {
7350 $sql = "UPDATE ".$this->db->prefix().$table_element."_extrafields SET ".$key." = null";
7351 } else {
7352 $sql = "UPDATE ".$this->db->prefix().$table_element."_extrafields SET ".$key." = '".$this->db->escape($new_array_options["options_".$key])."'";
7353 }
7354 $sql .= " WHERE fk_object = ".((int) $this->id);
7355
7356 $resql = $this->db->query($sql);
7357 if (!$resql) {
7358 $error++;
7359 $this->error = $this->db->lasterror();
7360 }
7361 } else {
7362 $result = $this->insertExtraFields('', $user);
7363 if ($result < 0) {
7364 $error++;
7365 }
7366 }
7367
7368 if (!$error) {
7369 $parameters = array('key' => $key);
7370 global $action;
7371 $reshook = $hookmanager->executeHooks('updateExtraFieldBeforeCommit', $parameters, $this, $action);
7372 if ($reshook < 0) {
7373 setEventMessages($hookmanager->error, $hookmanager->errors, 'errors');
7374 }
7375 }
7376
7377 if (!$error && $trigger) {
7378 // Call trigger
7379 $this->context = array('extrafieldupdate' => 1);
7380 $result = $this->call_trigger($trigger, $userused);
7381 if ($result < 0) {
7382 $error++;
7383 }
7384 // End call trigger
7385 }
7386
7387 if ($error) {
7388 dol_syslog(__METHOD__.$this->error, LOG_ERR);
7389 $this->db->rollback();
7390 return -1;
7391 } else {
7392 $this->db->commit();
7393 return 1;
7394 }
7395 } else {
7396 return 0;
7397 }
7398 }
7399
7406 public function getExtraField($key)
7407 {
7408 return $this->array_options['options_'.$key] ?? null;
7409 }
7410
7418 public function setExtraField($key, $value)
7419 {
7420 $this->array_options['options_'.$key] = $value;
7421 }
7422
7433 public function updateExtraLanguages($key, $trigger = null, $userused = null)
7434 {
7435 global $conf, $langs, $user;
7436
7437 if (empty($userused)) {
7438 $userused = $user;
7439 }
7440
7441 $error = 0;
7442
7443 if (getDolGlobalString('MAIN_EXTRALANGUAGES_DISABLED')) {
7444 return 0; // For avoid conflicts if trigger used
7445 }
7446
7447 return 0;
7448 }
7449
7450
7466 public function showInputField($val, $key, $value, $moreparam = '', $keysuffix = '', $keyprefix = '', $morecss = 0, $nonewbutton = 0)
7467 {
7468 global $conf, $langs, $form;
7469
7470 // 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...)
7471
7472 if (!is_object($form)) {
7473 require_once DOL_DOCUMENT_ROOT.'/core/class/html.form.class.php';
7474 $form = new Form($this->db);
7475 }
7476
7477 if (!empty($this->fields)) {
7478 $val = $this->fields[$key];
7479 }
7480
7481 // Validation tests and output
7482 $fieldValidationErrorMsg = '';
7483 $validationClass = '';
7484 $fieldValidationErrorMsg = $this->getFieldError($key);
7485 if (!empty($fieldValidationErrorMsg)) {
7486 $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
7487 } else {
7488 $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
7489 }
7490
7491 //$valuemultiselectinput = array();
7492 $out = '';
7493 $type = '';
7494 $isDependList = 0;
7495 $param = array();
7496 $param['options'] = array();
7497 $reg = array();
7498 // @phan-suppress-next-line PhanTypeMismatchProperty
7499 $size = !empty($this->fields[$key]['size']) ? $this->fields[$key]['size'] : 0;
7500 // Because we work on extrafields
7501 if (preg_match('/^(integer|link):(.*):(.*):(.*):(.*)/i', $val['type'], $reg)) {
7502 $param['options'] = array($reg[2].':'.$reg[3].':'.$reg[4].':'.$reg[5] => 'N');
7503 $type = 'link';
7504 } elseif (preg_match('/^(integer|link):(.*):(.*):(.*)/i', $val['type'], $reg)) {
7505 $param['options'] = array($reg[2].':'.$reg[3].':'.$reg[4] => 'N');
7506 $type = 'link';
7507 } elseif (preg_match('/^(integer|link):(.*):(.*)/i', $val['type'], $reg)) {
7508 $param['options'] = array($reg[2].':'.$reg[3] => 'N');
7509 $type = 'link';
7510 } elseif (preg_match('/^(sellist):(.*):(.*):(.*):(.*)/i', $val['type'], $reg)) {
7511 $param['options'] = array($reg[2].':'.$reg[3].':'.$reg[4].':'.$reg[5] => 'N');
7512 $type = 'sellist';
7513 } elseif (preg_match('/^(sellist):(.*):(.*):(.*)/i', $val['type'], $reg)) {
7514 $param['options'] = array($reg[2].':'.$reg[3].':'.$reg[4] => 'N');
7515 $type = 'sellist';
7516 } elseif (preg_match('/^(sellist):(.*):(.*)/i', $val['type'], $reg)) {
7517 $param['options'] = array($reg[2].':'.$reg[3] => 'N');
7518 $type = 'sellist';
7519 } elseif (preg_match('/^chkbxlst:(.*)/i', $val['type'], $reg)) {
7520 $param['options'] = array($reg[1] => 'N');
7521 $type = 'chkbxlst';
7522 } elseif (preg_match('/varchar\‍((\d+)\‍)/', $val['type'], $reg)) {
7523 $param['options'] = array();
7524 $type = 'varchar';
7525 $size = $reg[1];
7526 } elseif (preg_match('/varchar/', $val['type'])) {
7527 $param['options'] = array();
7528 $type = 'varchar';
7529 } elseif (preg_match('/stars\‍((\d+)\‍)/', $val['type'], $reg)) {
7530 $param['options'] = array();
7531 $type = 'stars';
7532 $size = $reg[1];
7533 } else {
7534 $param['options'] = array();
7535 $type = $this->fields[$key]['type'];
7536 }
7537 //var_dump($type); var_dump($param['options']);
7538
7539 // Special case that force options and type ($type can be integer, varchar, ...)
7540 if (!empty($this->fields[$key]['arrayofkeyval']) && is_array($this->fields[$key]['arrayofkeyval'])) {
7541 $param['options'] = $this->fields[$key]['arrayofkeyval'];
7542 // Special case that prevent to force $type to have multiple input @phan-suppress-next-line PhanTypeMismatchProperty
7543 if (empty($this->fields[$key]['multiinput'])) {
7544 $type = (($this->fields[$key]['type'] == 'checkbox') ? $this->fields[$key]['type'] : 'select');
7545 }
7546 }
7547
7548 $label = $this->fields[$key]['label'];
7549 //$elementtype=$this->fields[$key]['elementtype']; // Seems not used
7550 // @phan-suppress-next-line PhanTypeArraySuspiciousNullable
7551 $default = (!empty($this->fields[$key]['default']) ? $this->fields[$key]['default'] : '');
7552 // @phan-suppress-next-line PhanTypeMismatchProperty
7553 $computed = (!empty($this->fields[$key]['computed']) ? $this->fields[$key]['computed'] : '');
7554 // @phan-suppress-next-line PhanTypeMismatchProperty
7555 $unique = (!empty($this->fields[$key]['unique']) ? $this->fields[$key]['unique'] : 0);
7556 // @phan-suppress-next-line PhanTypeMismatchProperty
7557 $required = (!empty($this->fields[$key]['required']) ? $this->fields[$key]['required'] : 0);
7558 // @phan-suppress-next-line PhanTypeMismatchProperty
7559 $autofocusoncreate = (!empty($this->fields[$key]['autofocusoncreate']) ? $this->fields[$key]['autofocusoncreate'] : 0);
7560 // @phan-suppress-next-line PhanTypeMismatchProperty
7561 $placeholder = (!empty($this->fields[$key]['placeholder']) ? $this->fields[$key]['placeholder'] : 0);
7562
7563 // @phan-suppress-next-line PhanTypeMismatchProperty
7564 $langfile = (!empty($this->fields[$key]['langfile']) ? $this->fields[$key]['langfile'] : '');
7565 // @phan-suppress-next-line PhanTypeMismatchProperty
7566 $list = (!empty($this->fields[$key]['list']) ? $this->fields[$key]['list'] : 0);
7567 $hidden = (in_array(abs($this->fields[$key]['visible']), array(0, 2)) ? 1 : 0);
7568
7569 $objectid = $this->id;
7570
7571 if ($computed) {
7572 if (!preg_match('/^search_/', $keyprefix)) {
7573 return '<span class="opacitymedium">'.$langs->trans("AutomaticallyCalculated").'</span>';
7574 } else {
7575 return '';
7576 }
7577 }
7578
7579 // Set value of $morecss. For this, we use in priority showsize from parameters, then $val['css'] then autodefine
7580 if (empty($morecss) && !empty($val['css'])) {
7581 $morecss = $val['css'];
7582 } elseif (empty($morecss)) {
7583 if ($type == 'date') {
7584 $morecss = 'minwidth100imp';
7585 } elseif ($type == 'datetime' || $type == 'link') { // link means an foreign key to another primary id
7586 $morecss = 'minwidth200imp';
7587 } elseif (in_array($type, array('int', 'integer', 'price')) || preg_match('/^double(\‍([0-9],[0-9]\‍)){0,1}/', (string) $type)) {
7588 $morecss = 'maxwidth75';
7589 } elseif ($type == 'url') {
7590 $morecss = 'minwidth400';
7591 } elseif ($type == 'boolean') {
7592 $morecss = '';
7593 } else {
7594 if (is_numeric($size) && round((float) $size) < 12) {
7595 $morecss = 'minwidth100';
7596 } elseif (is_numeric($size) && round((float) $size) <= 48) {
7597 $morecss = 'minwidth200';
7598 } else {
7599 $morecss = 'minwidth400';
7600 }
7601 }
7602 }
7603
7604 // Add validation state class
7605 if (!empty($validationClass)) {
7606 $morecss .= $validationClass;
7607 }
7608
7609 if (in_array($type, array('date'))) {
7610 $tmp = explode(',', $size);
7611 $newsize = $tmp[0];
7612 $showtime = 0;
7613
7614 // Do not show current date when field not required (see selectDate() method)
7615 if (!$required && $value == '') {
7616 $value = '-1';
7617 }
7618
7619 // TODO Must also support $moreparam
7620 $out = $form->selectDate($value, $keyprefix.$key.$keysuffix, $showtime, $showtime, $required, '', 1, (($keyprefix != 'search_' && $keyprefix != 'search_options_') ? 1 : 0), 0, 1);
7621 } elseif (in_array($type, array('datetime'))) {
7622 $tmp = explode(',', $size);
7623 $newsize = $tmp[0];
7624 $showtime = 1;
7625
7626 // Do not show current date when field not required (see selectDate() method)
7627 if (!$required && $value == '') {
7628 $value = '-1';
7629 }
7630
7631 // TODO Must also support $moreparam
7632 $out = $form->selectDate($value, $keyprefix.$key.$keysuffix, $showtime, $showtime, $required, '', 1, (($keyprefix != 'search_' && $keyprefix != 'search_options_') ? 1 : 0), 0, 1, '', '', '', 1, '', '', 'tzuserrel');
7633 } elseif (in_array($type, array('duration'))) {
7634 $out = $form->select_duration($keyprefix.$key.$keysuffix, $value, 0, 'text', 0, 1);
7635 } elseif (in_array($type, array('int', 'integer'))) {
7636 $tmp = explode(',', $size);
7637 $newsize = $tmp[0];
7638 $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' : '').'>';
7639 } elseif (in_array($type, array('real'))) {
7640 $out = '<input type="text" class="flat '.$morecss.'" name="'.$keyprefix.$key.$keysuffix.'" id="'.$keyprefix.$key.$keysuffix.'" value="'.dol_escape_htmltag($value).'"'.($moreparam ? $moreparam : '').($autofocusoncreate ? ' autofocus' : '').'>';
7641 } elseif (preg_match('/varchar/', (string) $type)) {
7642 $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 : '').($placeholder ? ' placeholder="'.dolPrintHTMLForAttribute($placeholder).'"' : '').($autofocusoncreate ? ' autofocus' : '').'>';
7643 } elseif (in_array($type, array('email', 'mail', 'phone', 'url', 'ip'))) {
7644 $out = '<input type="text" class="flat '.$morecss.'" name="'.$keyprefix.$key.$keysuffix.'" id="'.$keyprefix.$key.$keysuffix.'" value="'.dol_escape_htmltag($value).'" '.($moreparam ? $moreparam : '').($autofocusoncreate ? ' autofocus' : '').'>';
7645 } elseif (preg_match('/^text/', (string) $type)) {
7646 if (!preg_match('/search_/', $keyprefix)) { // If keyprefix is search_ or search_options_, we must just use a simple text field
7647 if (!empty($param['options'])) {
7648 // If the textarea field has a list of arrayofkeyval into its definition, we suggest a combo with possible values to fill the textarea.
7649 //var_dump($param['options']);
7650 $out .= $form->selectarray($keyprefix.$key.$keysuffix."_multiinput", $param['options'], '', 1, 0, 0, "flat maxwidthonphone".$morecss);
7651 $out .= '<input id="'.$keyprefix.$key.$keysuffix.'_multiinputadd" type="button" class="button" value="'.$langs->trans("Add").'">';
7652 $out .= "<script>";
7653 $out .= '
7654 function handlemultiinputdisabling(htmlname){
7655 console.log("We handle the disabling of used options for "+htmlname+"_multiinput");
7656 multiinput = $("#"+htmlname+"_multiinput");
7657 multiinput.find("option").each(function(){
7658 tmpval = $("#"+htmlname).val();
7659 tmpvalarray = tmpval.split("\n");
7660 valtotest = $(this).val();
7661 if(tmpvalarray.includes(valtotest)){
7662 $(this).prop("disabled",true);
7663 } else {
7664 if($(this).prop("disabled") == true){
7665 console.log(valtotest)
7666 $(this).prop("disabled", false);
7667 }
7668 }
7669 });
7670 }
7671
7672 $(document).ready(function () {
7673 $("#'.$keyprefix.$key.$keysuffix.'_multiinputadd").on("click",function() {
7674 tmpval = $("#'.$keyprefix.$key.$keysuffix.'").val();
7675 tmpvalarray = tmpval.split(",");
7676 valtotest = $("#'.$keyprefix.$key.$keysuffix.'_multiinput").val();
7677 if(valtotest != -1 && !tmpvalarray.includes(valtotest)){
7678 console.log("We add the selected value to the text area '.$keyprefix.$key.$keysuffix.'");
7679 if(tmpval == ""){
7680 tmpval = valtotest;
7681 } else {
7682 tmpval = tmpval + "\n" + valtotest;
7683 }
7684 $("#'.$keyprefix.$key.$keysuffix.'").val(tmpval);
7685 handlemultiinputdisabling("'.$keyprefix.$key.$keysuffix.'");
7686 $("#'.$keyprefix.$key.$keysuffix.'_multiinput").val(-1);
7687 } else {
7688 console.log("We add nothing the text area '.$keyprefix.$key.$keysuffix.'");
7689 }
7690 });
7691 $("#'.$keyprefix.$key.$keysuffix.'").on("change",function(){
7692 handlemultiinputdisabling("'.$keyprefix.$key.$keysuffix.'");
7693 });
7694 handlemultiinputdisabling("'.$keyprefix.$key.$keysuffix.'");
7695 })';
7696 $out .= "</script>";
7697 $value = str_replace(',', "\n", $value);
7698 }
7699 require_once DOL_DOCUMENT_ROOT.'/core/class/doleditor.class.php';
7700 $doleditor = new DolEditor($keyprefix.$key.$keysuffix, $value, '', 200, 'dolibarr_notes', 'In', false, false, false, ROWS_5, '90%');
7701 $out .= (string) $doleditor->Create(1, '', true, '', '', '', $morecss);
7702 } else {
7703 $out = '<input type="text" class="flat '.$morecss.' maxwidthonsmartphone" name="'.$keyprefix.$key.$keysuffix.'" id="'.$keyprefix.$key.$keysuffix.'" value="'.dol_escape_htmltag($value).'" '.($moreparam ? $moreparam : '').'>';
7704 }
7705 } elseif (preg_match('/^html/', (string) $type)) {
7706 if (!preg_match('/search_/', $keyprefix)) { // If keyprefix is search_ or search_options_, we must just use a simple text field
7707 require_once DOL_DOCUMENT_ROOT.'/core/class/doleditor.class.php';
7708 $doleditor = new DolEditor($keyprefix.$key.$keysuffix, $value, '', 200, 'dolibarr_notes', 'In', false, false, isModEnabled('fckeditor') && getDolGlobalInt('FCKEDITOR_ENABLE_SOCIETE'), ROWS_5, '90%');
7709 $out = (string) $doleditor->Create(1, '', true, '', '', $moreparam, $morecss);
7710 } else {
7711 $out = '<input type="text" class="flat '.$morecss.' maxwidthonsmartphone" name="'.$keyprefix.$key.$keysuffix.'" id="'.$keyprefix.$key.$keysuffix.'" value="'.dol_escape_htmltag($value).'" '.($moreparam ? $moreparam : '').'>';
7712 }
7713 } elseif ($type == 'boolean') {
7714 $checked = '';
7715 if (!empty($value)) {
7716 $checked = ' checked value="1" ';
7717 } else {
7718 $checked = ' value="1" ';
7719 }
7720 $out = '<input type="checkbox" class="flat '.$morecss.' maxwidthonsmartphone" name="'.$keyprefix.$key.$keysuffix.'" id="'.$keyprefix.$key.$keysuffix.'" '.$checked.' '.($moreparam ? $moreparam : '').'>';
7721 } elseif ($type == 'price') {
7722 if (!empty($value)) { // $value in memory is a php numeric, we format it into user number format.
7723 $value = price($value);
7724 }
7725 $out = '<input type="text" class="flat '.$morecss.' maxwidthonsmartphone" name="'.$keyprefix.$key.$keysuffix.'" id="'.$keyprefix.$key.$keysuffix.'" value="'.$value.'" '.($moreparam ? $moreparam : '').'> '.$langs->getCurrencySymbol($conf->currency);
7726 } elseif ($type == 'stars') {
7727 $out = '<input type="hidden" class="flat '.$morecss.'" name="'.$keyprefix.$key.$keysuffix.'" id="'.$keyprefix.$key.$keysuffix.'" value="'.dol_escape_htmltag($value).'"'.($moreparam ? $moreparam : '').($autofocusoncreate ? ' autofocus' : '').'>';
7728 $out .= '<div class="star-selection" id="'.$keyprefix.$key.$keysuffix.'_selection">';
7729 $i = 1;
7730 while ($i <= $size) {
7731 $out .= '<span class="star" data-value="'.$i.'">'.img_picto('', 'fontawesome_star_fas').'</span>';
7732 $i++;
7733 }
7734 $out .= '</div>';
7735 $out .= '<script>
7736 jQuery(function($) {
7737 let container = $("#'.$keyprefix.$key.$keysuffix.'_selection");
7738 let selectedStars = parseInt($("#'.$keyprefix.$key.$keysuffix.'").val()) || 0;
7739 container.find(".star").each(function() {
7740 $(this).toggleClass("active", $(this).data("value") <= selectedStars);
7741 });
7742 container.find(".star").on("mouseover", function() {
7743 let selectedStar = $(this).data("value");
7744 container.find(".star").each(function() {
7745 $(this).toggleClass("active", $(this).data("value") <= selectedStar);
7746 });
7747 });
7748 container.on("mouseout", function() {
7749 container.find(".star").each(function() {
7750 $(this).toggleClass("active", $(this).data("value") <= selectedStars);
7751 });
7752 });
7753 container.find(".star").off("click").on("click", function() {
7754 selectedStars = $(this).data("value");
7755 if (selectedStars === 1 && $("#'.$keyprefix.$key.$keysuffix.'").val() == 1) {
7756 selectedStars = 0;
7757 }
7758 $("#'.$keyprefix.$key.$keysuffix.'").val(selectedStars);
7759 container.find(".star").each(function() {
7760 $(this).toggleClass("active", $(this).data("value") <= selectedStars);
7761 });
7762 });
7763 });
7764 </script>';
7765 } elseif (preg_match('/^double(\‍([0-9],[0-9]\‍)){0,1}/', (string) $type)) {
7766 if (!empty($value)) { // $value in memory is a php numeric, we format it into user number format.
7767 $value = price($value);
7768 }
7769 $out = '<input type="text" class="flat '.$morecss.' maxwidthonsmartphone" name="'.$keyprefix.$key.$keysuffix.'" id="'.$keyprefix.$key.$keysuffix.'" value="'.$value.'" '.($moreparam ? $moreparam : '').'> ';
7770 } elseif ($type == 'select') { // combo list
7771 $out = '';
7772 if (!empty($conf->use_javascript_ajax) && !getDolGlobalString('MAIN_EXTRAFIELDS_DISABLE_SELECT2')) {
7773 include_once DOL_DOCUMENT_ROOT.'/core/lib/ajax.lib.php';
7774 $out .= ajax_combobox($keyprefix.$key.$keysuffix, array(), 0);
7775 }
7776
7777 $tmpselect = '';
7778 $nbchoice = 0;
7779
7780 foreach ($param['options'] as $keyb => $valb) {
7781 if ((string) $keyb == '') {
7782 continue;
7783 }
7784 if (strpos($valb, "|") !== false) {
7785 list($valb, $parent) = explode('|', $valb);
7786 }
7787 $nbchoice++;
7788 $tmpselect .= '<option value="'.$keyb.'"';
7789 $tmpselect .= (((string) $value == (string) $keyb) ? ' selected' : '');
7790 if (!empty($parent)) {
7791 $isDependList = 1;
7792 }
7793 $tmpselect .= (!empty($parent) ? ' parent="'.$parent.'"' : '');
7794 $tmpselect .= '>'.$langs->trans($valb).'</option>';
7795 }
7796
7797 $out .= '<select class="flat '.$morecss.' maxwidthonsmartphone" name="'.$keyprefix.$key.$keysuffix.'" id="'.$keyprefix.$key.$keysuffix.'" '.($moreparam ? $moreparam : '').'>';
7798 if ((!isset($this->fields[$key]['default'])) || empty($this->fields[$key]['notnull']) || ($this->fields[$key]['notnull'] != 1) || $nbchoice >= 2) {
7799 $out .= '<option value="0">&nbsp;</option>';
7800 }
7801 $out .= $tmpselect;
7802 $out .= '</select>';
7803 } elseif ($type == 'sellist') {
7804 $out = '';
7805 if (!empty($conf->use_javascript_ajax) && !getDolGlobalString('MAIN_EXTRAFIELDS_DISABLE_SELECT2')) {
7806 include_once DOL_DOCUMENT_ROOT.'/core/lib/ajax.lib.php';
7807 $out .= ajax_combobox($keyprefix.$key.$keysuffix, array(), 0);
7808 }
7809
7810 $out .= '<select class="flat '.$morecss.' maxwidthonsmartphone" name="'.$keyprefix.$key.$keysuffix.'" id="'.$keyprefix.$key.$keysuffix.'" '.($moreparam ? $moreparam : '').'>';
7811 if (is_array($param['options'])) {
7812 $tmpparamoptions = array_keys($param['options']);
7813 $paramoptions = preg_split('/[\r\n]+/', $tmpparamoptions[0]);
7814
7815 $InfoFieldList = explode(":", $paramoptions[0], 5);
7816 // 0 : tableName
7817 // 1 : label field name
7818 // 2 : key fields name (if different of rowid)
7819 // optional parameters...
7820 // 3 : key field parent (for dependent lists). How this is used ?
7821 // 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".
7822 // 5 : string category type. This replace the filter.
7823 // 6 : ids categories list separated by comma for category root. This replace the filter.
7824 // 7 : sort field
7825
7826 // If there is filter
7827 if (! empty($InfoFieldList[4])) {
7828 $pos = 0;
7829 $parenthesisopen = 0;
7830 while (substr($InfoFieldList[4], $pos, 1) !== '' && ($parenthesisopen || $pos == 0 || substr($InfoFieldList[4], $pos, 1) != ':')) {
7831 if (substr($InfoFieldList[4], $pos, 1) == '(') {
7832 $parenthesisopen++;
7833 }
7834 if (substr($InfoFieldList[4], $pos, 1) == ')') {
7835 $parenthesisopen--;
7836 }
7837 $pos++;
7838 }
7839 $tmpbefore = substr($InfoFieldList[4], 0, $pos);
7840 $tmpafter = substr($InfoFieldList[4], $pos + 1);
7841 //var_dump($InfoFieldList[4].' -> '.$pos); var_dump($tmpafter);
7842 $InfoFieldList[4] = $tmpbefore;
7843 if ($tmpafter !== '') {
7844 $InfoFieldList = array_merge($InfoFieldList, explode(':', $tmpafter));
7845 }
7846 //var_dump($InfoFieldList);
7847
7848 // Fix better compatibility with some old extrafield syntax filter "(field=123)"
7849 $reg = array();
7850 if (preg_match('/^\‍(?([a-z0-9]+)([=<>]+)(\d+)\‍)?$/i', $InfoFieldList[4], $reg)) {
7851 $InfoFieldList[4] = '('.$reg[1].':'.$reg[2].':'.$reg[3].')';
7852 }
7853
7854 //var_dump($InfoFieldList);
7855 }
7856
7857 //$Usf = empty($paramoptions[1]) ? '' :$paramoptions[1];
7858
7859 $parentName = '';
7860 $parentField = '';
7861
7862 $keyList = (empty($InfoFieldList[2]) ? 'rowid' : $InfoFieldList[2].' as rowid');
7863
7864 if (count($InfoFieldList) > 4 && !empty($InfoFieldList[4])) {
7865 if (strpos($InfoFieldList[4], 'extra.') !== false) {
7866 $keyList = 'main.'.$InfoFieldList[2].' as rowid';
7867 } else {
7868 $keyList = $InfoFieldList[2].' as rowid';
7869 }
7870 }
7871 if (count($InfoFieldList) > 3 && !empty($InfoFieldList[3])) {
7872 list($parentName, $parentField) = explode('|', $InfoFieldList[3]);
7873 $keyList .= ', '.$parentField;
7874 }
7875
7876 $filter_categorie = false;
7877 if (count($InfoFieldList) > 5) {
7878 if ($InfoFieldList[0] == 'categorie') {
7879 $filter_categorie = true;
7880 }
7881 }
7882
7883 if (!$filter_categorie) {
7884 $fields_label = explode('|', $InfoFieldList[1]);
7885 if (is_array($fields_label)) {
7886 $keyList .= ', ';
7887 $keyList .= implode(', ', $fields_label);
7888 }
7889
7890 $sqlwhere = '';
7891 $sql = "SELECT " . $keyList;
7892 $sql .= " FROM " . $this->db->prefix() . $InfoFieldList[0];
7893
7894 if (!empty($InfoFieldList[4])) {
7895 // can use SELECT request
7896 if (strpos($InfoFieldList[4], '$SEL$') !== false) {
7897 $InfoFieldList[4] = str_replace('$SEL$', 'SELECT', $InfoFieldList[4]);
7898 }
7899
7900 // current object id can be use into filter
7901 if (strpos($InfoFieldList[4], '$ID$') !== false && !empty($objectid)) {
7902 $InfoFieldList[4] = str_replace('$ID$', (string) $objectid, $InfoFieldList[4]);
7903 } else {
7904 $InfoFieldList[4] = str_replace('$ID$', '0', $InfoFieldList[4]);
7905 }
7906
7907 // We have to join on extrafield table
7908 $errstr = '';
7909 if (strpos($InfoFieldList[4], 'extra') !== false) {
7910 $sql .= " as main, " . $this->db->sanitize($this->db->prefix() . $InfoFieldList[0]) . "_extrafields as extra";
7911 $sqlwhere .= " WHERE extra.fk_object = main." . $this->db->sanitize($InfoFieldList[2]);
7912 $sqlwhere .= " AND " . forgeSQLFromUniversalSearchCriteria($InfoFieldList[4], $errstr, 1);
7913 } else {
7914 $sqlwhere .= " WHERE " . forgeSQLFromUniversalSearchCriteria($InfoFieldList[4], $errstr, 1);
7915 }
7916 } else {
7917 $sqlwhere .= ' WHERE 1=1';
7918 }
7919
7920 // Add Usf filter on second line
7921 /*
7922 if ($Usf) {
7923 $errorstr = '';
7924 $sqlusf .= forgeSQLFromUniversalSearchCriteria($Usf, $errorstr);
7925 if (!$errorstr) {
7926 $sqlwhere .= $sqlusf;
7927 } else {
7928 $sqlwhere .= " AND invalid_usf_filter_of_extrafield";
7929 }
7930 }
7931 */
7932
7933 // Some tables may have field, some other not. For the moment we disable it.
7934 if (in_array($InfoFieldList[0], array('tablewithentity'))) {
7935 $sqlwhere .= " AND entity = " . ((int) $conf->entity);
7936 }
7937 $sql .= $sqlwhere;
7938
7939 // Note: $InfoFieldList can be 'sellist:TableName:LabelFieldName[:KeyFieldName[:KeyFieldParent[:Filter[:CategoryIdType[:CategoryIdList[:Sortfield]]]]]]'
7940 if (isset($InfoFieldList[7]) && preg_match('/^[a-z0-9_\-,]+$/i', $InfoFieldList[7])) {
7941 $sql .= " ORDER BY ".$this->db->escape($InfoFieldList[7]);
7942 } else {
7943 $sql .= " ORDER BY ".$this->db->sanitize(implode(', ', $fields_label));
7944 }
7945
7946 dol_syslog(get_class($this) . '::showInputField type=sellist', LOG_DEBUG);
7947 $resql = $this->db->query($sql);
7948 if ($resql) {
7949 $out .= '<option value="0">&nbsp;</option>';
7950 $num = $this->db->num_rows($resql);
7951 $i = 0;
7952 while ($i < $num) {
7953 $labeltoshow = '';
7954 $obj = $this->db->fetch_object($resql);
7955
7956 // Several field into label (eq table:code|libelle:rowid)
7957 $notrans = false;
7958 $fields_label = explode('|', $InfoFieldList[1]);
7959 if (count($fields_label) > 1) {
7960 $notrans = true;
7961 foreach ($fields_label as $field_toshow) {
7962 $labeltoshow .= $obj->$field_toshow . ' ';
7963 }
7964 } else {
7965 $labeltoshow = $obj->{$InfoFieldList[1]};
7966 }
7967 $labeltoshow = dol_trunc($labeltoshow, 45);
7968
7969 if ($value == $obj->rowid) {
7970 foreach ($fields_label as $field_toshow) {
7971 $translabel = $langs->trans($obj->$field_toshow);
7972 if ($translabel != $obj->$field_toshow) {
7973 $labeltoshow = dol_trunc($translabel) . ' ';
7974 } else {
7975 $labeltoshow = dol_trunc($obj->$field_toshow) . ' ';
7976 }
7977 }
7978 $out .= '<option value="' . $obj->rowid . '" selected>' . $labeltoshow . '</option>';
7979 } else {
7980 if (!$notrans) {
7981 $translabel = $langs->trans($obj->{$InfoFieldList[1]});
7982 if ($translabel != $obj->{$InfoFieldList[1]}) {
7983 $labeltoshow = dol_trunc($translabel, 18);
7984 } else {
7985 $labeltoshow = dol_trunc($obj->{$InfoFieldList[1]});
7986 }
7987 }
7988 if (empty($labeltoshow)) {
7989 $labeltoshow = '(not defined)';
7990 }
7991 if ($value == $obj->rowid) {
7992 $out .= '<option value="' . $obj->rowid . '" selected>' . $labeltoshow . '</option>';
7993 }
7994
7995 if (!empty($InfoFieldList[3]) && $parentField) {
7996 $parent = $parentName . ':' . $obj->{$parentField};
7997 $isDependList = 1;
7998 }
7999
8000 $out .= '<option value="' . $obj->rowid . '"';
8001 $out .= ($value == $obj->rowid ? ' selected' : '');
8002 $out .= (!empty($parent) ? ' parent="' . $parent . '"' : '');
8003 $out .= '>' . $labeltoshow . '</option>';
8004 }
8005
8006 $i++;
8007 }
8008 $this->db->free($resql);
8009 } else {
8010 print 'Error in request ' . $sql . ' ' . $this->db->lasterror() . '. Check setup of extra parameters.<br>';
8011 }
8012 } else {
8013 require_once DOL_DOCUMENT_ROOT.'/categories/class/categorie.class.php';
8014 $data = $form->select_all_categories(Categorie::$MAP_ID_TO_CODE[$InfoFieldList[5]], '', 'parent', 64, $InfoFieldList[6], 1, 1);
8015 $out .= '<option value="0">&nbsp;</option>';
8016 foreach ($data as $data_key => $data_value) {
8017 $out .= '<option value="' . $data_key . '"';
8018 $out .= ($value == $data_key ? ' selected' : '');
8019 $out .= '>' . $data_value . '</option>';
8020 }
8021 }
8022 }
8023 $out .= '</select>';
8024 } elseif ($type == 'checkbox') {
8025 $value_arr = explode(',', $value);
8026 $out = $form->multiselectarray($keyprefix.$key.$keysuffix, (empty($param['options']) ? null : $param['options']), $value_arr, 0, 0, $morecss, 0, '100%');
8027 } elseif ($type == 'radio') {
8028 $out = '';
8029 foreach ($param['options'] as $keyopt => $valopt) {
8030 $out .= '<input class="flat '.$morecss.'" type="radio" name="'.$keyprefix.$key.$keysuffix.'" id="'.$keyprefix.$key.$keysuffix.'" '.($moreparam ? $moreparam : '');
8031 $out .= ' value="'.$keyopt.'"';
8032 $out .= ' id="'.$keyprefix.$key.$keysuffix.'_'.$keyopt.'"';
8033 $out .= ($value == $keyopt ? 'checked' : '');
8034 $out .= '/><label for="'.$keyprefix.$key.$keysuffix.'_'.$keyopt.'">'.$valopt.'</label><br>';
8035 }
8036 } elseif ($type == 'chkbxlst') {
8037 if (is_array($value)) {
8038 $value_arr = $value;
8039 } else {
8040 $value_arr = explode(',', $value);
8041 }
8042
8043 if (is_array($param['options'])) {
8044 $tmpparamoptions = array_keys($param['options']);
8045 $paramoptions = preg_split('/[\r\n]+/', $tmpparamoptions[0]);
8046
8047 $InfoFieldList = explode(":", $paramoptions[0], 5);
8048 // 0 : tableName
8049 // 1 : label field name
8050 // 2 : key fields name (if different of rowid)
8051 // optional parameters...
8052 // 3 : key field parent (for dependent lists). How this is used ?
8053 // 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".
8054 // 5 : string category type. This replace the filter.
8055 // 6 : ids categories list separated by comma for category root. This replace the filter.
8056 // 7 : sort field
8057
8058 // If there is a filter
8059 if (! empty($InfoFieldList[4])) {
8060 $pos = 0;
8061 $parenthesisopen = 0;
8062 while (substr($InfoFieldList[4], $pos, 1) !== '' && ($parenthesisopen || $pos == 0 || substr($InfoFieldList[4], $pos, 1) != ':')) {
8063 if (substr($InfoFieldList[4], $pos, 1) == '(') {
8064 $parenthesisopen++;
8065 }
8066 if (substr($InfoFieldList[4], $pos, 1) == ')') {
8067 $parenthesisopen--;
8068 }
8069 $pos++;
8070 }
8071 $tmpbefore = substr($InfoFieldList[4], 0, $pos);
8072 $tmpafter = substr($InfoFieldList[4], $pos + 1);
8073 //var_dump($InfoFieldList[4].' -> '.$pos); var_dump($tmpafter);
8074 $InfoFieldList[4] = $tmpbefore;
8075 if ($tmpafter !== '') {
8076 $InfoFieldList = array_merge($InfoFieldList, explode(':', $tmpafter));
8077 }
8078
8079 // Fix better compatibility with some old extrafield syntax filter "(field=123)"
8080 $reg = array();
8081 if (preg_match('/^\‍(?([a-z0-9]+)([=<>]+)(\d+)\‍)?$/i', $InfoFieldList[4], $reg)) {
8082 $InfoFieldList[4] = '('.$reg[1].':'.$reg[2].':'.$reg[3].')';
8083 }
8084
8085 //var_dump($InfoFieldList);
8086 }
8087
8088 //$Usf = empty($paramoptions[1]) ? '' :$paramoptions[1];
8089
8090 '@phan-var-force array{0:string,1:string,2:string,3:string,3:string,5:string,6:string} $InfoFieldList';
8091
8092 $parentName = '';
8093 $parentField = '';
8094
8095 $keyList = (empty($InfoFieldList[2]) ? 'rowid' : $InfoFieldList[2].' as rowid');
8096
8097 if (count($InfoFieldList) > 3 && !empty($InfoFieldList[3])) {
8098 list($parentName, $parentField) = explode('|', $InfoFieldList[3]);
8099 $keyList .= ', '.$parentField;
8100 }
8101 if (count($InfoFieldList) > 4 && !empty($InfoFieldList[4])) {
8102 if (strpos($InfoFieldList[4], 'extra.') !== false) {
8103 $keyList = 'main.'.$InfoFieldList[2].' as rowid';
8104 } else {
8105 $keyList = $InfoFieldList[2].' as rowid';
8106 }
8107 }
8108
8109 $filter_categorie = false;
8110 if (count($InfoFieldList) > 5) {
8111 if ($InfoFieldList[0] == 'categorie') {
8112 $filter_categorie = true;
8113 }
8114 }
8115
8116 // Common filter
8117 if (!$filter_categorie) {
8118 $fields_label = explode('|', $InfoFieldList[1]);
8119 if (is_array($fields_label)) {
8120 $keyList .= ', ';
8121 $keyList .= implode(', ', $fields_label);
8122 }
8123
8124 $sqlwhere = '';
8125 $sql = "SELECT " . $keyList;
8126 $sql .= ' FROM ' . $this->db->prefix() . $InfoFieldList[0];
8127
8128 if (!empty($InfoFieldList[4])) {
8129 // can use SELECT request
8130 if (strpos($InfoFieldList[4], '$SEL$') !== false) {
8131 $InfoFieldList[4] = str_replace('$SEL$', 'SELECT', $InfoFieldList[4]);
8132 }
8133
8134 // current object id can be use into filter
8135 if (strpos($InfoFieldList[4], '$ID$') !== false && !empty($objectid)) {
8136 $InfoFieldList[4] = str_replace('$ID$', (string) $objectid, $InfoFieldList[4]);
8137 } else {
8138 $InfoFieldList[4] = str_replace('$ID$', '0', $InfoFieldList[4]);
8139 }
8140
8141 // We have to join on extrafield table
8142 $errstr = '';
8143 if (strpos($InfoFieldList[4], 'extra') !== false) {
8144 $sql .= ' as main, ' . $this->db->sanitize($this->db->prefix() . $InfoFieldList[0]) . '_extrafields as extra';
8145 $sqlwhere .= " WHERE extra.fk_object = main." . $this->db->sanitize($InfoFieldList[2]);
8146 $sqlwhere .= " AND " . $InfoFieldList[4];
8147 } else {
8148 $sqlwhere .= " WHERE " . $InfoFieldList[4];
8149 }
8150 } else {
8151 $sqlwhere .= ' WHERE 1=1';
8152 }
8153
8154 // Add Usf filter on second line
8155 /*
8156 if ($Usf) {
8157 $errorstr = '';
8158 $sqlusf .= forgeSQLFromUniversalSearchCriteria($Usf, $errorstr);
8159 if (!$errorstr) {
8160 $sqlwhere .= $sqlusf;
8161 } else {
8162 $sqlwhere .= " AND invalid_usf_filter_of_extrafield";
8163 }
8164 }
8165 */
8166
8167 // Some tables may have field, some other not. For the moment we disable it.
8168 if (in_array($InfoFieldList[0], array('tablewithentity'))) {
8169 $sqlwhere .= " AND entity = " . ((int) $conf->entity);
8170 }
8171 // $sql.=preg_replace('/^ AND /','',$sqlwhere);
8172 // print $sql;
8173
8174 $sql .= $sqlwhere;
8175
8176 dol_syslog(get_class($this) . '::showInputField type=chkbxlst', LOG_DEBUG);
8177
8178 $resql = $this->db->query($sql);
8179 if ($resql) {
8180 $num = $this->db->num_rows($resql);
8181 $i = 0;
8182
8183 $data = array();
8184
8185 while ($i < $num) {
8186 $labeltoshow = '';
8187 $obj = $this->db->fetch_object($resql);
8188
8189 $notrans = false;
8190 // Several field into label (eq table:code|libelle:rowid)
8191 $fields_label = explode('|', $InfoFieldList[1]);
8192 if (count($fields_label) > 1) {
8193 $notrans = true;
8194 foreach ($fields_label as $field_toshow) {
8195 $labeltoshow .= $obj->$field_toshow . ' ';
8196 }
8197 } else {
8198 $labeltoshow = $obj->{$InfoFieldList[1]};
8199 }
8200 $labeltoshow = dol_trunc($labeltoshow, 45);
8201
8202 if (is_array($value_arr) && in_array($obj->rowid, $value_arr)) {
8203 foreach ($fields_label as $field_toshow) {
8204 $translabel = $langs->trans($obj->$field_toshow);
8205 if ($translabel != $obj->$field_toshow) {
8206 $labeltoshow = dol_trunc($translabel, 18) . ' ';
8207 } else {
8208 $labeltoshow = dol_trunc($obj->$field_toshow, 18) . ' ';
8209 }
8210 }
8211
8212 $data[$obj->rowid] = $labeltoshow;
8213 } else {
8214 if (!$notrans) {
8215 $translabel = $langs->trans($obj->{$InfoFieldList[1]});
8216 if ($translabel != $obj->{$InfoFieldList[1]}) {
8217 $labeltoshow = dol_trunc($translabel, 18);
8218 } else {
8219 $labeltoshow = dol_trunc($obj->{$InfoFieldList[1]}, 18);
8220 }
8221 }
8222 if (empty($labeltoshow)) {
8223 $labeltoshow = '(not defined)';
8224 }
8225
8226 if (is_array($value_arr) && in_array($obj->rowid, $value_arr)) {
8227 $data[$obj->rowid] = $labeltoshow;
8228 }
8229
8230 if (!empty($InfoFieldList[3]) && $parentField) {
8231 $parent = $parentName . ':' . $obj->{$parentField};
8232 $isDependList = 1;
8233 }
8234
8235 $data[(int) $obj->rowid] = $labeltoshow;
8236 }
8237
8238 $i++;
8239 }
8240 $this->db->free($resql);
8241
8242 $out = $form->multiselectarray($keyprefix . $key . $keysuffix, $data, $value_arr, 0, 0, $morecss, 0, '100%');
8243 } else {
8244 print 'Error in request ' . $sql . ' ' . $this->db->lasterror() . '. Check setup of extra parameters.<br>';
8245 }
8246 } else {
8247 require_once DOL_DOCUMENT_ROOT.'/categories/class/categorie.class.php';
8248 $data = $form->select_all_categories(Categorie::$MAP_ID_TO_CODE[(int) $InfoFieldList[5]], '', 'parent', 64, $InfoFieldList[6], 1, 1);
8249 $out = $form->multiselectarray($keyprefix . $key . $keysuffix, $data, $value_arr, 0, 0, $morecss, 0, '100%');
8250 }
8251 }
8252 } elseif ($type == 'link') {
8253 // $param_list='ObjectName:classPath[:AddCreateButtonOrNot[:Filter[:Sortfield]]]'
8254 // Filter can contains some ':' inside.
8255 $param_list = array_keys($param['options']);
8256 $param_list_array = explode(':', $param_list[0], 4);
8257
8258 $showempty = (($required && $default != '') ? 0 : 1);
8259
8260 if (!preg_match('/search_/', $keyprefix)) {
8261 if (!empty($param_list_array[2])) { // If the entry into $fields is set to add a create button
8262 // @phan-suppress-next-line PhanTypeMismatchProperty
8263 if (!empty($this->fields[$key]['picto'])) {
8264 $morecss .= ' widthcentpercentminusxx';
8265 } else {
8266 $morecss .= ' widthcentpercentminusx';
8267 }
8268 } else {
8269 // @phan-suppress-next-line PhanTypeMismatchProperty
8270 if (!empty($this->fields[$key]['picto'])) {
8271 $morecss .= ' widthcentpercentminusx';
8272 }
8273 }
8274 }
8275 $objectfield = $this->element.($this->module ? '@'.$this->module : '').':'.$key.$keysuffix;
8276 $out = $form->selectForForms($param_list_array[0], $keyprefix.$key.$keysuffix, $value, $showempty, '', '', $morecss, $moreparam, 0, (empty($val['disabled']) ? 0 : 1), '', $objectfield);
8277
8278 if (!empty($param_list_array[2])) { // If the entry into $fields is set, we must add a create button
8279 if ((!GETPOSTISSET('backtopage') || strpos(GETPOST('backtopage'), $_SERVER['PHP_SELF']) === 0) // // To avoid to open several times the 'Plus' button (we accept only one level)
8280 && empty($val['disabled']) && empty($nonewbutton)) { // and to avoid to show the button if the field is protected by a "disabled".
8281 list($class, $classfile) = explode(':', $param_list[0]);
8282 if (file_exists(dol_buildpath(dirname(dirname($classfile)).'/card.php'))) {
8283 $url_path = dol_buildpath(dirname(dirname($classfile)).'/card.php', 1);
8284 } else {
8285 $url_path = dol_buildpath(dirname(dirname($classfile)).'/'.strtolower($class).'_card.php', 1);
8286 }
8287 $paramforthenewlink = '';
8288 $paramforthenewlink .= (GETPOSTISSET('action') ? '&action='.GETPOST('action', 'aZ09') : '');
8289 $paramforthenewlink .= (GETPOSTISSET('id') ? '&id='.GETPOSTINT('id') : '');
8290 $paramforthenewlink .= (GETPOSTISSET('origin') ? '&origin='.GETPOST('origin', 'aZ09') : '');
8291 $paramforthenewlink .= (GETPOSTISSET('originid') ? '&originid='.GETPOSTINT('originid') : '');
8292 $paramforthenewlink .= '&fk_'.strtolower($class).'=--IDFORBACKTOPAGE--';
8293 // TODO Add JavaScript code to add input fields already filled into $paramforthenewlink so we won't loose them when going back to main page
8294 $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>';
8295 }
8296 }
8297 } elseif ($type == 'password') {
8298 // If prefix is 'search_', field is used as a filter, we use a common text field.
8299 if ($keyprefix.$key.$keysuffix == 'pass_crypted') {
8300 $out = '<input type="'.($keyprefix == 'search_' ? 'text' : 'password').'" class="flat '.$morecss.'" name="pass" id="pass" value="" '.($moreparam ? $moreparam : '').'>';
8301 $out .= '<input type="hidden" name="pass_crypted" id="pass_crypted" value="'.$value.'" '.($moreparam ? $moreparam : '').'>';
8302 } else {
8303 $out = '<input type="'.($keyprefix == 'search_' ? 'text' : 'password').'" class="flat '.$morecss.'" name="'.$keyprefix.$key.$keysuffix.'" id="'.$keyprefix.$key.$keysuffix.'" value="'.$value.'" '.($moreparam ? $moreparam : '').'>';
8304 }
8305 } elseif ($type == 'array') {
8306 $newval = $val;
8307 $newval['type'] = 'varchar(256)';
8308
8309 $out = '';
8310 if (!empty($value)) {
8311 foreach ($value as $option) {
8312 $out .= '<span><a class="'.dol_escape_htmltag($keyprefix.$key.$keysuffix).'_del" href="javascript:;"><span class="fa fa-minus-circle valignmiddle"></span></a> ';
8313 $out .= $this->showInputField($newval, $keyprefix.$key.$keysuffix.'[]', $option, $moreparam, '', '', $morecss).'<br></span>';
8314 }
8315 }
8316 $out .= '<a id="'.dol_escape_htmltag($keyprefix.$key.$keysuffix).'_add" href="javascript:;"><span class="fa fa-plus-circle valignmiddle"></span></a>';
8317
8318 $newInput = '<span><a class="'.dol_escape_htmltag($keyprefix.$key.$keysuffix).'_del" href="javascript:;"><span class="fa fa-minus-circle valignmiddle"></span></a> ';
8319 $newInput .= $this->showInputField($newval, $keyprefix.$key.$keysuffix.'[]', '', $moreparam, '', '', $morecss).'<br></span>';
8320
8321 if (!empty($conf->use_javascript_ajax)) {
8322 $out .= '
8323 <script nonce="'.getNonce().'">
8324 $(document).ready(function() {
8325 $("a#'.dol_escape_js($keyprefix.$key.$keysuffix).'_add").click(function() {
8326 $("'.dol_escape_js($newInput).'").insertBefore(this);
8327 });
8328
8329 $(document).on("click", "a.'.dol_escape_js($keyprefix.$key.$keysuffix).'_del", function() {
8330 $(this).parent().remove();
8331 });
8332 });
8333 </script>';
8334 }
8335 }
8336 if (!empty($hidden)) {
8337 $out = '<input type="hidden" value="'.$value.'" name="'.$keyprefix.$key.$keysuffix.'" id="'.$keyprefix.$key.$keysuffix.'"/>';
8338 }
8339
8340 if ($isDependList == 1) {
8341 $out .= $this->getJSListDependancies('_common');
8342 }
8343 /* Add comments
8344 if ($type == 'date') $out.=' (YYYY-MM-DD)';
8345 elseif ($type == 'datetime') $out.=' (YYYY-MM-DD HH:MM:SS)';
8346 */
8347
8348 // Display error message for field
8349 if (!empty($fieldValidationErrorMsg) && function_exists('getFieldErrorIcon')) {
8350 $out .= ' '.getFieldErrorIcon($fieldValidationErrorMsg);
8351 }
8352
8353 return $out;
8354 }
8355
8369 public function showOutputField($val, $key, $value, $moreparam = '', $keysuffix = '', $keyprefix = '', $morecss = '')
8370 {
8371 global $conf, $langs, $form;
8372
8373 // 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...)
8374
8375 if (!is_object($form)) {
8376 require_once DOL_DOCUMENT_ROOT.'/core/class/html.form.class.php';
8377 $form = new Form($this->db);
8378 }
8379
8380 //$label = empty($val['label']) ? '' : $val['label'];
8381 $type = empty($val['type']) ? '' : $val['type'];
8382 $size = empty($val['css']) ? '' : $val['css'];
8383 $reg = array();
8384
8385 // Convert var to be able to share same code than showOutputField of extrafields
8386 if (preg_match('/varchar\‍((\d+)\‍)/', $type, $reg)) {
8387 $type = 'varchar'; // convert varchar(xx) int varchar
8388 $size = $reg[1];
8389 } elseif (preg_match('/varchar/', $type)) {
8390 $type = 'varchar'; // convert varchar(xx) int varchar
8391 }
8392 if (!empty($val['arrayofkeyval']) && is_array($val['arrayofkeyval'])) {
8393 // @phan-suppress-next-line PhanTypeMismatchProperty
8394 if (empty($this->fields[$key]['multiinput'])) {
8395 $type = (($this->fields[$key]['type'] == 'checkbox') ? $this->fields[$key]['type'] : 'select');
8396 }
8397 }
8398 if (preg_match('/^integer:(.*):(.*)/i', $val['type'], $reg)) {
8399 $type = 'link';
8400 }
8401
8402 $default = empty($val['default']) ? '' : $val['default'];
8403 $computed = empty($val['computed']) ? '' : $val['computed'];
8404 $unique = empty($val['unique']) ? '' : $val['unique'];
8405 $required = empty($val['required']) ? '' : $val['required'];
8406 $param = array();
8407 $param['options'] = array();
8408
8409 if (!empty($val['arrayofkeyval']) && is_array($val['arrayofkeyval'])) {
8410 $param['options'] = $val['arrayofkeyval'];
8411 }
8412 if (preg_match('/^integer:([^:]*):([^:]*)/i', $val['type'], $reg)) { // ex: integer:User:user/class/user.class.php
8413 $type = 'link';
8414 $stringforoptions = $reg[1].':'.$reg[2];
8415 // Special case: Force addition of getnomurlparam1 to -1 for users
8416 if ($reg[1] == 'User') {
8417 $stringforoptions .= ':#getnomurlparam1=-1';
8418 }
8419 $param['options'] = array($stringforoptions => $stringforoptions);
8420 } elseif (preg_match('/^sellist:(.*):(.*):(.*):(.*)/i', $val['type'], $reg)) {
8421 $param['options'] = array($reg[1].':'.$reg[2].':'.$reg[3].':'.$reg[4] => 'N');
8422 $type = 'sellist';
8423 } elseif (preg_match('/^sellist:(.*):(.*):(.*)/i', $val['type'], $reg)) {
8424 $param['options'] = array($reg[1].':'.$reg[2].':'.$reg[3] => 'N');
8425 $type = 'sellist';
8426 } elseif (preg_match('/^sellist:(.*):(.*)/i', $val['type'], $reg)) {
8427 $param['options'] = array($reg[1].':'.$reg[2] => 'N');
8428 $type = 'sellist';
8429 } elseif (preg_match('/^chkbxlst:(.*)/i', $val['type'], $reg)) {
8430 $param['options'] = array($reg[1] => 'N');
8431 $type = 'chkbxlst';
8432 } elseif (preg_match('/stars\‍((\d+)\‍)/', $val['type'], $reg)) {
8433 $param['options'] = array();
8434 $type = 'stars';
8435 $size = $reg[1];
8436 }
8437
8438 $langfile = empty($val['langfile']) ? '' : $val['langfile'];
8439 $list = (empty($val['list']) ? '' : $val['list']);
8440 $help = (empty($val['help']) ? '' : $val['help']);
8441 $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)
8442
8443 if ($hidden) {
8444 return '';
8445 }
8446
8447 // If field is a computed field, value must become result of compute
8448 if ($computed) {
8449 // Make the eval of compute string
8450 //var_dump($computed);
8451 $value = dol_eval($computed, 1, 0, '2');
8452 }
8453
8454 if (empty($morecss)) {
8455 if ($type == 'date') {
8456 $morecss = 'minwidth100imp';
8457 } elseif ($type == 'datetime' || $type == 'timestamp') {
8458 $morecss = 'minwidth200imp';
8459 } elseif (in_array($type, array('int', 'double', 'price'))) {
8460 $morecss = 'maxwidth75';
8461 } elseif ($type == 'url') {
8462 $morecss = 'minwidth400';
8463 } elseif ($type == 'boolean') {
8464 $morecss = '';
8465 } else {
8466 if (is_numeric($size) && round((float) $size) < 12) {
8467 $morecss = 'minwidth100';
8468 } elseif (is_numeric($size) && round((float) $size) <= 48) {
8469 $morecss = 'minwidth200';
8470 } else {
8471 $morecss = 'minwidth400';
8472 }
8473 }
8474 }
8475
8476 // Format output value differently according to properties of field
8477 if (in_array($key, array('rowid', 'ref')) && method_exists($this, 'getNomUrl')) {
8478 // @phan-suppress-next-line PhanTypeMismatchProperty
8479 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.
8480 $value = $this->getNomUrl(1, '', 0, '', 1);
8481 }
8482 } elseif ($key == 'status' && method_exists($this, 'getLibStatut')) {
8483 $value = $this->getLibStatut(3);
8484 } elseif ($type == 'date') {
8485 if (!empty($value)) {
8486 $value = dol_print_date($value, 'day'); // We suppose dates without time are always gmt (storage of course + output)
8487 } else {
8488 $value = '';
8489 }
8490 } elseif ($type == 'datetime' || $type == 'timestamp') {
8491 if (!empty($value)) {
8492 $value = dol_print_date($value, 'dayhour', 'tzuserrel');
8493 } else {
8494 $value = '';
8495 }
8496 } elseif ($type == 'duration') {
8497 include_once DOL_DOCUMENT_ROOT.'/core/lib/date.lib.php';
8498 if (!is_null($value) && $value !== '') {
8499 $value = convertSecondToTime((int) $value, 'allhourmin');
8500 }
8501 } elseif ($type == 'double' || $type == 'real') {
8502 if (!is_null($value) && $value !== '') {
8503 $value = price($value);
8504 }
8505 } elseif ($type == 'boolean') {
8506 $checked = '';
8507 if (!empty($value)) {
8508 $checked = ' checked ';
8509 }
8510 if (getDolGlobalInt('MAIN_OPTIMIZEFORTEXTBROWSER') < 2) {
8511 $value = '<input type="checkbox" '.$checked.' '.($moreparam ? $moreparam : '').' readonly disabled>';
8512 } else {
8513 $value = yn($value ? 1 : 0);
8514 }
8515 } elseif ($type == 'mail' || $type == 'email') {
8516 $value = dol_print_email($value, 0, 0, 0, 64, 1, 1);
8517 } elseif ($type == 'url') {
8518 $value = dol_print_url($value, '_blank', 32, 1);
8519 } elseif ($type == 'phone') {
8520 $value = dol_print_phone($value, '', 0, 0, '', '&nbsp;', 'phone');
8521 } elseif ($type == 'ip') {
8522 $value = dol_print_ip($value, 0);
8523 } elseif ($type == 'stars') {
8524 $value = '<input type="hidden" class="flat '.$morecss.'" name="'.$keyprefix.$key.$keysuffix.'" id="'.$keyprefix.$key.$keysuffix.$this->id.'" value="'.dol_escape_htmltag($value).'"'.($moreparam ? $moreparam : '').'>';
8525 $value .= '<div class="star-selection" id="'.$keyprefix.$key.$keysuffix.$this->id.'_selection">';
8526 $i = 1;
8527 while ($i <= $size) {
8528 $value .= '<span class="star" data-value="'.$i.'">'.img_picto('', 'fontawesome_star_fas').'</span>';
8529 $i++;
8530 }
8531 $value .= '</div>';
8532 $value .= '<script>
8533 $(document).ready(function() {
8534 let container = $("#'.$keyprefix.$key.$keysuffix.$this->id.'_selection");
8535 let selectedStars = parseInt($("#'.$keyprefix.$key.$keysuffix.$this->id.'").val()) || 0;
8536 container.find(".star").each(function() {
8537 $(this).toggleClass("active", $(this).data("value") <= selectedStars);
8538 });
8539 container.find(".star").on("mouseover", function() {
8540 let selectedStar = $(this).data("value");
8541 container.find(".star").each(function() {
8542 $(this).toggleClass("active", $(this).data("value") <= selectedStar);
8543 });
8544 });
8545 container.on("mouseout", function() {
8546 container.find(".star").each(function() {
8547 $(this).toggleClass("active", $(this).data("value") <= selectedStars);
8548 });
8549 });
8550 container.find(".star").off("click").on("click", function() {
8551 selectedStars = $(this).data("value");
8552 if (selectedStars == 1 && $("#'.$keyprefix.$key.$keysuffix.$this->id.'").val() == 1) {
8553 selectedStars = 0;
8554 }
8555 container.find("#'.$keyprefix.$key.$keysuffix.$this->id.'").val(selectedStars);
8556 container.find(".star").each(function() {
8557 $(this).toggleClass("active", $(this).data("value") <= selectedStars);
8558 });
8559 $.ajax({
8560 url: "ajax/'.$this->element.'.php",
8561 method: "POST",
8562 data: {
8563 objectId: "'.$this->id.'",
8564 field: "'.$keyprefix.$key.$keysuffix.'",
8565 value: selectedStars,
8566 token: "'.newToken().'"
8567 },
8568 success: function(response) {
8569 var res = JSON.parse(response);
8570 console[res.status === "success" ? "log" : "error"](res.message);
8571 },
8572 error: function(xhr, status, error) {
8573 console.log("Ajax request failed while updating '.$keyprefix.$key.$keysuffix.':", error);
8574 }
8575 });
8576 });
8577 });
8578 </script>';
8579 } elseif ($type == 'price') {
8580 if (!is_null($value) && $value !== '') {
8581 $value = price($value, 0, $langs, 0, 0, -1, $conf->currency);
8582 }
8583 } elseif ($type == 'select') {
8584 $value = isset($param['options'][(string) $value]) ? $param['options'][(string) $value] : '';
8585 if (strpos($value, "|") !== false) {
8586 $value = $langs->trans(explode('|', $value)[0]);
8587 } elseif (! is_numeric($value)) {
8588 $value = $langs->trans($value);
8589 }
8590 } elseif ($type == 'sellist') {
8591 $param_list = array_keys($param['options']);
8592 $InfoFieldList = explode(":", $param_list[0]);
8593
8594 $selectkey = "rowid";
8595 $keyList = 'rowid';
8596
8597 if (count($InfoFieldList) > 2 && !empty($InfoFieldList[2])) {
8598 $selectkey = $InfoFieldList[2];
8599 $keyList = $InfoFieldList[2].' as rowid';
8600 }
8601
8602 $fields_label = explode('|', $InfoFieldList[1]);
8603 if (is_array($fields_label)) {
8604 $keyList .= ', ';
8605 $keyList .= implode(', ', $fields_label);
8606 }
8607
8608 $filter_categorie = false;
8609 if (count($InfoFieldList) > 5) {
8610 if ($InfoFieldList[0] == 'categorie') {
8611 $filter_categorie = true;
8612 }
8613 }
8614
8615 $sql = "SELECT ".$keyList;
8616 $sql .= ' FROM '.$this->db->prefix().$InfoFieldList[0];
8617 if (isset($InfoFieldList[4]) && strpos($InfoFieldList[4], 'extra') !== false) {
8618 $sql .= ' as main';
8619 }
8620 if ($selectkey == 'rowid' && empty($value)) {
8621 $sql .= " WHERE ".$selectkey." = 0";
8622 } elseif ($selectkey == 'rowid') {
8623 $sql .= " WHERE ".$selectkey." = ".((int) $value);
8624 } else {
8625 $sql .= " WHERE ".$selectkey." = '".$this->db->escape($value)."'";
8626 }
8627
8628 //$sql.= ' AND entity = '.$conf->entity;
8629
8630 dol_syslog(get_class($this).':showOutputField:$type=sellist', LOG_DEBUG);
8631 $resql = $this->db->query($sql);
8632 if ($resql) {
8633 if (!$filter_categorie) {
8634 $value = ''; // value was used, so now we reset it to use it to build final output
8635 $numrows = $this->db->num_rows($resql);
8636 if ($numrows) {
8637 $obj = $this->db->fetch_object($resql);
8638
8639 // Several field into label (eq table:code|libelle:rowid)
8640 $fields_label = explode('|', $InfoFieldList[1]);
8641
8642 if (is_array($fields_label) && count($fields_label) > 1) {
8643 foreach ($fields_label as $field_toshow) {
8644 $translabel = '';
8645 if (!empty($obj->$field_toshow)) {
8646 $translabel = $langs->trans($obj->$field_toshow);
8647 }
8648 if ($translabel != $field_toshow) {
8649 $value .= dol_trunc($translabel, 18) . ' ';
8650 } else {
8651 $value .= $obj->$field_toshow . ' ';
8652 }
8653 }
8654 } else {
8655 $translabel = '';
8656 if (!empty($obj->{$InfoFieldList[1]})) {
8657 $translabel = $langs->trans($obj->{$InfoFieldList[1]});
8658 }
8659 if ($translabel != $obj->{$InfoFieldList[1]}) {
8660 $value = dol_trunc($translabel, 18);
8661 } else {
8662 $value = $obj->{$InfoFieldList[1]};
8663 }
8664 }
8665 }
8666 } else {
8667 require_once DOL_DOCUMENT_ROOT . '/categories/class/categorie.class.php';
8668
8669 $toprint = array();
8670 $obj = $this->db->fetch_object($resql);
8671 $c = new Categorie($this->db);
8672 $c->fetch($obj->rowid);
8673 $ways = $c->print_all_ways(); // $ways[0] = "ccc2 >> ccc2a >> ccc2a1" with html formatted text
8674 foreach ($ways as $way) {
8675 $toprint[] = '<li class="select2-search-choice-dolibarr noborderoncategories"' . ($c->color ? ' style="background: #' . $c->color . ';"' : ' style="background: #aaa"') . '>' . img_object('', 'category') . ' ' . $way . '</li>';
8676 }
8677 $value = '<div class="select2-container-multi-dolibarr" style="width: 90%;"><ul class="select2-choices-dolibarr">'.implode(' ', $toprint).'</ul></div>';
8678 }
8679 } else {
8680 dol_syslog(get_class($this).'::showOutputField error '.$this->db->lasterror(), LOG_WARNING);
8681 }
8682 } elseif ($type == 'radio') {
8683 $value = $param['options'][(string) $value];
8684 } elseif ($type == 'checkbox') {
8685 $value_arr = explode(',', (string) $value);
8686 $value = '';
8687 if (is_array($value_arr) && count($value_arr) > 0) {
8688 $toprint = array();
8689 foreach ($value_arr as $keyval => $valueval) {
8690 if (!empty($valueval)) {
8691 $toprint[] = '<li class="select2-search-choice-dolibarr noborderoncategories" style="background: #bbb">' . $param['options'][$valueval] . '</li>';
8692 }
8693 }
8694 if (!empty($toprint)) {
8695 $value = '<div class="select2-container-multi-dolibarr" style="width: 90%;"><ul class="select2-choices-dolibarr">' . implode(' ', $toprint) . '</ul></div>';
8696 }
8697 }
8698 } elseif ($type == 'chkbxlst') {
8699 $value_arr = (isset($value) ? explode(',', $value) : array());
8700
8701 $param_list = array_keys($param['options']);
8702 $InfoFieldList = explode(":", $param_list[0]);
8703
8704 $selectkey = "rowid";
8705 $keyList = 'rowid';
8706
8707 if (count($InfoFieldList) >= 3) {
8708 $selectkey = $InfoFieldList[2];
8709 $keyList = $InfoFieldList[2].' as rowid';
8710 }
8711
8712 $fields_label = explode('|', $InfoFieldList[1]);
8713 if (is_array($fields_label)) {
8714 $keyList .= ', ';
8715 $keyList .= implode(', ', $fields_label);
8716 }
8717
8718 $filter_categorie = false;
8719 if (count($InfoFieldList) > 5) {
8720 if ($InfoFieldList[0] == 'categorie') {
8721 $filter_categorie = true;
8722 }
8723 }
8724
8725 $sql = "SELECT ".$keyList;
8726 $sql .= ' FROM '.$this->db->prefix().$InfoFieldList[0];
8727 if (isset($InfoFieldList[4]) && strpos($InfoFieldList[4], 'extra') !== false) {
8728 $sql .= ' as main';
8729 }
8730 // $sql.= " WHERE ".$selectkey."='".$this->db->escape($value)."'";
8731 // $sql.= ' AND entity = '.$conf->entity;
8732
8733 dol_syslog(get_class($this).':showOutputField:$type=chkbxlst', LOG_DEBUG);
8734 $resql = $this->db->query($sql);
8735 if ($resql) {
8736 if (!$filter_categorie) {
8737 $value = ''; // value was used, so now we reset it to use it to build final output
8738 $toprint = array();
8739 while ($obj = $this->db->fetch_object($resql)) {
8740 // Several field into label (eq table:code|libelle:rowid)
8741 $fields_label = explode('|', $InfoFieldList[1]);
8742 if (is_array($value_arr) && in_array($obj->rowid, $value_arr)) {
8743 if (is_array($fields_label) && count($fields_label) > 1) {
8744 foreach ($fields_label as $field_toshow) {
8745 $translabel = '';
8746 if (!empty($obj->$field_toshow)) {
8747 $translabel = $langs->trans($obj->$field_toshow);
8748 }
8749 if ($translabel != $field_toshow) {
8750 $toprint[] = '<li class="select2-search-choice-dolibarr noborderoncategories" style="background: #bbb">' . dol_trunc($translabel, 18) . '</li>';
8751 } else {
8752 $toprint[] = '<li class="select2-search-choice-dolibarr noborderoncategories" style="background: #bbb">' . $obj->$field_toshow . '</li>';
8753 }
8754 }
8755 } else {
8756 $translabel = '';
8757 if (!empty($obj->{$InfoFieldList[1]})) {
8758 $translabel = $langs->trans($obj->{$InfoFieldList[1]});
8759 }
8760 if ($translabel != $obj->{$InfoFieldList[1]}) {
8761 $toprint[] = '<li class="select2-search-choice-dolibarr noborderoncategories" style="background: #bbb">' . dol_trunc($translabel, 18) . '</li>';
8762 } else {
8763 $toprint[] = '<li class="select2-search-choice-dolibarr noborderoncategories" style="background: #bbb">' . $obj->{$InfoFieldList[1]} . '</li>';
8764 }
8765 }
8766 }
8767 }
8768 } else {
8769 require_once DOL_DOCUMENT_ROOT . '/categories/class/categorie.class.php';
8770
8771 $toprint = array();
8772 while ($obj = $this->db->fetch_object($resql)) {
8773 if (is_array($value_arr) && in_array($obj->rowid, $value_arr)) {
8774 $c = new Categorie($this->db);
8775 $c->fetch($obj->rowid);
8776 $ways = $c->print_all_ways(); // $ways[0] = "ccc2 >> ccc2a >> ccc2a1" with html formatted text
8777 foreach ($ways as $way) {
8778 $toprint[] = '<li class="select2-search-choice-dolibarr noborderoncategories"' . ($c->color ? ' style="background: #' . $c->color . ';"' : ' style="background: #aaa"') . '>' . img_object('', 'category') . ' ' . $way . '</li>';
8779 }
8780 }
8781 }
8782 }
8783 $value = '<div class="select2-container-multi-dolibarr" style="width: 90%;"><ul class="select2-choices-dolibarr">'.implode(' ', $toprint).'</ul></div>';
8784 } else {
8785 dol_syslog(get_class($this).'::showOutputField error '.$this->db->lasterror(), LOG_WARNING);
8786 }
8787 } elseif ($type == 'link') {
8788 $out = '';
8789
8790 // only if something to display (perf)
8791 if ($value) {
8792 $param_list = array_keys($param['options']);
8793 // Example: $param_list='ObjectClass:PathToClass[:AddCreateButtonOrNot[:Filter[:Sortfield]]]'
8794 // Example: $param_list='ObjectClass:PathToClass:#getnomurlparam1=-1#getnomurlparam2=customer'
8795
8796 $InfoFieldList = explode(":", $param_list[0]);
8797
8798 $classname = $InfoFieldList[0];
8799 $classpath = $InfoFieldList[1];
8800
8801 // Set $getnomurlparam1 et getnomurlparam2
8802 $getnomurlparam = 3;
8803 $getnomurlparam2 = '';
8804 $regtmp = array();
8805 if (preg_match('/#getnomurlparam1=([^#]*)/', $param_list[0], $regtmp)) {
8806 $getnomurlparam = $regtmp[1];
8807 }
8808 if (preg_match('/#getnomurlparam2=([^#]*)/', $param_list[0], $regtmp)) {
8809 $getnomurlparam2 = $regtmp[1];
8810 }
8811
8812 if (!empty($classpath)) {
8813 dol_include_once($InfoFieldList[1]);
8814
8815 if ($classname && !class_exists($classname)) {
8816 // from V19 of Dolibarr, In some cases link use element instead of class, example project_task
8817 // TODO use newObjectByElement() introduce in V20 by PR #30036 for better errors management
8818 $element_prop = getElementProperties($classname);
8819 if ($element_prop) {
8820 $classname = $element_prop['classname'];
8821 }
8822 }
8823
8824
8825 if ($classname && class_exists($classname)) {
8826 $object = new $classname($this->db);
8827 '@phan-var-force CommonObject $object';
8828 if ($object->element === 'product') { // Special case for product because default valut of fetch are wrong
8829 '@phan-var-force Product $object';
8830 $result = $object->fetch($value, '', '', '', 0, 1, 1);
8831 } else {
8832 $result = $object->fetch($value);
8833 }
8834 if ($result > 0) {
8835 if ($object->element === 'product') {
8836 '@phan-var-force Product $object';
8837 $get_name_url_param_arr = array($getnomurlparam, $getnomurlparam2, 0, -1, 0, '', 0);
8838 if (isset($val['get_name_url_params'])) {
8839 $get_name_url_params = explode(':', $val['get_name_url_params']);
8840 if (!empty($get_name_url_params)) {
8841 $param_num_max = count($get_name_url_param_arr) - 1;
8842 foreach ($get_name_url_params as $param_num => $param_value) {
8843 if ($param_num > $param_num_max) {
8844 break;
8845 }
8846 $get_name_url_param_arr[$param_num] = $param_value;
8847 }
8848 }
8849 }
8850
8854 $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]);
8855 } else {
8856 $value = $object->getNomUrl($getnomurlparam, $getnomurlparam2);
8857 }
8858 } else {
8859 $value = '';
8860 }
8861 }
8862 } else {
8863 dol_syslog('Error bad setup of extrafield', LOG_WARNING);
8864 return 'Error bad setup of extrafield';
8865 }
8866 } else {
8867 $value = '';
8868 }
8869 } elseif ($type == 'password') {
8870 $value = '<span class="opacitymedium">'.$langs->trans("Encrypted").'</span>';
8871 //$value = preg_replace('/./i', '*', $value);
8872 } elseif ($type == 'array') {
8873 if (is_array($value)) {
8874 $value = implode('<br>', $value);
8875 } else {
8876 dol_syslog(__METHOD__.' Expected array from dol_eval, but got '.gettype($value), LOG_ERR);
8877 return 'Error unexpected result from code evaluation';
8878 }
8879 } else { // text|html|varchar
8880 if (!empty($value) && preg_match('/^text/', (string) $type) && !preg_match('/search_/', $keyprefix) && !empty($param['options'])) {
8881 $value = str_replace(',', "\n", $value);
8882 }
8883 $value = dol_htmlentitiesbr($value);
8884 }
8885
8886 //print $type.'-'.$size.'-'.$value;
8887 $out = $value;
8888
8889 return is_null($out) ? '' : $out;
8890 }
8891
8898 public function clearFieldError($fieldKey)
8899 {
8900 $this->error = '';
8901 unset($this->validateFieldsErrors[$fieldKey]);
8902 }
8903
8911 public function setFieldError($fieldKey, $msg = '')
8912 {
8913 global $langs;
8914 if (empty($msg)) {
8915 $msg = $langs->trans("UnknownError");
8916 }
8917
8918 $this->error = $this->validateFieldsErrors[$fieldKey] = $msg;
8919 }
8920
8927 public function getFieldError($fieldKey)
8928 {
8929 if (!empty($this->validateFieldsErrors[$fieldKey])) {
8930 return $this->validateFieldsErrors[$fieldKey];
8931 }
8932 return '';
8933 }
8934
8943 public function validateField($fields, $fieldKey, $fieldValue)
8944 {
8945 global $langs;
8946
8947 if (!class_exists('Validate')) {
8948 require_once DOL_DOCUMENT_ROOT . '/core/class/validate.class.php';
8949 }
8950
8951 $this->clearFieldError($fieldKey);
8952
8953 if (!array_key_exists($fieldKey, $fields) || !is_array($fields[$fieldKey])) {
8954 $this->setFieldError($fieldKey, $langs->trans('FieldNotFoundInObject'));
8955 return false;
8956 }
8957
8958 $val = $fields[$fieldKey];
8959
8960 $param = array();
8961 $param['options'] = array();
8962 $type = $val['type'];
8963
8964 $required = false;
8965 if (isset($val['notnull']) && $val['notnull'] === 1) {
8966 // 'notnull' is set to 1 if not null in database. Set to -1 if we must set data to null if empty ('' or 0).
8967 $required = true;
8968 }
8969
8970 $maxSize = 0;
8971 $minSize = 0;
8972
8973 //
8974 // PREPARE Elements
8975 //
8976 $reg = array();
8977
8978 // Convert var to be able to share same code than showOutputField of extrafields
8979 if (preg_match('/varchar\‍((\d+)\‍)/', $type, $reg)) {
8980 $type = 'varchar'; // convert varchar(xx) int varchar
8981 $maxSize = $reg[1];
8982 } elseif (preg_match('/varchar/', $type)) {
8983 $type = 'varchar'; // convert varchar(xx) int varchar
8984 }
8985
8986 if (!empty($val['arrayofkeyval']) && is_array($val['arrayofkeyval'])) {
8987 $type = 'select';
8988 }
8989
8990 if (!empty($val['type']) && preg_match('/^integer:(.*):(.*)/i', $val['type'], $reg)) {
8991 $type = 'link';
8992 }
8993
8994 if (!empty($val['arrayofkeyval']) && is_array($val['arrayofkeyval'])) {
8995 $param['options'] = $val['arrayofkeyval'];
8996 }
8997
8998 if (preg_match('/^integer:(.*):(.*)/i', $val['type'], $reg)) {
8999 $type = 'link';
9000 $param['options'] = array($reg[1].':'.$reg[2] => $reg[1].':'.$reg[2]);
9001 } elseif (preg_match('/^sellist:(.*):(.*):(.*):(.*)/i', $val['type'], $reg)) {
9002 $param['options'] = array($reg[1].':'.$reg[2].':'.$reg[3].':'.$reg[4] => 'N');
9003 $type = 'sellist';
9004 } elseif (preg_match('/^sellist:(.*):(.*):(.*)/i', $val['type'], $reg)) {
9005 $param['options'] = array($reg[1].':'.$reg[2].':'.$reg[3] => 'N');
9006 $type = 'sellist';
9007 } elseif (preg_match('/^sellist:(.*):(.*)/i', $val['type'], $reg)) {
9008 $param['options'] = array($reg[1].':'.$reg[2] => 'N');
9009 $type = 'sellist';
9010 }
9011
9012 //
9013 // TEST Value
9014 //
9015
9016 // Use Validate class to allow external Modules to use data validation part instead of concentrate all test here (factoring) or just for reuse
9017 $validate = new Validate($this->db, $langs);
9018
9019
9020 // little trick : to perform tests with good performances sort tests by quick to low
9021
9022 //
9023 // COMMON TESTS
9024 //
9025
9026 // Required test and empty value
9027 if ($required && !$validate->isNotEmptyString($fieldValue)) {
9028 $this->setFieldError($fieldKey, $validate->error);
9029 return false;
9030 } elseif (!$required && !$validate->isNotEmptyString($fieldValue)) {
9031 // if no value sent and the field is not mandatory, no need to perform tests
9032 return true;
9033 }
9034
9035 // MAX Size test
9036 if (!empty($maxSize) && !$validate->isMaxLength($fieldValue, $maxSize)) {
9037 $this->setFieldError($fieldKey, $validate->error);
9038 return false;
9039 }
9040
9041 // MIN Size test
9042 if (!empty($minSize) && !$validate->isMinLength($fieldValue, $minSize)) {
9043 $this->setFieldError($fieldKey, $validate->error);
9044 return false;
9045 }
9046
9047 //
9048 // TESTS for TYPE
9049 //
9050
9051 if (in_array($type, array('date', 'datetime', 'timestamp'))) {
9052 if (!$validate->isTimestamp($fieldValue)) {
9053 $this->setFieldError($fieldKey, $validate->error);
9054 return false;
9055 } else {
9056 return true;
9057 }
9058 } elseif ($type == 'duration') {
9059 if (!$validate->isDuration($fieldValue)) {
9060 $this->setFieldError($fieldKey, $validate->error);
9061 return false;
9062 } else {
9063 return true;
9064 }
9065 } elseif (in_array($type, array('double', 'real', 'price'))) {
9066 // is numeric
9067 if (!$validate->isNumeric($fieldValue)) {
9068 $this->setFieldError($fieldKey, $validate->error);
9069 return false;
9070 } else {
9071 return true;
9072 }
9073 } elseif ($type == 'boolean') {
9074 if (!$validate->isBool($fieldValue)) {
9075 $this->setFieldError($fieldKey, $validate->error);
9076 return false;
9077 } else {
9078 return true;
9079 }
9080 } elseif ($type == 'mail') {
9081 if (!$validate->isEmail($fieldValue)) {
9082 $this->setFieldError($fieldKey, $validate->error);
9083 return false;
9084 }
9085 } elseif ($type == 'url') {
9086 if (!$validate->isUrl($fieldValue)) {
9087 $this->setFieldError($fieldKey, $validate->error);
9088 return false;
9089 } else {
9090 return true;
9091 }
9092 } elseif ($type == 'phone') {
9093 if (!$validate->isPhone($fieldValue)) {
9094 $this->setFieldError($fieldKey, $validate->error);
9095 return false;
9096 } else {
9097 return true;
9098 }
9099 } elseif ($type == 'select' || $type == 'radio') {
9100 if (!isset($param['options'][$fieldValue])) {
9101 $this->error = $langs->trans('RequireValidValue');
9102 return false;
9103 } else {
9104 return true;
9105 }
9106 } elseif ($type == 'sellist' || $type == 'chkbxlst') {
9107 $param_list = array_keys($param['options']);
9108 $InfoFieldList = explode(":", $param_list[0]);
9109 $value_arr = explode(',', $fieldValue);
9110 $value_arr = array_map(array($this->db, 'escape'), $value_arr);
9111
9112 $selectkey = "rowid";
9113 if (count($InfoFieldList) > 4 && !empty($InfoFieldList[4])) {
9114 $selectkey = $InfoFieldList[2];
9115 }
9116
9117 if (!$validate->isInDb($value_arr, $InfoFieldList[0], $selectkey)) {
9118 $this->setFieldError($fieldKey, $validate->error);
9119 return false;
9120 } else {
9121 return true;
9122 }
9123 } elseif ($type == 'link') {
9124 $param_list = array_keys($param['options']); // $param_list='ObjectName:classPath'
9125 $InfoFieldList = explode(":", $param_list[0]);
9126 $classname = $InfoFieldList[0];
9127 $classpath = $InfoFieldList[1];
9128 if (!$validate->isFetchable($fieldValue, $classname, $classpath)) {
9129 $lastIsFetchableError = $validate->error;
9130
9131 // from V19 of Dolibarr, In some cases link use element instead of class, example project_task
9132 if ($validate->isFetchableElement($fieldValue, $classname)) {
9133 return true;
9134 }
9135
9136 $this->setFieldError($fieldKey, $lastIsFetchableError);
9137 return false;
9138 } else {
9139 return true;
9140 }
9141 }
9142
9143 // if no test failed all is ok
9144 return true;
9145 }
9146
9160 public function showOptionals($extrafields, $mode = 'view', $params = null, $keysuffix = '', $keyprefix = '', $onetrtd = '', $display_type = 'card')
9161 {
9162 global $db, $conf, $langs, $action, $form, $hookmanager;
9163
9164 if (!is_object($form)) {
9165 $form = new Form($db);
9166 }
9167 if (!is_object($extrafields)) {
9168 dol_syslog('Bad parameter extrafields for showOptionals', LOG_ERR);
9169 return 'Bad parameter extrafields for showOptionals';
9170 }
9171 if (!is_array($extrafields->attributes[$this->table_element])) {
9172 dol_syslog("extrafields->attributes was not loaded with extrafields->fetch_name_optionals_label(table_element);", LOG_WARNING);
9173 }
9174
9175 $out = '';
9176
9177 $parameters = array('mode' => $mode, 'params' => $params, 'keysuffix' => $keysuffix, 'keyprefix' => $keyprefix, 'display_type' => $display_type);
9178 $reshook = $hookmanager->executeHooks('showOptionals', $parameters, $this, $action); // Note that $action and $object may have been modified by hook
9179
9180 if (empty($reshook)) {
9181 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) {
9182 $out .= "\n";
9183 $out .= '<!-- commonobject:showOptionals --> ';
9184 $out .= "\n";
9185
9186 $nbofextrafieldsshown = 0;
9187 $e = 0; // var to manage the modulo (odd/even)
9188
9189 $lastseparatorkeyfound = '';
9190 $extrafields_collapse_num = '';
9191 $extrafields_collapse_num_old = '';
9192 $i = 0;
9193
9194 foreach ($extrafields->attributes[$this->table_element]['label'] as $key => $label) {
9195 $i++;
9196
9197 // Show only the key field in params @phan-suppress-next-line PhanTypeArraySuspiciousNullable
9198 if (is_array($params) && array_key_exists('onlykey', $params) && $key != $params['onlykey']) {
9199 continue;
9200 }
9201
9202 // Test on 'enabled' ('enabled' is different than 'list' = 'visibility')
9203 $enabled = 1;
9204 if ($enabled && isset($extrafields->attributes[$this->table_element]['enabled'][$key])) {
9205 $enabled = (int) dol_eval((string) $extrafields->attributes[$this->table_element]['enabled'][$key], 1, 1, '2');
9206 }
9207 if (empty($enabled)) {
9208 continue;
9209 }
9210
9211 $visibility = 1;
9212 if (isset($extrafields->attributes[$this->table_element]['list'][$key])) {
9213 $visibility = (int) dol_eval($extrafields->attributes[$this->table_element]['list'][$key], 1, 1, '2');
9214 }
9215
9216 $perms = 1;
9217 if ($perms && isset($extrafields->attributes[$this->table_element]['perms'][$key])) {
9218 $perms = (int) dol_eval($extrafields->attributes[$this->table_element]['perms'][$key], 1, 1, '2');
9219 }
9220
9221 if (($mode == 'create') && !in_array(abs($visibility), array(1, 3))) {
9222 continue; // <> -1 and <> 1 and <> 3 = not visible on forms, only on list
9223 } elseif (($mode == 'edit') && !in_array(abs($visibility), array(1, 3, 4))) {
9224 // We need to make sure, that the values of hidden extrafields are also part of $_POST. Otherwise, they would be empty after an update of the object. See also getOptionalsFromPost
9225 $ef_name = 'options_' . $key;
9226 $ef_value = $this->array_options[$ef_name];
9227 $out .= '<input type="hidden" name="' . $ef_name . '" id="' . $ef_name . '" value="' . $ef_value . '" />' . "\n";
9228 continue; // <> -1 and <> 1 and <> 3 = not visible on forms, only on list and <> 4 = not visible at the creation
9229 } elseif ($mode == 'view' && empty($visibility)) {
9230 continue;
9231 }
9232 if (empty($perms)) {
9233 continue;
9234 }
9235
9236 // Load language if required
9237 if (!empty($extrafields->attributes[$this->table_element]['langfile'][$key])) {
9238 $langs->load($extrafields->attributes[$this->table_element]['langfile'][$key]);
9239 }
9240
9241 $colspan = 0;
9242 $value = null;
9243 if (is_array($params) && count($params) > 0 && $display_type == 'card') {
9244 if (array_key_exists('cols', $params)) {
9245 $colspan = $params['cols'];
9246 } elseif (array_key_exists('colspan', $params)) { // For backward compatibility. Use cols instead now.
9247 $reg = array();
9248 if (preg_match('/colspan="(\d+)"/', $params['colspan'], $reg)) {
9249 $colspan = $reg[1];
9250 } else {
9251 $colspan = $params['colspan'];
9252 }
9253 }
9254 }
9255 $colspan = intval($colspan);
9256
9257 switch ($mode) {
9258 case "view":
9259 $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
9260 break;
9261 case "create":
9262 case "edit":
9263 // We get the value of property found with GETPOST so it takes into account:
9264 // default values overwrite, restore back to list link, ... (but not 'default value in database' of field)
9265 $check = 'alphanohtml';
9266 if (in_array($extrafields->attributes[$this->table_element]['type'][$key], array('html', 'text'))) {
9267 $check = 'restricthtml';
9268 }
9269 $getposttemp = GETPOST($keyprefix.'options_'.$key.$keysuffix, $check, 3); // GETPOST can get value from GET, POST or setup of default values overwrite.
9270 // GETPOST("options_" . $key) can be 'abc' or array(0=>'abc')
9271 if (is_array($getposttemp) || $getposttemp != '' || GETPOSTISSET($keyprefix.'options_'.$key.$keysuffix)) {
9272 if (is_array($getposttemp)) {
9273 // $getposttemp is an array but following code expects a comma separated string
9274 $value = implode(",", $getposttemp);
9275 } else {
9276 $value = $getposttemp;
9277 }
9278 } elseif (in_array($extrafields->attributes[$this->table_element]['type'][$key], array('int'))) {
9279 $value = (!empty($this->array_options["options_".$key]) || (isset($this->array_options["options_".$key]) && $this->array_options["options_".$key] === '0')) ? $this->array_options["options_".$key] : '';
9280 } else {
9281 $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.
9282 }
9283 //var_dump($keyprefix.' - '.$key.' - '.$keysuffix.' - '.$keyprefix.'options_'.$key.$keysuffix.' - '.$this->array_options["options_".$key.$keysuffix].' - '.$getposttemp.' - '.$value);
9284 break;
9285 }
9286
9287 $nbofextrafieldsshown++;
9288
9289 // Output value of the current field
9290 if ($extrafields->attributes[$this->table_element]['type'][$key] == 'separate') {
9291 $extrafields_collapse_num = $key;
9292 /*
9293 $extrafield_param = $extrafields->attributes[$this->table_element]['param'][$key];
9294 if (!empty($extrafield_param) && is_array($extrafield_param)) {
9295 $extrafield_param_list = array_keys($extrafield_param['options']);
9296
9297 if (count($extrafield_param_list) > 0) {
9298 $extrafield_collapse_display_value = intval($extrafield_param_list[0]);
9299
9300 if ($extrafield_collapse_display_value == 1 || $extrafield_collapse_display_value == 2) {
9301 //$extrafields_collapse_num = $extrafields->attributes[$this->table_element]['pos'][$key];
9302 $extrafields_collapse_num = $key;
9303 }
9304 }
9305 }
9306 */
9307
9308 // if colspan=0 or 1, the second column is not extended, so the separator must be on 2 columns
9309 $out .= $extrafields->showSeparator($key, $this, ($colspan ? $colspan + 1 : 2), $display_type, $mode);
9310
9311 $lastseparatorkeyfound = $key;
9312 } else {
9313 $collapse_group = $extrafields_collapse_num.(!empty($this->id) ? '_'.$this->id : '');
9314
9315 $class = (!empty($extrafields->attributes[$this->table_element]['hidden'][$key]) ? 'hideobject ' : '');
9316 $csstyle = '';
9317 if (is_array($params) && count($params) > 0) {
9318 if (array_key_exists('class', $params)) {
9319 $class .= $params['class'].' ';
9320 }
9321 if (array_key_exists('style', $params)) {
9322 $csstyle = $params['style'];
9323 }
9324 }
9325
9326 // add html5 elements
9327 $domData = ' data-element="extrafield"';
9328 $domData .= ' data-targetelement="'.$this->element.'"';
9329 $domData .= ' data-targetid="'.$this->id.'"';
9330
9331 $html_id = (empty($this->id) ? '' : 'extrarow-'.$this->element.'_'.$key.'_'.$this->id);
9332 if ($display_type == 'card') {
9333 if (getDolGlobalString('MAIN_EXTRAFIELDS_USE_TWO_COLUMS') && ($e % 2) == 0) {
9334 $colspan = 0;
9335 }
9336
9337 if ($action == 'selectlines') {
9338 $colspan++;
9339 }
9340 }
9341
9342 // Convert date into timestamp format (value in memory must be a timestamp)
9343 if (in_array($extrafields->attributes[$this->table_element]['type'][$key], array('date'))) {
9344 $datenotinstring = null;
9345 if (array_key_exists('options_'.$key, $this->array_options)) {
9346 $datenotinstring = $this->array_options['options_'.$key];
9347 if (!is_numeric($this->array_options['options_'.$key])) { // For backward compatibility
9348 $datenotinstring = $this->db->jdate($datenotinstring);
9349 }
9350 }
9351 $datekey = $keyprefix.'options_'.$key.$keysuffix;
9352 $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;
9353 }
9354 if (in_array($extrafields->attributes[$this->table_element]['type'][$key], array('datetime'))) {
9355 $datenotinstring = null;
9356 if (array_key_exists('options_'.$key, $this->array_options)) {
9357 $datenotinstring = $this->array_options['options_'.$key];
9358 if (!is_numeric($this->array_options['options_'.$key])) { // For backward compatibility
9359 $datenotinstring = $this->db->jdate($datenotinstring);
9360 }
9361 }
9362 $timekey = $keyprefix.'options_'.$key.$keysuffix;
9363 $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;
9364 }
9365 // Convert float submitted string into real php numeric (value in memory must be a php numeric)
9366 if (in_array($extrafields->attributes[$this->table_element]['type'][$key], array('price', 'double'))) {
9367 if (GETPOSTISSET($keyprefix.'options_'.$key.$keysuffix) || $value) {
9368 $value = price2num($value);
9369 } elseif (isset($this->array_options['options_'.$key])) {
9370 $value = $this->array_options['options_'.$key];
9371 }
9372 }
9373
9374 // HTML, text, select, integer and varchar: take into account default value in database if in create mode
9375 if (in_array($extrafields->attributes[$this->table_element]['type'][$key], array('html', 'text', 'varchar', 'select', 'radio', 'int', 'boolean'))) {
9376 if ($action == 'create' || $mode == 'create') {
9377 $value = (GETPOSTISSET($keyprefix.'options_'.$key.$keysuffix) || $value) ? $value : $extrafields->attributes[$this->table_element]['default'][$key];
9378 }
9379 }
9380
9381 $labeltoshow = $langs->trans($label);
9382 $helptoshow = $langs->trans($extrafields->attributes[$this->table_element]['help'][$key]);
9383 if ($display_type == 'card') {
9384 $out .= '<tr '.($html_id ? 'id="'.$html_id.'" ' : '').$csstyle.' class="field_options_'.$key.' '.$class.$this->element.'_extras_'.$key.' trextrafields_collapse'.$collapse_group.'" '.$domData.' >';
9385 if (getDolGlobalString('MAIN_VIEW_LINE_NUMBER') && ($action == 'view' || $action == 'valid' || $action == 'editline' || $action == 'confirm_valid' || $action == 'confirm_cancel')) {
9386 $out .= '<td></td>';
9387 }
9388 $out .= '<td class="'.(empty($params['tdclass']) ? 'titlefieldmax45' : $params['tdclass']).' wordbreak';
9389 if ($extrafields->attributes[$this->table_element]['type'][$key] == 'text') {
9390 $out .= ' tdtop';
9391 }
9392 } elseif ($display_type == 'line') {
9393 $out .= '<div '.($html_id ? 'id="'.$html_id.'" ' : '').$csstyle.' class="fieldline_options_'.$key.' '.$class.$this->element.'_extras_'.$key.' trextrafields_collapse'.$collapse_group.'" '.$domData.' >';
9394 $out .= '<div style="display: inline-block; padding-right:4px" class="wordbreak';
9395 }
9396 //$out .= "titlefield";
9397 //if (GETPOST('action', 'restricthtml') == 'create') $out.='create';
9398 // BUG #11554 : For public page, use red dot for required fields, instead of bold label
9399 $tpl_context = isset($params["tpl_context"]) ? $params["tpl_context"] : "none";
9400 if ($tpl_context != "public") { // Public page : red dot instead of fieldrequired characters
9401 if ($mode != 'view' && !empty($extrafields->attributes[$this->table_element]['required'][$key])) {
9402 $out .= ' fieldrequired';
9403 }
9404 }
9405 $out .= '">';
9406 if ($tpl_context == "public") { // Public page : red dot instead of fieldrequired characters
9407 if (!empty($extrafields->attributes[$this->table_element]['help'][$key])) {
9408 $out .= $form->textwithpicto($labeltoshow, $helptoshow);
9409 } else {
9410 $out .= $labeltoshow;
9411 }
9412 if ($mode != 'view' && !empty($extrafields->attributes[$this->table_element]['required'][$key])) {
9413 $out .= '&nbsp;<span style="color: red">*</span>';
9414 }
9415 } else {
9416 if (!empty($extrafields->attributes[$this->table_element]['help'][$key])) {
9417 $out .= $form->textwithpicto($labeltoshow, $helptoshow);
9418 } else {
9419 $out .= $labeltoshow;
9420 }
9421 }
9422
9423 $out .= ($display_type == 'card' ? '</td>' : '</div>');
9424
9425 // Second column
9426 $html_id = !empty($this->id) ? $this->element.'_extras_'.$key.'_'.$this->id : '';
9427 if ($display_type == 'card') {
9428 // 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
9429 $out .= '<td '.($html_id ? 'id="'.$html_id.'" ' : '').' class="valuefieldcreate '.$this->element.'_extras_'.$key;
9430 $out .= '" '.($colspan ? ' colspan="'.$colspan.'"' : '');
9431 $out .= '>';
9432 } elseif ($display_type == 'line') {
9433 $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].'">';
9434 }
9435
9436 switch ($mode) {
9437 case "view":
9438 $out .= $extrafields->showOutputField($key, $value, '', $this->table_element);
9439 break;
9440 case "create":
9441 $listoftypestoshowpicto = explode(',', getDolGlobalString('MAIN_TYPES_TO_SHOW_PICTO', 'email,phone,ip,password'));
9442 if (in_array($extrafields->attributes[$this->table_element]['type'][$key], $listoftypestoshowpicto)) {
9443 $out .= getPictoForType($extrafields->attributes[$this->table_element]['type'][$key], ($extrafields->attributes[$this->table_element]['type'][$key] == 'text' ? 'tdtop' : ''));
9444 }
9445 //$out .= '<!-- type = '.$extrafields->attributes[$this->table_element]['type'][$key].' -->';
9446 $out .= $extrafields->showInputField($key, $value, '', $keysuffix, '', 0, $this, $this->table_element);
9447 break;
9448 case "edit":
9449 $listoftypestoshowpicto = explode(',', getDolGlobalString('MAIN_TYPES_TO_SHOW_PICTO', 'email,phone,ip,password'));
9450 if (in_array($extrafields->attributes[$this->table_element]['type'][$key], $listoftypestoshowpicto)) {
9451 $out .= getPictoForType($extrafields->attributes[$this->table_element]['type'][$key], ($extrafields->attributes[$this->table_element]['type'][$key] == 'text' ? 'tdtop' : ''));
9452 }
9453 $out .= $extrafields->showInputField($key, $value, '', $keysuffix, '', '', $this, $this->table_element);
9454 break;
9455 }
9456
9457 $out .= ($display_type == 'card' ? '</td>' : '</div>');
9458 $out .= ($display_type == 'card' ? '</tr>'."\n" : '</div>');
9459 $e++;
9460 }
9461 }
9462 $out .= "\n";
9463 // Add code to manage list depending on others
9464 if (!empty($conf->use_javascript_ajax)) {
9465 $out .= $this->getJSListDependancies();
9466 }
9467
9468 $out .= '<!-- commonobject:showOptionals end --> '."\n";
9469
9470 if (empty($nbofextrafieldsshown)) {
9471 $out = '';
9472 }
9473 }
9474 }
9475
9476 $out .= $hookmanager->resPrint;
9477
9478 return $out;
9479 }
9480
9485 public function getJSListDependancies($type = '_extra')
9486 {
9487 $out = '
9488 <script nonce="'.getNonce().'">
9489 jQuery(document).ready(function() {
9490 function showOptions'.$type.'(child_list, parent_list, orig_select)
9491 {
9492 var val = $("select[name=\""+parent_list+"\"]").val();
9493 var parentVal = parent_list + ":" + val;
9494 if(typeof val == "string"){
9495 if(val != "") {
9496 var options = orig_select.find("option[parent=\""+parentVal+"\"]").clone();
9497 $("select[name=\""+child_list+"\"] option[parent]").remove();
9498 $("select[name=\""+child_list+"\"]").append(options);
9499 } else {
9500 var options = orig_select.find("option[parent]").clone();
9501 $("select[name=\""+child_list+"\"] option[parent]").remove();
9502 $("select[name=\""+child_list+"\"]").append(options);
9503 }
9504 } else if(val > 0) {
9505 var options = orig_select.find("option[parent=\""+parentVal+"\"]").clone();
9506 $("select[name=\""+child_list+"\"] option[parent]").remove();
9507 $("select[name=\""+child_list+"\"]").append(options);
9508 } else {
9509 var options = orig_select.find("option[parent]").clone();
9510 $("select[name=\""+child_list+"\"] option[parent]").remove();
9511 $("select[name=\""+child_list+"\"]").append(options);
9512 }
9513 }
9514 function setListDependencies'.$type.'() {
9515 jQuery("select option[parent]").parent().each(function() {
9516 var orig_select = {};
9517 var child_list = $(this).attr("name");
9518 orig_select[child_list] = $(this).clone();
9519 var parent = $(this).find("option[parent]:first").attr("parent");
9520 var infos = parent.split(":");
9521 var parent_list = infos[0];
9522
9523 //Hide daughters lists
9524 if ($("#"+child_list).val() == 0 && $("#"+parent_list).val() == 0){
9525 $("#"+child_list).hide();
9526 //Show mother lists
9527 } else if ($("#"+parent_list).val() != 0){
9528 $("#"+parent_list).show();
9529 }
9530 //Show the child list if the parent list value is selected
9531 $("select[name=\""+parent_list+"\"]").click(function() {
9532 if ($(this).val() != 0){
9533 $("#"+child_list).show()
9534 }
9535 });
9536
9537 //When we change parent list
9538 $("select[name=\""+parent_list+"\"]").change(function() {
9539 showOptions'.$type.'(child_list, parent_list, orig_select[child_list]);
9540 //Select the value 0 on child list after a change on the parent list
9541 $("#"+child_list).val(0).trigger("change");
9542 //Hide child lists if the parent value is set to 0
9543 if ($(this).val() == 0){
9544 $("#"+child_list).hide();
9545 }
9546 });
9547 });
9548 }
9549
9550 setListDependencies'.$type.'();
9551 });
9552 </script>'."\n";
9553 return $out;
9554 }
9555
9561 public function getRights()
9562 {
9563 global $user;
9564
9565 $module = empty($this->module) ? '' : $this->module;
9566 $element = $this->element;
9567
9568 if ($element == 'facturerec') {
9569 $element = 'facture';
9570 } elseif ($element == 'invoice_supplier_rec') {
9571 return !$user->hasRight('fournisseur', 'facture') ? null : $user->hasRight('fournisseur', 'facture');
9572 } elseif ($module && $user->hasRight($module, $element)) {
9573 // for modules built with ModuleBuilder
9574 return $user->hasRight($module, $element);
9575 }
9576
9577 return $user->rights->$element;
9578 }
9579
9592 public static function commonReplaceThirdparty(DoliDB $dbs, $origin_id, $dest_id, array $tables, $ignoreerrors = 0)
9593 {
9594 global $hookmanager;
9595
9596 $parameters = array(
9597 'origin_id' => $origin_id,
9598 'dest_id' => $dest_id,
9599 'tables' => $tables,
9600 );
9601 $reshook = $hookmanager->executeHooks('commonReplaceThirdparty', $parameters);
9602 if ($reshook) {
9603 return true; // replacement code
9604 } elseif ($reshook < 0) {
9605 return $ignoreerrors === 1; // failure
9606 } // reshook = 0 => execute normal code
9607
9608 foreach ($tables as $table) {
9609 $sql = 'UPDATE '.$dbs->prefix().$table.' SET fk_soc = '.((int) $dest_id).' WHERE fk_soc = '.((int) $origin_id);
9610
9611 if (!$dbs->query($sql)) {
9612 if ($ignoreerrors) {
9613 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.
9614 }
9615 //$this->errors = $db->lasterror();
9616 return false;
9617 }
9618 }
9619
9620 return true;
9621 }
9622
9635 public static function commonReplaceProduct(DoliDB $dbs, $origin_id, $dest_id, array $tables, $ignoreerrors = 0)
9636 {
9637 foreach ($tables as $table) {
9638 $sql = 'UPDATE '.MAIN_DB_PREFIX.$table.' SET fk_product = '.((int) $dest_id).' WHERE fk_product = '.((int) $origin_id);
9639
9640 if (!$dbs->query($sql)) {
9641 if ($ignoreerrors) {
9642 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.
9643 }
9644 //$this->errors = $db->lasterror();
9645 return false;
9646 }
9647 }
9648
9649 return true;
9650 }
9651
9664 public function defineBuyPrice($unitPrice = 0.0, $discountPercent = 0.0, $fk_product = 0)
9665 {
9666 global $conf;
9667
9668 $buyPrice = 0;
9669
9670 if (($unitPrice > 0) && (isset($conf->global->ForceBuyingPriceIfNull) && getDolGlobalInt('ForceBuyingPriceIfNull') > 0)) {
9671 // When ForceBuyingPriceIfNull is set
9672 $buyPrice = $unitPrice * (1 - $discountPercent / 100);
9673 } else {
9674 // Get cost price for margin calculation
9675 if (!empty($fk_product) && $fk_product > 0) {
9676 $result = 0;
9677 if (getDolGlobalString('MARGIN_TYPE') == 'costprice') {
9678 require_once DOL_DOCUMENT_ROOT.'/product/class/product.class.php';
9679 $product = new Product($this->db);
9680 $result = $product->fetch($fk_product);
9681 if ($result <= 0) {
9682 $this->errors[] = 'ErrorProductIdDoesNotExists';
9683 return -1;
9684 }
9685 if ($product->cost_price > 0) {
9686 $buyPrice = $product->cost_price;
9687 } elseif ($product->pmp > 0) {
9688 $buyPrice = $product->pmp;
9689 }
9690 } elseif (getDolGlobalString('MARGIN_TYPE') == 'pmp') {
9691 require_once DOL_DOCUMENT_ROOT.'/product/class/product.class.php';
9692 $product = new Product($this->db);
9693 $result = $product->fetch($fk_product);
9694 if ($result <= 0) {
9695 $this->errors[] = 'ErrorProductIdDoesNotExists';
9696 return -1;
9697 }
9698 if ($product->pmp > 0) {
9699 $buyPrice = $product->pmp;
9700 }
9701 }
9702
9703 if (empty($buyPrice) && isset($conf->global->MARGIN_TYPE) && in_array($conf->global->MARGIN_TYPE, array('1', 'pmp', 'costprice'))) {
9704 require_once DOL_DOCUMENT_ROOT.'/fourn/class/fournisseur.product.class.php';
9705 $productFournisseur = new ProductFournisseur($this->db);
9706 if (($result = $productFournisseur->find_min_price_product_fournisseur($fk_product)) > 0) {
9707 $buyPrice = $productFournisseur->fourn_unitprice;
9708 } elseif ($result < 0) {
9709 $this->errors[] = $productFournisseur->error;
9710 return -2;
9711 }
9712 }
9713 }
9714 }
9715
9716 return (float) $buyPrice;
9717 }
9718
9726 public function getDataToShowPhoto($modulepart, $imagesize)
9727 {
9728 // See getDataToShowPhoto() implemented by Product for example.
9729 return array('dir' => '', 'file' => '', 'originalfile' => '', 'altfile' => '', 'email' => '', 'capture' => '');
9730 }
9731
9732
9733 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
9753 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')
9754 {
9755 // phpcs:enable
9756 global $user, $langs;
9757
9758 include_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
9759 include_once DOL_DOCUMENT_ROOT.'/core/lib/images.lib.php';
9760
9761 $sortfield = 'position_name';
9762 $sortorder = 'asc';
9763
9764 $dir = $sdir.'/';
9765 $pdir = '/';
9766
9767 $dir .= get_exdir(0, 0, 0, 0, $this, $modulepart);
9768 $pdir .= get_exdir(0, 0, 0, 0, $this, $modulepart);
9769
9770 // For backward compatibility
9771 if ($modulepart == 'product') {
9772 if (getDolGlobalInt('PRODUCT_USE_OLD_PATH_FOR_PHOTO')) {
9773 $dir = $sdir.'/'.get_exdir($this->id, 2, 0, 0, $this, $modulepart).$this->id."/photos/";
9774 $pdir = '/'.get_exdir($this->id, 2, 0, 0, $this, $modulepart).$this->id."/photos/";
9775 }
9776 }
9777 if ($modulepart == 'category') {
9778 $dir = $sdir.'/'.get_exdir($this->id, 2, 0, 0, $this, $modulepart).$this->id."/photos/";
9779 $pdir = '/'.get_exdir($this->id, 2, 0, 0, $this, $modulepart).$this->id."/photos/";
9780 }
9781
9782 // Defined relative dir to DOL_DATA_ROOT
9783 $relativedir = '';
9784 if ($dir) {
9785 $relativedir = preg_replace('/^'.preg_quote(DOL_DATA_ROOT, '/').'/', '', $dir);
9786 $relativedir = preg_replace('/^[\\/]/', '', $relativedir);
9787 $relativedir = preg_replace('/[\\/]$/', '', $relativedir);
9788 }
9789
9790 $dirthumb = $dir.'thumbs/';
9791 $pdirthumb = $pdir.'thumbs/';
9792
9793 $return = '<!-- Photo -->'."\n";
9794 $nbphoto = 0;
9795
9796 $filearray = dol_dir_list($dir, "files", 0, '', '(\.meta|_preview.*\.png)$', $sortfield, (strtolower($sortorder) == 'desc' ? SORT_DESC : SORT_ASC), 1);
9797
9798 /*if (getDolGlobalInt('PRODUCT_USE_OLD_PATH_FOR_PHOTO')) // For backward compatibility, we scan also old dirs
9799 {
9800 $filearrayold=dol_dir_list($dirold,"files",0,'','(\.meta|_preview.*\.png)$',$sortfield,(strtolower($sortorder)=='desc'?SORT_DESC:SORT_ASC),1);
9801 $filearray=array_merge($filearray, $filearrayold);
9802 }*/
9803
9804 completeFileArrayWithDatabaseInfo($filearray, $relativedir, $this);
9805 '@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';
9806
9807 if (count($filearray)) {
9808 if ($sortfield && $sortorder) {
9809 $filearray = dol_sort_array($filearray, $sortfield, $sortorder);
9810 }
9811
9812 foreach ($filearray as $key => $val) {
9813 $photo = '';
9814 $file = $val['name'];
9815
9816 //if (dol_is_file($dir.$file) && image_format_supported($file) >= 0)
9817 if (image_format_supported($file) >= 0) {
9818 $nbphoto++;
9819 $photo = $file;
9820 $viewfilename = $file;
9821
9822 if ($size == 1 || $size == 'small') { // Format vignette
9823 // Find name of thumb file
9824 $photo_vignette = basename(getImageFileNameForSize($dir.$file, '_small'));
9825 if (!dol_is_file($dirthumb.$photo_vignette)) {
9826 // The thumb does not exists, so we will use the original file
9827 $dirthumb = $dir;
9828 $pdirthumb = $pdir;
9829 $photo_vignette = basename($file);
9830 }
9831
9832 // Get filesize of original file
9833 $imgarray = dol_getImageSize($dir.$photo);
9834
9835 if ($nbbyrow > 0) {
9836 if ($nbphoto == 1) {
9837 $return .= '<table class="valigntop center centpercent" style="border: 0; padding: 2px; border-spacing: 2px; border-collapse: separate;">';
9838 }
9839
9840 if ($nbphoto % $nbbyrow == 1) {
9841 $return .= '<tr class="center valignmiddle" style="border: 1px">';
9842 }
9843 $return .= '<td style="width: '.ceil(100 / $nbbyrow).'%" class="photo">'."\n";
9844 } elseif ($nbbyrow < 0) {
9845 $return .= '<div class="inline-block">'."\n";
9846 }
9847
9848 $relativefile = preg_replace('/^\//', '', $pdir.$photo);
9849 if (empty($nolink)) {
9850 $urladvanced = getAdvancedPreviewUrl($modulepart, $relativefile, 0, 'entity='.$this->entity);
9851 if ($urladvanced) {
9852 $return .= '<a href="'.$urladvanced.'">';
9853 } else {
9854 $return .= '<a href="'.DOL_URL_ROOT.'/viewimage.php?modulepart='.$modulepart.'&entity='.$this->entity.'&file='.urlencode($pdir.$photo).'" class="aphoto" target="_blank" rel="noopener noreferrer">';
9855 }
9856 }
9857
9858 // Show image (width height=$maxHeight)
9859 // Si fichier vignette disponible et image source trop grande, on utilise la vignette, sinon on utilise photo origine
9860 $alt = $langs->transnoentitiesnoconv('File').': '.$relativefile;
9861 $alt .= ' - '.$langs->transnoentitiesnoconv('Size').': '.$imgarray['width'].'x'.$imgarray['height'];
9862 if ($overwritetitle) {
9863 if (is_numeric($overwritetitle)) {
9864 $alt = '';
9865 } else {
9866 $alt = $overwritetitle;
9867 }
9868 }
9869 if (empty($cache) && !empty($val['label'])) {
9870 // label is md5 of file
9871 // use it in url to say we want to cache this version of the file
9872 $cache = $val['label'];
9873 }
9874 if ($usesharelink) {
9875 if (array_key_exists('share', $val) && $val['share']) {
9876 if (empty($maxHeight) || ($photo_vignette && $imgarray['height'] > $maxHeight)) {
9877 $return .= '<!-- Show original file (thumb not yet available with shared links) -->';
9878 $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).'">';
9879 } else {
9880 $return .= '<!-- Show original file -->';
9881 $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).'">';
9882 }
9883 } else {
9884 $return .= '<!-- Show nophoto file (because file is not shared) -->';
9885 $return .= '<img class="photo photowithmargin'.($addphotorefcss ? ' '.$addphotorefcss : '').'" height="'.$maxHeight.'" src="'.DOL_URL_ROOT.'/public/theme/common/nophoto.png" title="'.dol_escape_htmltag($alt).'">';
9886 }
9887 } else {
9888 if (empty($maxHeight) || ($photo_vignette && $imgarray['height'] > $maxHeight)) {
9889 $return .= '<!-- Show thumb -->';
9890 $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).'">';
9891 } else {
9892 $return .= '<!-- Show original file -->';
9893 $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).'">';
9894 }
9895 }
9896
9897 if (empty($nolink)) {
9898 $return .= '</a>';
9899 }
9900
9901 if ($showfilename) {
9902 $return .= '<br>'.$viewfilename;
9903 }
9904 if ($showaction) {
9905 $return .= '<br>';
9906 // If $photo_vignette set, we add a link to generate thumbs if file is an image and width or height higher than limits
9907 if ($photo_vignette && (image_format_supported($photo) > 0) && ((isset($imgarray['width']) && $imgarray['width'] > $maxWidth) || (isset($imgarray['width']) && $imgarray['width'] > $maxHeight))) {
9908 $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>';
9909 }
9910 // Special case for product
9911 if ($modulepart == 'product' && ($user->hasRight('produit', 'creer') || $user->hasRight('service', 'creer'))) {
9912 // Link to resize
9913 $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; ';
9914
9915 // Link to delete
9916 $return .= '<a href="'.$_SERVER["PHP_SELF"].'?id='.$this->id.'&action=delete&token='.newToken().'&file='.urlencode($pdir.$viewfilename).'">';
9917 $return .= img_delete().'</a>';
9918 }
9919 }
9920 $return .= "\n";
9921
9922 if ($nbbyrow > 0) {
9923 $return .= '</td>';
9924 if (($nbphoto % $nbbyrow) == 0) {
9925 $return .= '</tr>';
9926 }
9927 } elseif ($nbbyrow < 0) {
9928 $return .= '</div>'."\n";
9929 }
9930 }
9931
9932 if (empty($size)) { // Format origine
9933 $return .= '<img class="photo photowithmargin" src="'.DOL_URL_ROOT.'/viewimage.php?modulepart='.$modulepart.'&entity='.$this->entity.'&file='.urlencode($pdir.$photo).'">';
9934
9935 if ($showfilename) {
9936 $return .= '<br>'.$viewfilename;
9937 }
9938 if ($showaction) {
9939 // Special case for product
9940 if ($modulepart == 'product' && ($user->hasRight('produit', 'creer') || $user->hasRight('service', 'creer'))) {
9941 // Link to resize
9942 $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; ';
9943
9944 // Link to delete
9945 $return .= '<a href="'.$_SERVER["PHP_SELF"].'?id='.$this->id.'&action=delete&token='.newToken().'&file='.urlencode($pdir.$viewfilename).'">';
9946 $return .= img_delete().'</a>';
9947 }
9948 }
9949 }
9950
9951 // On continue ou on arrete de boucler ?
9952 if ($nbmax && $nbphoto >= $nbmax) {
9953 break;
9954 }
9955 }
9956 }
9957
9958 if ($size == 1 || $size == 'small') {
9959 if ($nbbyrow > 0) {
9960 // Ferme tableau
9961 while ($nbphoto % $nbbyrow) {
9962 $return .= '<td style="width: '.ceil(100 / $nbbyrow).'%">&nbsp;</td>';
9963 $nbphoto++;
9964 }
9965
9966 if ($nbphoto) {
9967 $return .= '</table>';
9968 }
9969 }
9970 }
9971 }
9972
9973 $this->nbphoto = $nbphoto;
9974
9975 return $return;
9976 }
9977
9978
9985 protected function isArray($info)
9986 {
9987 if (is_array($info)) {
9988 if (isset($info['type']) && $info['type'] == 'array') {
9989 return true;
9990 } else {
9991 return false;
9992 }
9993 }
9994 return false;
9995 }
9996
10003 public function isDate($info)
10004 {
10005 if (isset($info['type']) && ($info['type'] == 'date' || $info['type'] == 'datetime' || $info['type'] == 'timestamp')) {
10006 return true;
10007 }
10008 return false;
10009 }
10010
10017 public function isDuration($info)
10018 {
10019 if (is_array($info)) {
10020 if (isset($info['type']) && ($info['type'] == 'duration')) {
10021 return true;
10022 } else {
10023 return false;
10024 }
10025 } else {
10026 return false;
10027 }
10028 }
10029
10036 public function isInt($info)
10037 {
10038 if (is_array($info)) {
10039 if (isset($info['type']) && (preg_match('/(^int|int$)/i', $info['type']))) {
10040 return true;
10041 } else {
10042 return false;
10043 }
10044 } else {
10045 return false;
10046 }
10047 }
10048
10055 public function isFloat($info)
10056 {
10057 if (is_array($info)) {
10058 if (isset($info['type']) && (preg_match('/^(double|real|price)/i', $info['type']))) {
10059 return true;
10060 } else {
10061 return false;
10062 }
10063 }
10064 return false;
10065 }
10066
10073 public function isText($info)
10074 {
10075 if (is_array($info)) {
10076 if (isset($info['type']) && $info['type'] == 'text') {
10077 return true;
10078 } else {
10079 return false;
10080 }
10081 }
10082 return false;
10083 }
10084
10091 protected function canBeNull($info)
10092 {
10093 if (is_array($info)) {
10094 if (array_key_exists('notnull', $info) && $info['notnull'] != '1') {
10095 return true;
10096 } else {
10097 return false;
10098 }
10099 }
10100 return true;
10101 }
10102
10109 protected function isForcedToNullIfZero($info)
10110 {
10111 if (is_array($info)) {
10112 if (array_key_exists('notnull', $info) && $info['notnull'] == '-1') {
10113 return true;
10114 } else {
10115 return false;
10116 }
10117 }
10118 return false;
10119 }
10120
10127 protected function isIndex($info)
10128 {
10129 if (is_array($info)) {
10130 if (array_key_exists('index', $info) && $info['index'] == true) {
10131 return true;
10132 } else {
10133 return false;
10134 }
10135 }
10136 return false;
10137 }
10138
10139
10148 protected function setSaveQuery()
10149 {
10150 global $conf;
10151
10152 $queryarray = array();
10153 foreach ($this->fields as $field => $info) { // Loop on definition of fields
10154 // Depending on field type ('datetime', ...)
10155 if ($this->isDate($info)) {
10156 if (empty($this->{$field})) {
10157 $queryarray[$field] = null;
10158 } else {
10159 $queryarray[$field] = $this->db->idate($this->{$field});
10160 }
10161 } elseif ($this->isDuration($info)) {
10162 // $this->{$field} may be null, '', 0, '0', 123, '123'
10163 if ((isset($this->{$field}) && $this->{$field} != '') || !empty($info['notnull'])) {
10164 if (!isset($this->{$field})) {
10165 if (!empty($info['default'])) {
10166 $queryarray[$field] = $info['default'];
10167 } else {
10168 $queryarray[$field] = 0;
10169 }
10170 } else {
10171 $queryarray[$field] = (int) $this->{$field}; // If '0', it may be set to null later if $info['notnull'] == -1
10172 }
10173 } else {
10174 $queryarray[$field] = null;
10175 }
10176 } elseif ($this->isInt($info) || $this->isFloat($info)) {
10177 if ($field == 'entity' && is_null($this->{$field})) {
10178 $queryarray[$field] = ((int) $conf->entity);
10179 } else {
10180 // $this->{$field} may be null, '', 0, '0', 123, '123'
10181 if ((isset($this->{$field}) && ((string) $this->{$field}) != '') || !empty($info['notnull'])) {
10182 if (!isset($this->{$field})) {
10183 $queryarray[$field] = 0;
10184 } elseif ($this->isInt($info)) {
10185 $queryarray[$field] = (int) $this->{$field}; // If '0', it may be set to null later if $info['notnull'] == -1
10186 } elseif ($this->isFloat($info)) {
10187 $queryarray[$field] = (float) $this->{$field}; // If '0', it may be set to null later if $info['notnull'] == -1
10188 }
10189 } else {
10190 $queryarray[$field] = null;
10191 }
10192 }
10193 } else {
10194 // Note: If $this->{$field} is not defined, it means there is a bug into definition of ->fields or a missing declaration of property
10195 // We should keep the warning generated by this because it is a bug somewhere else in code, not here.
10196 $queryarray[$field] = $this->{$field};
10197 }
10198
10199 if (array_key_exists('type', $info) && $info['type'] == 'timestamp' && empty($queryarray[$field])) {
10200 unset($queryarray[$field]);
10201 }
10202 if (!empty($info['notnull']) && $info['notnull'] == -1 && empty($queryarray[$field])) {
10203 $queryarray[$field] = null; // May force 0 to null
10204 }
10205 }
10206
10207 return $queryarray;
10208 }
10209
10216 public function setVarsFromFetchObj(&$obj)
10217 {
10218 global $db;
10219
10220 foreach ($this->fields as $field => $info) {
10221 if ($this->isDate($info)) {
10222 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') {
10223 $this->$field = '';
10224 } else {
10225 $this->$field = $db->jdate($obj->$field);
10226 }
10227 } elseif ($this->isInt($info)) {
10228 if ($field == 'rowid') {
10229 $this->id = (int) $obj->$field;
10230 } else {
10231 if ($this->isForcedToNullIfZero($info)) {
10232 if (empty($obj->$field)) {
10233 $this->$field = null;
10234 } else {
10235 $this->$field = (int) $obj->$field;
10236 }
10237 } else {
10238 if (isset($obj->$field) && (!is_null($obj->$field) || (array_key_exists('notnull', $info) && $info['notnull'] == 1))) {
10239 $this->$field = (int) $obj->$field;
10240 } else {
10241 $this->$field = null;
10242 }
10243 }
10244 }
10245 } elseif ($this->isFloat($info)) {
10246 if ($this->isForcedToNullIfZero($info)) {
10247 if (empty($obj->$field)) {
10248 $this->$field = null;
10249 } else {
10250 $this->$field = (float) $obj->$field;
10251 }
10252 } else {
10253 if (isset($obj->$field) && (!is_null($obj->$field) || (array_key_exists('notnull', $info) && $info['notnull'] == 1))) {
10254 $this->$field = (float) $obj->$field;
10255 } else {
10256 $this->$field = null;
10257 }
10258 }
10259 } else {
10260 $this->$field = isset($obj->$field) ? $obj->$field : null;
10261 }
10262 }
10263
10264 // If there is no 'ref' field, we force property ->ref to ->id for a better compatibility with common functions.
10265 if (!isset($this->fields['ref']) && isset($this->id)) {
10266 $this->ref = (string) $this->id;
10267 }
10268 }
10269
10274 public function emtpyObjectVars()
10275 {
10276 foreach ($this->fields as $field => $arr) {
10277 $this->$field = null;
10278 }
10279 }
10280
10288 public function getFieldList($alias = '', $excludefields = array())
10289 {
10290 $keys = array_keys($this->fields);
10291 if (!empty($alias)) {
10292 $keys_with_alias = array();
10293 foreach ($keys as $fieldname) {
10294 if (!empty($excludefields)) {
10295 if (in_array($fieldname, $excludefields)) { // The field is excluded and must not be in output
10296 continue;
10297 }
10298 }
10299 $keys_with_alias[] = $alias . '.' . $fieldname;
10300 }
10301 return implode(',', $keys_with_alias);
10302 } else {
10303 return implode(',', $keys);
10304 }
10305 }
10306
10314 protected function quote($value, $fieldsentry)
10315 {
10316 if (is_null($value)) {
10317 return 'NULL';
10318 } elseif (preg_match('/^(int|double|real|price)/i', $fieldsentry['type'])) {
10319 return price2num((string) $value);
10320 } elseif (preg_match('/int$/i', $fieldsentry['type'])) {
10321 return (int) $value;
10322 } elseif ($fieldsentry['type'] == 'boolean') {
10323 if ($value) {
10324 return 'true';
10325 } else {
10326 return 'false';
10327 }
10328 } else {
10329 return "'".$this->db->escape($value)."'";
10330 }
10331 }
10332
10333
10341 public function createCommon(User $user, $notrigger = 0)
10342 {
10343 global $langs;
10344
10345 dol_syslog(get_class($this)."::createCommon create", LOG_DEBUG);
10346
10347 $error = 0;
10348
10349 $now = dol_now();
10350
10351 $fieldvalues = $this->setSaveQuery();
10352
10353 // Note: Here, $fieldvalues contains same keys (or less) that are inside ->fields
10354
10355 if (array_key_exists('date_creation', $fieldvalues) && empty($fieldvalues['date_creation'])) {
10356 $fieldvalues['date_creation'] = $this->db->idate($now);
10357 $this->date_creation = $this->db->idate($now);
10358 }
10359 // For backward compatibility, if a property ->fk_user_creat exists and not filled.
10360 if (array_key_exists('fk_user_creat', $fieldvalues) && !($fieldvalues['fk_user_creat'] > 0)) {
10361 $fieldvalues['fk_user_creat'] = $user->id;
10362 $this->fk_user_creat = $user->id;
10363 }
10364 if (array_key_exists('user_creation_id', $fieldvalues) && !($fieldvalues['user_creation_id'] > 0)) {
10365 $fieldvalues['user_creation_id'] = $user->id;
10366 $this->user_creation_id = $user->id;
10367 }
10368 if (array_key_exists('pass_crypted', $fieldvalues) && property_exists($this, 'pass')) {
10369 // @phan-suppress-next-line PhanUndeclaredProperty
10370 $tmparray = dol_hash($this->pass, '0', 0, 1);
10371 $fieldvalues['pass_crypted'] = $tmparray['pass_encrypted'];
10372 if (array_key_exists('pass_encoding', $fieldvalues) && property_exists($this, 'pass_encoding')) {
10373 $fieldvalues['pass_encoding'] = $tmparray['pass_encoding'];
10374 }
10375 }
10376 if (array_key_exists('ref', $fieldvalues)) {
10377 $fieldvalues['ref'] = dol_string_nospecial($fieldvalues['ref']); // If field is a ref, we sanitize data
10378 }
10379
10380 unset($fieldvalues['rowid']); // The field 'rowid' is reserved field name for autoincrement field so we don't need it into insert.
10381
10382 $keys = array();
10383 $values = array(); // Array to store string forged for SQL syntax
10384 foreach ($fieldvalues as $k => $v) {
10385 $keys[$k] = $k;
10386 $value = $this->fields[$k];
10387 // @phan-suppress-next-line PhanPluginSuspiciousParamPosition
10388 $values[$k] = $this->quote($v, $value); // May return string 'NULL' if $value is null
10389 }
10390
10391 // Clean and check mandatory
10392 foreach ($keys as $key) {
10393 if (!isset($this->fields[$key])) {
10394 continue;
10395 }
10396 $key_fields = $this->fields[$key];
10397
10398 // If field is an implicit foreign key field (so type = 'integer:...')
10399 if (preg_match('/^integer:/i', $key_fields['type']) && $values[$key] == '-1') {
10400 $values[$key] = '';
10401 }
10402 if (!empty($key_fields['foreignkey']) && $values[$key] == '-1') {
10403 $values[$key] = '';
10404 }
10405
10406 if (isset($key_fields['notnull']) && $key_fields['notnull'] == 1 && (!isset($values[$key]) || $values[$key] === 'NULL') && (!isset($key_fields['default']) || is_null($key_fields['default']))) {
10407 $error++;
10408 $langs->load("errors");
10409 dol_syslog("Mandatory field '".$key."' is empty and required into ->fields definition of class");
10410 $this->errors[] = $langs->trans("ErrorFieldRequired", isset($key_fields['label']) ? $key_fields['label'] : $key);
10411 }
10412
10413 // If value is null and there is a default value for field @phan-suppress-next-line PhanTypePossiblyInvalidDimOffset
10414 if (isset($key_fields['notnull']) && $key_fields['notnull'] == 1 && (!isset($values[$key]) || $values[$key] === 'NULL') && !is_null($key_fields['default'])) {
10415 $values[$key] = $this->quote($key_fields['default'], $key_fields);
10416 }
10417
10418 // If field is an implicit foreign key field (so type = 'integer:...')
10419 if (isset($key_fields['type']) && preg_match('/^integer:/i', $key_fields['type']) && empty($values[$key])) {
10420 if (isset($key_fields['default'])) {
10421 $values[$key] = ((int) $key_fields['default']);
10422 } else {
10423 $values[$key] = 'null';
10424 }
10425 }
10426 if (!empty($key_fields['foreignkey']) && empty($values[$key])) {
10427 $values[$key] = 'null';
10428 }
10429 }
10430
10431 if ($error) {
10432 return -1;
10433 }
10434
10435 $this->db->begin();
10436
10437 if (!$error) {
10438 $sql = "INSERT INTO ".$this->db->prefix().$this->table_element;
10439 $sql .= " (".implode(", ", $keys).')';
10440 $sql .= " VALUES (".implode(", ", $values).")"; // $values can contains 'abc' or 123
10441
10442 $res = $this->db->query($sql);
10443 if (!$res) {
10444 $error++;
10445 if ($this->db->lasterrno() == 'DB_ERROR_RECORD_ALREADY_EXISTS') {
10446 $this->errors[] = "ErrorRefAlreadyExists";
10447 } else {
10448 $this->errors[] = $this->db->lasterror();
10449 }
10450 }
10451 }
10452
10453 if (!$error) {
10454 $this->id = $this->db->last_insert_id($this->db->prefix().$this->table_element);
10455 }
10456
10457 // If we have a field ref with a default value of (PROV)
10458 if (!$error) {
10459 // @phan-suppress-next-line PhanTypePossiblyInvalidDimOffset
10460 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)') {
10461 $sql = "UPDATE ".$this->db->prefix().$this->table_element." SET ref = '(PROV".((int) $this->id).")' WHERE (ref = '(PROV)' OR ref = '') AND rowid = ".((int) $this->id);
10462 $resqlupdate = $this->db->query($sql);
10463
10464 if ($resqlupdate === false) {
10465 $error++;
10466 $this->errors[] = $this->db->lasterror();
10467 } else {
10468 $this->ref = '(PROV'.$this->id.')';
10469 }
10470 }
10471 }
10472
10473 // Create extrafields
10474 if (!$error) {
10475 $result = $this->insertExtraFields();
10476 if ($result < 0) {
10477 $error++;
10478 }
10479 }
10480
10481 // Create lines
10482 if (!empty($this->table_element_line) && !empty($this->fk_element) && !empty($this->lines)) {
10483 foreach ($this->lines as $line) {
10484 $keyforparent = $this->fk_element;
10485 $line->$keyforparent = $this->id;
10486
10487 // Test and convert into object this->lines[$i]. When coming from REST API, we may still have an array
10488 //if (! is_object($line)) $line=json_decode(json_encode($line), false); // convert recursively array into object.
10489 if (!is_object($line)) {
10490 $line = (object) $line;
10491 }
10492
10493 $result = 0;
10494 if (method_exists($line, 'insert')) {
10495 $result = $line->insert($user, 1);
10496 } elseif (method_exists($line, 'create')) {
10497 $result = $line->create($user, 1);
10498 }
10499 if ($result < 0) {
10500 $this->error = $line->error;
10501 $this->db->rollback();
10502 return -1;
10503 }
10504 }
10505 }
10506
10507 // Triggers
10508 if (!$error && !$notrigger) {
10509 // Call triggers
10510 $result = $this->call_trigger(strtoupper(get_class($this)).'_CREATE', $user);
10511 if ($result < 0) {
10512 $error++;
10513 }
10514 // End call triggers
10515 }
10516
10517 // Commit or rollback
10518 if ($error) {
10519 $this->db->rollback();
10520 return -1;
10521 } else {
10522 $this->db->commit();
10523 return $this->id;
10524 }
10525 }
10526
10527
10537 public function fetchCommon($id, $ref = null, $morewhere = '', $noextrafields = 0)
10538 {
10539 if (empty($id) && empty($ref) && empty($morewhere)) {
10540 return -1;
10541 }
10542
10543 $fieldlist = $this->getFieldList('t');
10544 if (empty($fieldlist)) {
10545 return 0;
10546 }
10547
10548 $sql = "SELECT ".$fieldlist;
10549 $sql .= " FROM ".$this->db->prefix().$this->table_element.' as t';
10550
10551 if (!empty($id)) {
10552 $sql .= ' WHERE t.rowid = '.((int) $id);
10553 } elseif (!empty($ref)) {
10554 $sql .= " WHERE t.ref = '".$this->db->escape($ref)."'";
10555 } else {
10556 $sql .= ' WHERE 1 = 1'; // usage with empty id and empty ref is very rare
10557 }
10558 if (empty($id) && isset($this->ismultientitymanaged) && $this->ismultientitymanaged == 1) {
10559 $sql .= ' AND t.entity IN ('.getEntity($this->element).')';
10560 }
10561 if ($morewhere) {
10562 $sql .= $morewhere;
10563 }
10564 $sql .= ' LIMIT 1'; // This is a fetch, to be certain to get only one record
10565
10566 $res = $this->db->query($sql);
10567 if ($res) {
10568 $obj = $this->db->fetch_object($res);
10569 if ($obj) {
10570 $this->setVarsFromFetchObj($obj);
10571
10572 // Retrieve all extrafield
10573 // fetch optionals attributes and labels
10574 if (empty($noextrafields)) {
10575 $result = $this->fetch_optionals();
10576 if ($result < 0) {
10577 $this->error = $this->db->lasterror();
10578 $this->errors[] = $this->error;
10579 return -4;
10580 }
10581 }
10582
10583 return $this->id;
10584 } else {
10585 return 0;
10586 }
10587 } else {
10588 $this->error = $this->db->lasterror();
10589 $this->errors[] = $this->error;
10590 return -1;
10591 }
10592 }
10593
10601 public function fetchLinesCommon($morewhere = '', $noextrafields = 0)
10602 {
10603 $objectlineclassname = get_class($this).'Line';
10604 if (!class_exists($objectlineclassname)) {
10605 $this->error = 'Error, class '.$objectlineclassname.' not found during call of fetchLinesCommon';
10606 return -1;
10607 }
10608
10609 $objectline = new $objectlineclassname($this->db);
10610 '@phan-var-force CommonObjectLine $objectline';
10611
10612 $sql = "SELECT ".$objectline->getFieldList('l');
10613 $sql .= " FROM ".$this->db->prefix().$objectline->table_element." as l";
10614 $sql .= " WHERE l.fk_".$this->db->escape($this->element)." = ".((int) $this->id);
10615 if ($morewhere) {
10616 $sql .= $morewhere;
10617 }
10618 if (isset($objectline->fields['position'])) {
10619 $sql .= $this->db->order('position', 'ASC');
10620 }
10621
10622 $resql = $this->db->query($sql);
10623 if ($resql) {
10624 $num_rows = $this->db->num_rows($resql);
10625 $i = 0;
10626 $this->lines = array();
10627 while ($i < $num_rows) {
10628 $obj = $this->db->fetch_object($resql);
10629 if ($obj) {
10630 $newline = new $objectlineclassname($this->db);
10631 '@phan-var-force CommonObjectLine $newline';
10632 $newline->setVarsFromFetchObj($obj);
10633
10634 // Note: extrafields load of line not yet supported
10635 /*
10636 if (empty($noextrafields)) {
10637 // Load extrafields of line
10638 }*/
10639
10640 $this->lines[] = $newline;
10641 }
10642 $i++;
10643 }
10644
10645 return 1;
10646 } else {
10647 $this->error = $this->db->lasterror();
10648 $this->errors[] = $this->error;
10649 return -1;
10650 }
10651 }
10652
10660 public function updateCommon(User $user, $notrigger = 0)
10661 {
10662 dol_syslog(get_class($this)."::updateCommon update", LOG_DEBUG);
10663
10664 $error = 0;
10665
10666 $now = dol_now();
10667
10668 // $this->oldcopy should have been set by the caller of update
10669 //if (empty($this->oldcopy)) {
10670 // dol_syslog("this->oldcopy should have been set by the caller of update (here properties were already modified)", LOG_WARNING);
10671 // $this->oldcopy = dol_clone($this, 2);
10672 //}
10673
10674 $fieldvalues = $this->setSaveQuery();
10675
10676 // Note: Here, $fieldvalues contains same keys (or less) that are inside ->fields
10677
10678 if (array_key_exists('date_modification', $fieldvalues) && empty($fieldvalues['date_modification'])) {
10679 $fieldvalues['date_modification'] = $this->db->idate($now);
10680 }
10681 if (array_key_exists('fk_user_modif', $fieldvalues) && !($fieldvalues['fk_user_modif'] > 0)) {
10682 $fieldvalues['fk_user_modif'] = $user->id;
10683 }
10684 if (array_key_exists('user_modification_id', $fieldvalues) && !($fieldvalues['user_modification_id'] > 0)) {
10685 $fieldvalues['user_modification_id'] = $user->id;
10686 }
10687 if (array_key_exists('pass_crypted', $fieldvalues) && property_exists($this, 'pass') && !empty($this->pass)) {
10688 // @phan-suppress-next-line PhanUndeclaredProperty
10689 $tmparray = dol_hash($this->pass, '0', 0, 1);
10690 $fieldvalues['pass_crypted'] = $tmparray['pass_encrypted'];
10691 if (array_key_exists('pass_encoding', $fieldvalues) && property_exists($this, 'pass_encoding')) {
10692 $fieldvalues['pass_encoding'] = $tmparray['pass_encoding'];
10693 }
10694 }
10695 if (array_key_exists('ref', $fieldvalues)) {
10696 $fieldvalues['ref'] = dol_string_nospecial($fieldvalues['ref']); // If field is a ref, we sanitize data
10697 }
10698
10699 unset($fieldvalues['rowid']); // The field 'rowid' is reserved field name for autoincrement field so we don't need it into update.
10700
10701 // Add quotes and escape on fields with type string
10702 $keys = array();
10703 $values = array();
10704 $tmp = array();
10705 foreach ($fieldvalues as $k => $v) {
10706 $keys[$k] = $k;
10707 $value = $this->fields[$k];
10708 // @phan-suppress-next-line PhanPluginSuspiciousParamPosition
10709 $values[$k] = $this->quote($v, $value);
10710 if (($value["type"] == "text") && !empty($value['arrayofkeyval']) && is_array($value['arrayofkeyval'])) {
10711 // Clean values for text with selectbox
10712 $v = preg_replace('/\s/', ',', $v);
10713 $v = preg_replace('/,+/', ',', $v);
10714 }
10715 // @phan-suppress-next-line PhanPluginSuspiciousParamPosition
10716 $tmp[] = $k.'='.$this->quote($v, $this->fields[$k]);
10717 }
10718
10719 // Clean and check mandatory fields
10720 foreach ($keys as $key) {
10721 if (preg_match('/^integer:/i', $this->fields[$key]['type']) && $values[$key] == '-1') {
10722 $values[$key] = ''; // This is an implicit foreign key field
10723 }
10724 if (!empty($this->fields[$key]['foreignkey']) && $values[$key] == '-1') {
10725 $values[$key] = ''; // This is an explicit foreign key field
10726 }
10727
10728 //var_dump($key.'-'.$values[$key].'-'.($this->fields[$key]['notnull'] == 1));
10729 /*
10730 if ($this->fields[$key]['notnull'] == 1 && empty($values[$key]))
10731 {
10732 $error++;
10733 $this->errors[]=$langs->trans("ErrorFieldRequired", $this->fields[$key]['label']);
10734 }*/
10735 }
10736
10737 $sql = 'UPDATE '.$this->db->prefix().$this->table_element.' SET '.implode(', ', $tmp).' WHERE rowid='.((int) $this->id);
10738
10739 $this->db->begin();
10740
10741 if (!$error) {
10742 $res = $this->db->query($sql);
10743 if (!$res) {
10744 $error++;
10745 $this->errors[] = $this->db->lasterror();
10746 }
10747 }
10748
10749 // Update extrafield
10750 if (!$error) {
10751 $result = $this->insertExtraFields(); // This delete and reinsert extrafields
10752 if ($result < 0) {
10753 $error++;
10754 }
10755 }
10756
10757 // Triggers
10758 if (!$error && !$notrigger) {
10759 // Call triggers
10760 $result = $this->call_trigger(strtoupper(get_class($this)).'_MODIFY', $user);
10761 if ($result < 0) {
10762 $error++;
10763 } //Do also here what you must do to rollback action if trigger fail
10764 // End call triggers
10765 }
10766
10767 // Commit or rollback
10768 if ($error) {
10769 $this->db->rollback();
10770 return -1;
10771 } else {
10772 $this->db->commit();
10773 return $this->id;
10774 }
10775 }
10776
10785 public function deleteCommon(User $user, $notrigger = 0, $forcechilddeletion = 0)
10786 {
10787 dol_syslog(get_class($this)."::deleteCommon delete", LOG_DEBUG);
10788
10789 $error = 0;
10790
10791 $this->db->begin();
10792
10793 if ($forcechilddeletion) { // Force also delete of childtables that should lock deletion in standard case when option force is off
10794 foreach ($this->childtables as $table) {
10795 $sql = "DELETE FROM ".$this->db->prefix().$table." WHERE ".$this->fk_element." = ".((int) $this->id);
10796 $resql = $this->db->query($sql);
10797 if (!$resql) {
10798 $this->error = $this->db->lasterror();
10799 $this->errors[] = $this->error;
10800 $this->db->rollback();
10801 return -1;
10802 }
10803 }
10804 } elseif (!empty($this->childtables)) { // If object has children linked with a foreign key field, we check all child tables.
10805 $objectisused = $this->isObjectUsed($this->id);
10806 if (!empty($objectisused)) {
10807 dol_syslog(get_class($this)."::deleteCommon Can't delete record as it has some child", LOG_WARNING);
10808 $this->error = 'ErrorRecordHasChildren';
10809 $this->errors[] = $this->error;
10810 $this->db->rollback();
10811 return 0;
10812 }
10813 }
10814
10815 // Delete cascade first
10816 if (is_array($this->childtablesoncascade) && !empty($this->childtablesoncascade)) {
10817 foreach ($this->childtablesoncascade as $tabletodelete) {
10818 $deleteFromObject = explode(':', $tabletodelete, 4);
10819 if (count($deleteFromObject) >= 2) {
10820 $className = str_replace('@', '', $deleteFromObject[0]);
10821 $filePath = $deleteFromObject[1];
10822 $columnName = $deleteFromObject[2];
10823 $filter = '';
10824 if (!empty($deleteFromObject[3])) {
10825 $filter = $deleteFromObject[3];
10826 }
10827 if (dol_include_once($filePath)) {
10828 $childObject = new $className($this->db);
10829 if (method_exists($childObject, 'deleteByParentField')) {
10830 '@phan-var-force CommonObject $childObject';
10831 $result = $childObject->deleteByParentField($this->id, $columnName, $filter);
10832 if ($result < 0) {
10833 $error++;
10834 $this->errors[] = $childObject->error;
10835 break;
10836 }
10837 } else {
10838 $error++;
10839 $this->errors[] = "You defined a cascade delete on an object $className/$this->id but there is no method deleteByParentField for it";
10840 break;
10841 }
10842 } else {
10843 $error++;
10844 $this->errors[] = 'Cannot include child class file '.$filePath;
10845 break;
10846 }
10847 } else {
10848 // Delete record in child table
10849 $sql = "DELETE FROM ".$this->db->prefix().$tabletodelete." WHERE ".$this->fk_element." = ".((int) $this->id);
10850
10851 $resql = $this->db->query($sql);
10852 if (!$resql) {
10853 $error++;
10854 $this->error = $this->db->lasterror();
10855 $this->errors[] = $this->error;
10856 break;
10857 }
10858 }
10859 }
10860 }
10861
10862 if (!$error) {
10863 if (!$notrigger) {
10864 // Call triggers
10865 $result = $this->call_trigger(strtoupper(get_class($this)).'_DELETE', $user);
10866 if ($result < 0) {
10867 $error++;
10868 } // Do also here what you must do to rollback action if trigger fail
10869 // End call triggers
10870 }
10871 }
10872
10873 // Delete llx_ecm_files
10874 if (!$error) {
10875 $res = $this->deleteEcmFiles(1); // Deleting files physically is done later with the dol_delete_dir_recursive
10876 if (!$res) {
10877 $error++;
10878 }
10879 }
10880
10881 // Delete linked object
10882 $res = $this->deleteObjectLinked();
10883 if ($res < 0) {
10884 $error++;
10885 }
10886
10887 if (!$error && !empty($this->isextrafieldmanaged)) {
10888 $result = $this->deleteExtraFields();
10889 if ($result < 0) {
10890 $error++;
10891 }
10892 }
10893
10894 if (!$error) {
10895 $sql = 'DELETE FROM '.$this->db->prefix().$this->table_element.' WHERE rowid='.((int) $this->id);
10896
10897 $resql = $this->db->query($sql);
10898 if (!$resql) {
10899 $error++;
10900 $this->errors[] = $this->db->lasterror();
10901 }
10902 }
10903
10904 // Commit or rollback
10905 if ($error) {
10906 $this->db->rollback();
10907 return -1;
10908 } else {
10909 $this->db->commit();
10910 return 1;
10911 }
10912 }
10913
10925 public function deleteByParentField($parentId = 0, $parentField = '', $filter = '', $filtermode = "AND")
10926 {
10927 global $user;
10928
10929 $error = 0;
10930 $deleted = 0;
10931
10932 if (!empty($parentId) && !empty($parentField)) {
10933 $this->db->begin();
10934
10935 $sql = "SELECT rowid FROM ".$this->db->prefix().$this->table_element;
10936 $sql .= " WHERE ".$this->db->sanitize($parentField)." = ".(int) $parentId;
10937
10938 // Manage filter
10939 $errormessage = '';
10940 $sql .= forgeSQLFromUniversalSearchCriteria($filter, $errormessage);
10941 if ($errormessage) {
10942 $this->errors[] = $errormessage;
10943 dol_syslog(__METHOD__.' '.implode(',', $this->errors), LOG_ERR);
10944 return -1;
10945 }
10946
10947 $resql = $this->db->query($sql);
10948 if (!$resql) {
10949 $this->errors[] = $this->db->lasterror();
10950 $error++;
10951 } else {
10952 while ($obj = $this->db->fetch_object($resql)) {
10953 $result = $this->fetch($obj->rowid); // @phpstan-ignore-line
10954 if ($result < 0) {
10955 $error++;
10956 $this->errors[] = $this->error;
10957 } else {
10958 $result = $this->delete($user); // @phpstan-ignore-line
10959 if ($result < 0) {
10960 $error++;
10961 $this->errors[] = $this->error;
10962 } else {
10963 $deleted++;
10964 }
10965 }
10966 }
10967 }
10968
10969 if (empty($error)) {
10970 $this->db->commit();
10971 return $deleted;
10972 } else {
10973 $this->error = implode(', ', $this->errors);
10974 $this->db->rollback();
10975 return $error * -1;
10976 }
10977 }
10978
10979 return $deleted;
10980 }
10981
10990 public function deleteLineCommon(User $user, $idline, $notrigger = 0)
10991 {
10992 $error = 0;
10993
10994 $tmpforobjectclass = get_class($this);
10995 $tmpforobjectlineclass = ucfirst($tmpforobjectclass).'Line';
10996
10997 $this->db->begin();
10998
10999 // Call trigger
11000 $result = $this->call_trigger('LINE'.strtoupper($tmpforobjectclass).'_DELETE', $user);
11001 if ($result < 0) {
11002 $error++;
11003 }
11004 // End call triggers
11005
11006 if (empty($error)) {
11007 $sql = "DELETE FROM ".$this->db->prefix().$this->table_element_line;
11008 $sql .= " WHERE rowid = ".((int) $idline);
11009
11010 $resql = $this->db->query($sql);
11011 if (!$resql) {
11012 $this->error = "Error ".$this->db->lasterror();
11013 $error++;
11014 }
11015 }
11016
11017 if (empty($error)) {
11018 // Remove extrafields
11019 $tmpobjectline = new $tmpforobjectlineclass($this->db);
11020 '@phan-var-force CommonObjectLine $tmpobjectline';
11021 if (!isset($tmpobjectline->isextrafieldmanaged) || !empty($tmpobjectline->isextrafieldmanaged)) {
11022 $tmpobjectline->id = $idline;
11023 $result = $tmpobjectline->deleteExtraFields();
11024 if ($result < 0) {
11025 $error++;
11026 $this->error = "Error ".get_class($this)."::deleteLineCommon deleteExtraFields error -4 ".$tmpobjectline->error;
11027 }
11028 }
11029 }
11030
11031 if (empty($error)) {
11032 $this->db->commit();
11033 return 1;
11034 } else {
11035 dol_syslog(get_class($this)."::deleteLineCommon ERROR:".$this->error, LOG_ERR);
11036 $this->db->rollback();
11037 return -1;
11038 }
11039 }
11040
11041
11051 public function setStatusCommon($user, $status, $notrigger = 0, $triggercode = '')
11052 {
11053 $error = 0;
11054
11055 $this->db->begin();
11056
11057 $statusfield = 'status';
11058 if (in_array($this->element, array('don', 'donation', 'shipping'))) {
11059 $statusfield = 'fk_statut';
11060 }
11061
11062 $sql = "UPDATE ".$this->db->prefix().$this->table_element;
11063 $sql .= " SET ".$statusfield." = ".((int) $status);
11064 $sql .= " WHERE rowid = ".((int) $this->id);
11065
11066 if ($this->db->query($sql)) {
11067 if (!$error) {
11068 $this->oldcopy = clone $this;
11069 }
11070
11071 if (!$error && !$notrigger) {
11072 // Call trigger
11073 $result = $this->call_trigger($triggercode, $user);
11074 if ($result < 0) {
11075 $error++;
11076 }
11077 }
11078
11079 if (!$error) {
11080 $this->status = $status;
11081 if (property_exists($this, 'statut')) { // For backward compatibility
11082 $this->statut = $status;
11083 }
11084 $this->db->commit();
11085 return 1;
11086 } else {
11087 $this->db->rollback();
11088 return -1;
11089 }
11090 } else {
11091 $this->error = $this->db->error();
11092 $this->db->rollback();
11093 return -1;
11094 }
11095 }
11096
11103 public function initAsSpecimenCommon()
11104 {
11105 global $user;
11106
11107 $this->id = 0;
11108 $this->specimen = 1;
11109 $fields = array(
11110 'label' => 'This is label',
11111 'ref' => 'ABCD1234',
11112 'description' => 'This is a description',
11113 'qty' => 123.12,
11114 'note_public' => 'Public note',
11115 'note_private' => 'Private note',
11116 'date_creation' => (dol_now() - 3600 * 48),
11117 'date_modification' => (dol_now() - 3600 * 24),
11118 'fk_user_creat' => $user->id,
11119 'fk_user_modif' => $user->id,
11120 'date' => dol_now(),
11121 );
11122 foreach ($fields as $key => $value) {
11123 if (array_key_exists($key, $this->fields)) {
11124 $this->{$key} = $value; // @phpstan-ignore-line
11125 }
11126 }
11127
11128 // Force values to default values when known
11129 if (property_exists($this, 'fields')) {
11130 foreach ($this->fields as $key => $value) {
11131 // If fields are already set, do nothing
11132 if (array_key_exists($key, $fields)) {
11133 continue;
11134 }
11135
11136 if (!empty($value['default'])) {
11137 $this->$key = $value['default'];
11138 }
11139 }
11140 }
11141
11142 return 1;
11143 }
11144
11145
11146 /* Part for comments */
11147
11153 public function fetchComments()
11154 {
11155 require_once DOL_DOCUMENT_ROOT.'/core/class/comment.class.php';
11156
11157 $comment = new Comment($this->db);
11158 $result = $comment->fetchAllFor($this->element, $this->id);
11159 if ($result < 0) {
11160 $this->errors = array_merge($this->errors, $comment->errors);
11161 return -1;
11162 } else {
11163 $this->comments = $comment->comments;
11164 }
11165 return count($this->comments);
11166 }
11167
11173 public function getNbComments()
11174 {
11175 return count($this->comments);
11176 }
11177
11184 public function trimParameters($parameters)
11185 {
11186 if (!is_array($parameters)) {
11187 return;
11188 }
11189 foreach ($parameters as $parameter) {
11190 if (isset($this->$parameter)) {
11191 $this->$parameter = trim($this->$parameter);
11192 }
11193 }
11194 }
11195
11196 /* Part for categories/tags */
11197
11208 public function getCategoriesCommon($type_categ)
11209 {
11210 require_once DOL_DOCUMENT_ROOT.'/categories/class/categorie.class.php';
11211
11212 // Get current categories
11213 $c = new Categorie($this->db);
11214 $existing = $c->containing($this->id, $type_categ, 'id');
11215
11216 return $existing;
11217 }
11218
11231 public function setCategoriesCommon($categories, $type_categ = '', $remove_existing = true)
11232 {
11233 // Handle single category
11234 if (!is_array($categories)) {
11235 $categories = array($categories);
11236 }
11237
11238 dol_syslog(get_class($this)."::setCategoriesCommon Object Id:".$this->id.' type_categ:'.$type_categ.' nb tag add:'.count($categories), LOG_DEBUG);
11239
11240 require_once DOL_DOCUMENT_ROOT.'/categories/class/categorie.class.php';
11241
11242 if (empty($type_categ)) {
11243 dol_syslog(__METHOD__.': Type '.$type_categ.'is an unknown category type. Done nothing.', LOG_ERR);
11244 return -1;
11245 }
11246
11247 // Get current categories
11248 $c = new Categorie($this->db);
11249 $existing = $c->containing($this->id, $type_categ, 'id');
11250 if ($remove_existing) {
11251 // Diff
11252 if (is_array($existing)) {
11253 $to_del = array_diff($existing, $categories);
11254 $to_add = array_diff($categories, $existing);
11255 } else {
11256 $to_del = array(); // Nothing to delete
11257 $to_add = $categories;
11258 }
11259 } else {
11260 $to_del = array(); // Nothing to delete
11261 $to_add = array_diff($categories, $existing);
11262 }
11263
11264 $error = 0;
11265 $ok = 0;
11266
11267 // Process
11268 foreach ($to_del as $del) {
11269 if ($c->fetch($del) > 0) {
11270 $result = $c->del_type($this, $type_categ);
11271 if ($result < 0) {
11272 $error++;
11273 $this->error = $c->error;
11274 $this->errors = $c->errors;
11275 break;
11276 } else {
11277 $ok += $result;
11278 }
11279 }
11280 }
11281 foreach ($to_add as $add) {
11282 if ($c->fetch($add) > 0) {
11283 $result = $c->add_type($this, $type_categ);
11284 if ($result < 0) {
11285 $error++;
11286 $this->error = $c->error;
11287 $this->errors = $c->errors;
11288 break;
11289 } else {
11290 $ok += $result;
11291 }
11292 }
11293 }
11294
11295 return $error ? (-1 * $error) : $ok;
11296 }
11297
11306 public function cloneCategories($fromId, $toId, $type = '')
11307 {
11308 $this->db->begin();
11309
11310 if (empty($type)) {
11311 $type = $this->table_element;
11312 }
11313
11314 require_once DOL_DOCUMENT_ROOT.'/categories/class/categorie.class.php';
11315 $categorystatic = new Categorie($this->db);
11316
11317 $sql = "INSERT INTO ".$this->db->prefix()."categorie_".(empty($categorystatic->MAP_CAT_TABLE[$type]) ? $type : $categorystatic->MAP_CAT_TABLE[$type])." (fk_categorie, fk_product)";
11318 $sql .= " SELECT fk_categorie, $toId FROM ".$this->db->prefix()."categorie_".(empty($categorystatic->MAP_CAT_TABLE[$type]) ? $type : $categorystatic->MAP_CAT_TABLE[$type]);
11319 $sql .= " WHERE fk_product = ".((int) $fromId);
11320
11321 if (!$this->db->query($sql)) {
11322 $this->error = $this->db->lasterror();
11323 $this->db->rollback();
11324 return -1;
11325 }
11326
11327 $this->db->commit();
11328 return 1;
11329 }
11330
11337 public function deleteEcmFiles($mode = 0)
11338 {
11339 global $conf;
11340
11341 $this->db->begin();
11342
11343 // Delete in database with mode 0
11344 if ($mode == 0) {
11345 switch ($this->element) {
11346 case 'propal':
11347 $element = 'propale';
11348 break;
11349 case 'product':
11350 $element = 'produit';
11351 break;
11352 case 'order_supplier':
11353 $element = 'fournisseur/commande';
11354 break;
11355 case 'invoice_supplier':
11356 // Special cases that need to use get_exdir to get real dir of object
11357 // In future, all object should use this to define path of documents.
11358 $element = 'fournisseur/facture/'.get_exdir($this->id, 2, 0, 1, $this, 'invoice_supplier');
11359 break;
11360 case 'shipping':
11361 $element = 'expedition/sending';
11362 break;
11363 case 'task':
11364 case 'project_task':
11365 require_once DOL_DOCUMENT_ROOT.'/projet/class/task.class.php';
11366
11367 $project_result = $this->fetchProject();
11368 if ($project_result >= 0) {
11369 $element = 'projet/'.dol_sanitizeFileName($this->project->ref).'/';
11370 }
11371 // no break
11372 default:
11373 $element = $this->element;
11374 }
11375 '@phan-var-force string $element';
11376
11377 // Delete ecm_files_extrafields with mode 0 (using name)
11378 $sql = "DELETE FROM ".$this->db->prefix()."ecm_files_extrafields WHERE fk_object IN (";
11379 $sql .= " SELECT rowid FROM ".$this->db->prefix()."ecm_files WHERE filename LIKE '".$this->db->escape($this->ref)."%'";
11380 $sql .= " AND filepath = '".$this->db->escape($element)."/".$this->db->escape($this->ref)."' AND entity = ".((int) $conf->entity); // No need of getEntity here
11381 $sql .= ")";
11382
11383 if (!$this->db->query($sql)) {
11384 $this->error = $this->db->lasterror();
11385 $this->db->rollback();
11386 return false;
11387 }
11388
11389 // Delete ecm_files with mode 0 (using name)
11390 $sql = "DELETE FROM ".$this->db->prefix()."ecm_files";
11391 $sql .= " WHERE filename LIKE '".$this->db->escape($this->ref)."%'";
11392 $sql .= " AND filepath = '".$this->db->escape($element)."/".$this->db->escape($this->ref)."' AND entity = ".((int) $conf->entity); // No need of getEntity here
11393
11394 if (!$this->db->query($sql)) {
11395 $this->error = $this->db->lasterror();
11396 $this->db->rollback();
11397 return false;
11398 }
11399 }
11400
11401 // Delete in database with mode 1
11402 if ($mode == 1) {
11403 $sql = 'DELETE FROM '.$this->db->prefix()."ecm_files_extrafields";
11404 $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).")";
11405 $resql = $this->db->query($sql);
11406 if (!$resql) {
11407 $this->error = $this->db->lasterror();
11408 $this->db->rollback();
11409 return false;
11410 }
11411
11412 $sql = 'DELETE FROM '.$this->db->prefix()."ecm_files";
11413 $sql .= " WHERE src_object_type = '".$this->db->escape($this->table_element.(empty($this->module) ? "" : "@".$this->module))."' AND src_object_id = ".((int) $this->id);
11414 $resql = $this->db->query($sql);
11415 if (!$resql) {
11416 $this->error = $this->db->lasterror();
11417 $this->db->rollback();
11418 return false;
11419 }
11420 }
11421
11422 $this->db->commit();
11423 return true;
11424 }
11425}
$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
$c
Definition line.php:327
$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.
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.
addThumbs($file, $quality=50)
Build thumb.
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.
completeFileArrayWithDatabaseInfo(&$filearray, $relativedir, $object=null)
Complete $filearray with data from database.
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
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...
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.
img_picto($titlealt, $picto, $moreatt='', $pictoisfullpath=0, $srconly=0, $notitle=0, $alt='', $morecss='', $marginleftonlyshort=2, $allowothertags=array())
Show picto whatever it's its name (generic function)
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.
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 '.
getCallerInfoString()
Get caller info as a string that can be appended to a log message.
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.
img_object($titlealt, $picto, $moreatt='', $pictoisfullpath=0, $srconly=0, $notitle=0, $allowothertags=array())
Show a picto called object_picto (generic function)
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'.
dolPrintHTMLForAttribute($s, $escapeonlyhtmltags=0, $allowothertags=array())
Return a string ready to be output into an HTML attribute (alt, title, data-html, ....
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_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...
dol_sanitizeFileName($str, $newstr='_', $unaccent=1, $includequotes=0)
Clean a string to use it as a file name.
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:154
if(preg_match('/crypted:/i', $dolibarr_main_db_pass)||!empty($dolibarr_main_db_encrypted_pass)) $conf db type
Definition repair.php:150
getRandomPassword($generic=false, $replaceambiguouschars=null, $length=32)
Return a generated password using default module.
dol_hash($chain, $type='0', $nosalt=0, $mode=0)
Returns a hash (non reversible encryption) of a string.
dolEncrypt($chain, $key='', $ciphering='', $forceseed='')
Encode a string with a symmetric encryption.
dolDecrypt($chain, $key='')
Decode a string with a symmetric encryption.