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